HTTP response codes in the 4xx range indicate an error that resulted from the request data. HTTP response codes in the 5xx range indicate an error with our servers.
When an error occurs, a JSON object will be returned with the error type and associated message as attributes.
Example Error Response
HTTP/1.1 401 Unauthorized { "type": "authentication_error", "message": "Authentication credentials not provided" }
Error Object Attributes
When an error occurs, the API will return an error object in JSON format.
Field |
Description |
type |
The type of error returned. |
message |
A human-readable description of the error. |
Error Types
The following error types may be returned by the API. Inspect the message attribute for more information.
Response Code |
Type |
Description |
400 |
invalid_request_error |
Request has invalid parameters or is otherwise malformed. |
401 |
authentication_error |
App ID / API Key combination was not authorized or credentials were not provided. |
403 |
forbidden_error |
Access to the requested resource is forbidden. |
404 |
not_found |
API endpoint is invalid; the requested resource was not found. |
405 |
not_allowed |
Only the documented request methods may be used. |
429 |
too_many_requests |
App ID has made too many requests. |
500 |
server_error |
Something went wrong on our end. |