Response Codes
HTTP Status Codes
The API attempts to return appropriate HTTP status codes for every request, which are documented with each endpoint below.
Trying to access resources that you do not have access to will result in a 404 Not Found
response, in order to avoid disclosing the existence of user data.
Error Messages
When the API returns error messages describing a problem with a request, it does so using the following format:
API Error Codes
In some cases, to help identify particular categories of API errors, the API will return a code number in addition to an error message:
The API error codes currently in use include:
Code | Description | Remedy |
---|---|---|
30000 | API access restricted due to lapsed payment | Update your billing information in the organisation settings in your dashboard. |
31000 | API access restricted due to expired trial or invalid subscription | Select a plan in the organisation settings in your dashboard. |
32000 | API access restricted for this user due to lack of available seats | Select a plan with more seats. |
40000 | Insufficient Project Role for performing requested action | Project Owner or Organization Administrator access level is required. |
60000 | The number of sorted results has been limited | Set the sort parameter to unsorted on this request to obtain complete results or add additional filters to reduce the number of results. |