Quick Start Guide

API Basics

API Resources

API: Companies

Every Partner account starts with one Company account. The purpose of the Company account is to provide billing access for your Partner account and to group any Devices you create (e.g. Emergency Plan).

  • Partners have access to all Company accounts 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
CompanyId Integer Read Only
PartnerId Integer Required on POST, otherwise Read Only
Partner Object See API Partners
PlanTypeId Integer Required on POST, otherwise Read Only
Plan Type Object See API Plan Types
Name String 100 Required
AddressLine1 String 50
AddressLine2 String 50
CityMunicipality String 50
StateProvidence String 50
PostalCode String 50
Country String 50
Phone String 50
ExternalId String 100 Unique identifier for Partners to identify this Company.
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 Companies in descending order.

URL
https://cleverfoxbackup.com/api/companies
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": [
    {
        "CompanyId": 1,
        "PartnerId": 1,
        "Partner": {
        "PartnerId": 1,
        "PlanTypeId": 1,
        "PlanType": null,
        "Name": "Forward Thinking Software, LLC",
        "ApplicationId": null,
        "IsInactive": false,
        "AddedOn": "2015-01-01T00:00:00.000",
        "UpdatedOn": null,
        "Token": null
        },
        "PlanTypeId": 1,
        "PlanType": {
        "PlanTypeId": 1,
        "Name": "CleverFox Backup",
        "IsInactive": false
        },
        "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
    }
    ],
    "page_no": 1,
    "page_size": 25
}

Read (GET)

Returns a single Company.

URL
https://cleverfoxbackup.com/api/companies/{CompanyId}
Required Parameters
  • CompanyId
Response Codes
  • 200 OK
  • 404 Not Found
Sample JSON 
{
  "data": {
    "CompanyId": 1,
    "PartnerId": 1,
    "Partner": {
      "PartnerId": 1,
      "PlanTypeId": 1,
      "PlanType": null,
      "Name": "Forward Thinking Software, LLC",
      "ApplicationId": null,
      "IsInactive": false,
      "AddedOn": "2015-01-01T00:00:00.000",
      "UpdatedOn": null,
      "Token": null
    },
    "PlanTypeId": 1,
    "PlanType": {
      "PlanTypeId": 1,
      "Name": "CleverFox Backup",
      "IsInactive": false
    },
    "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
  }
}

Lookup (GET)

Returns a single Company.

URL
https://cleverfoxbackup.com/api/companies/lookup?ExternalId={ExternalId}
Required Parameters
  • ExternalId
Response Codes
  • 200 OK
  • 404 Not Found
Sample JSON 
{
  "data": {
    "CompanyId": 1,
    "PartnerId": 1,
    "Partner": {
      "PartnerId": 1,
      "PlanTypeId": 1,
      "PlanType": null,
      "Name": "Forward Thinking Software, LLC",
      "ApplicationId": null,
      "IsInactive": false,
      "AddedOn": "2015-01-01T00:00:00.000",
      "UpdatedOn": null,
      "Token": null
    },
    "PlanTypeId": 1,
    "PlanType": {
      "PlanTypeId": 1,
      "Name": "CleverFox Backup",
      "IsInactive": false
    },
    "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
  }
}

Create (POST)


Update (PUT)

Updates a Company and returns the updated data.

URL
https://cleverfoxbackup.com/api/companies/{CompanyId}
Required Parameters
  • CompanyId
Response Codes
  • 200 OK
  • 404 Not Found
  • 409 Conflict
Sample JSON 
{
  "data": {
    "Name": "ABC Company, Inc.",
    "AddressLine1": "1000 Main St",
    "AddressLine2": null,
    "CityMunicipality": "Anytown",
    "StateProvidence": "MI",
    "PostalCode": "12345",
    "Country": null,
    "Phone": null,
    "ExternalId": null,
    "IsInactive": false,
    "Token": null
  }
}

Delete (DELETE)