The API responds to HTTP calls using the standard RESTful syntax: GET, PUT, POST and DELETE.

Each endpoint has a different URL, however the base URL for all requests is All responses are in JSON format.



If you see :variableName in a URL this means there's a required variable you need to insert at this point.


All requests require an API key to be present, and it must be specified in the HTTP header of the request. You can find your API key under the API tab on the Account page in

API keys are issued per-user, therefore all features available via this API are limited to what the user has available on the product.

Permissions can be changed from the Security tab in, to enable more features.

      type: 'GET',
      url: '',
      headers: {
        'apiKey': '6120fce4-376c-4602-ad3e-e3e7480ec13d'
}).done(function(data) {
$context = stream_context_create(array(
    'header'=>"apiKey: 6120fce4-376c-4602-ad3e-e3e7480ec13d")
$data = file_get_contents('', false, $context);

Error Codes

When everything goes right we'll send you a 200 response code, if something goes wrong we'll return one of the following:

400This indicates a validation error. It is most likely that your request parameters are incorrect, or we can't find the data you're trying to access. For example, an incorrect resource Id is specified.
401Indicates unauthorized access. You may be using an API key that is incorrect or disabled.
409Usage limit reached. You may only perform each action every 2 seconds.
500This is a general error. It is most likely that some invalid data has been sent, but an exception is not caught on our end. In the response body we will provide a logId; please send this to support at [email protected] so that we can provide you with more information.
550This code indicates that you do not have permission to access the resource. Most likely your API is disabled. If you don't know how to reactivate your API please contact [email protected] for help