Quick Start Guide

API Basics

API Resources

API: Company Users

Company Users are the people within a Company account that need access to the CleverFox Backup website. Company Users have access to all associated devices, jobs, and logs.

  • Only an Account Owner can modify the Company Information, access the Billing Portal, or add/delete Company Users.
  • CleverFox Backup will send an invite email with a special account setup link when a Company User is created.
  • Partners have access to all Company Users associated with any Company account that signed up for CleverFox Backup using a special Partner Plan link.

Attributes

All of the attribute fields are returned from GET (read) operations. Only those attributes not marked as read only may be set via POST (create) or PUT (update) operations.

Name Type Notes
CompanyUserId Integer Read Only
CompanyId Integer Required on POST, otherwise Read Only
Company Object See API Companies
FirstName String 25 Required
LastName String 25 Required
Email String 256 Required
HomePhone String 20
MobilePhone String 20
WorkPhone String 20
IsAccountOwner Boolean Read Only
IsInactive Boolean
AddedOn DateTime UTC Read Only
UpdatedOn DateTime UTC Read Only
Token String 50 See API Duplication Prevention

List (GET)

Returns an array of Company Users in descending order.

URL
https://cleverfoxbackup.com/api/companyusers
Optional Parameters
  • PageNo: the page number to return, defaults to 1.
  • PageSize: the maximum number of records per page, defaults to 25.
Response Codes
  • 200 OK
Sample JSON 
{
  "data": [
    {
      "CompanyUserId": 1,
      "CompanyId": 1,
      "Company": {
        "CompanyId": 1,
        "PartnerId": 1,
        "Partner": null,
        "PlanTypeId": 1,
        "PlanType": null,
        "Name": "ABC Company, Inc.",
        "AddressLine1": "1000 Main St",
        "AddressLine2": null,
        "CityMunicipality": "Anytown",
        "StateProvidence": "MI",
        "PostalCode": "12345",
        "Country": null,
        "Phone": null,
        "ExternalId": null,
        "IsInactive": false,
        "AddedOn": "2015-01-01T00:00:00.000",
        "UpdatedOn": null,
        "Token": null
      },
      "FirstName": "John",
      "LastName": "Smith",
      "Email": "johnsmith@abccompany.com",
      "HomePhone": null,
      "MobilePhone": null,
      "WorkPhone": null,
      "IsAccountOwner": true,
      "IsInactive": false,
      "AddedOn": "2015-01-01T00:00:00.000",
      "UpdatedOn": null,
      "Token": null
    }
  ],
  "page_no": 1,
  "page_size": 25
}

Read (GET)

Returns a single Company User.

URL
https://cleverfoxbackup.com/api/companyusers/{CompanyUserId}
Required Parameters
  • CompanyUserId
Response Codes
  • 200 OK
  • 404 Not Found
Sample JSON 
{
  "data": {
    "CompanyUserId": 1,
    "CompanyId": 1,
    "Company": {
      "CompanyId": 1,
      "PartnerId": 1,
      "Partner": null,
      "PlanTypeId": 1,
      "PlanType": null,
      "Name": "ABC Company, Inc.",
      "AddressLine1": "1000 Main St",
      "AddressLine2": null,
      "CityMunicipality": "Anytown",
      "StateProvidence": "MI",
      "PostalCode": "12345",
      "Country": null,
      "Phone": null,
      "ExternalId": null,
      "IsInactive": false,
      "AddedOn": "2015-01-01T00:00:00.000",
      "UpdatedOn": null,
      "Token": null
    },
    "FirstName": "John",
    "LastName": "Smith",
    "Email": "johnsmith@abccompany.com",
    "HomePhone": null,
    "MobilePhone": null,
    "WorkPhone": null,
    "IsAccountOwner": true,
    "IsInactive": false,
    "AddedOn": "2015-01-01T00:00:00.000",
    "UpdatedOn": null,
    "Token": null
  }
}

Create (POST)

Creates a Company User and returns the updated data.

URL
https://cleverfoxbackup.com/api/companyusers
Response Codes
  • 200 OK
  • 404 Not Found
  • 409 Conflict
Sample JSON 
{
  "data": {
    "CompanyId": 1,
    "FirstName": "John",
    "LastName": "Smith",
    "Email": "johnsmith@abccompany.com",
    "HomePhone": null,
    "MobilePhone": null,
    "WorkPhone": null,
    "IsAccountOwner": true,
    "IsInactive": false,
    "Token": null
  }
}

Update (PUT)

Updates a Company User and returns the updated data.

URL
https://cleverfoxbackup.com/api/companyusers/{CompanyUserId}
Required Parameters
  • CompanyUserId
Response Codes
  • 200 OK
  • 404 Not Found
  • 409 Conflict
Sample JSON 
{
  "data": {
    "FirstName": "John",
    "LastName": "Smith",
    "Email": "johnsmith@abccompany.com",
    "HomePhone": null,
    "MobilePhone": null,
    "WorkPhone": null,
    "IsInactive": false,
    "Token": null
  }
}

Delete (DELETE)

Deletes a Company User.

URL
https://cleverfoxbackup.com/api/companyusers/{CompanyUserId}
Required Parameters
  • CompanyUserId
Response Codes
  • 204 No Content
  • 404 Not Found