Skip to main content
Our API follows a RESTful architecture and uses standard HTTP response codes to indicate the success or failure of a request.

​
HTTP response codes

  • 200: Success The request was successful .
  • 400: Bad Request The request body or parameters are invalid. Check the documentation for the correct request body or parameters.
  • 401: Unauthorized The request was unauthorized. Check your API key has the correct permissions to access the requested resource.
  • 403: Forbidden The request was forbidden. The request is valid but the user does not have permission to access the requested resource.
  • 404: Not Found The request was not found. Check that you have the correct path and method.
  • 429: Too Many Requests The request was rate limited. Please see the rate limits documentation for more information.
  • 500: Internal Server Error The request failed. This is likely an issue with our API. Please contact us if the problem persists.

​
Error response

Errors are returned as JSON objects with the following properties:
​
string
The object type that caused the error. This will always be error.
​
string
A short code for the error. You can view a complete list of error codes and their description on the error codes page.
​
string
A human readable message for the error.
​
string
The parameter that caused the error. This is only present for validation errors. If there are multiple parameters that caused the error, only the first one will be returned.