Errors
The API returns standard HTTP status codes to indicate the success or failure of a request. In general, status codes in the
If you cannot identify and resolve an issue with your API call, you can contact our Support team with the response status and request ID from the error response, and we’ll help you troubleshoot.
2xx range indicate a successful request, status codes in the 4xx range indicate errors caused by an incorrect input (for example, providing incorrect API key), and status codes in the 5xx range indicate an error on our side.HTTP status codes summary
| Status code | Description |
400 Bad Request | The request was not understood. Check if your request is missing a required parameter or contains an invalid query parameter value. |
401 Unauthorized | The provided API key is doesn't provide access to the requested resource. The error can also occur if the API key is malformed or missing. Try copying and pasting your current API key to avoid typos. |
403 Forbidden | The provided API key is valid but doesn't provide permission for the specified resource. |
404 Not Found | The requested resource doesn't exist. Try checking the resource name for typos. |
405 Method Not Allowed | The requested HTTP method is not supported for the specified resource. |
429 Too Many Requests | The rate limit for the API has been exceeded. Try your request again after a few seconds as specified in the Retry-After header. |
5xx Internal Error or Service Unavailable | Something went wrong on our side. Try your request again after a few seconds and use a retry policy. |
Resolving errors
For troubleshooting failed requests, the API provides error messages defined in a consumable format to help you identify and fix the issue.If you cannot identify and resolve an issue with your API call, you can contact our Support team with the response status and request ID from the error response, and we’ll help you troubleshoot.Error object
request_idThe performed request's unique ID.
error_codeThe specific internal code for the type of error. Only useful for finding patterns among error requests.
messageThe error message explaining why the error occurred.
validation_errors[]A list of specific issues that occurred when processing the request.
Show child attributes
{
"request_id": "string",
"error_code": 0,
"message": "string",
"validation_errors": {
"message": "string",
"path": "string",
"line": 0,
"position": 0
}
}