See latest updates on the Change Log.
|Current API Version||
|API end point||
|Response methods||JSON, JSONP|
The standard four REST verbs are used to access our resources:
|GET||Use when requesting an existing resource|
|POST||Use when creating a new resource|
|PUT||Use when updating an existing resource|
|DELETE||Use when deleting a resource|
You can easily get started testing the API using your Development API Token available within your Create account (Account > Developers & API)
Development Tokens won’t be able to be used in a production App however. You will need to create an API App and users will need to generate an Auth Token specifically for that App.
Every request to the API must include your registered App Token in an HTTP Header ‘X-AppToken’. Without this the API assumes that the Auth Token is a Development token.
You can create a new API App from your Create account;
Once you App has been created, you can generate an Auth Token by adding the App to the account’s Connections. Continue reading for more information…
Auth Tokens are linked to a single Create account and API App, and must be sent with every api request as an HTTP Header called ‘X-Token’.
You can generate a new Auth Token from your Create account;
You will now be provided with an Auth Token to be sent along side the App Token.
Requests must be sent with an
Requests and responses can be provided in JSON. Set the HTTP Accept header to specify the response format and the HTTP Content-Type header to specify the request format.
By default, requests returning multiple items are ordered chronologically in descending order.
You can change the direction of sorting as well as which property is being used for sorting using the following parameters;
|Parameter||Possible Values||Default Value|
|sort_property||See the specific model||
API requests that returns multiple items, such as listing orders, will be paginated (default to 25 items per page). In order to alter the number of records returned per page, a client can provide the per_page parameter (limited to 100 items per page).
To get the next page of data, you can provide the
If you are sorting by the ID (which is default) you can optionally paginate using a specific ID by providing the
last_id parameter. This would be the last ID of the previous page, or an ID to offset the request.
** Currently not implemented **
Access to our resources is limited by user permissions. Resources are split into groups, you can request access to a whole group, or individual resources within a group. The minimum required access level is specified for each resource. The access levels are as follows: