Skip to content

This section outlines the different types of errors you may encounter and how to handle them.

HTTP Status Code Summary

Status Meaning Description
200 OK The request was successful. The response body will contain the requested data.
400 Bad Request The request was unacceptable, often due to missing a required parameter or invalid data. Check the response body for specific error details.
401 Unauthorized No valid API key provided. Ensure you're including a valid access token in the Authorization header.
403 Forbidden The API key doesn't have permissions to perform the request. Check that you're using the correct scopes for the operation.
429 Too Many Requests You've exceeded the rate limit. Refer to the Rate Limiting section for handling this error.
500 Internal Server Error An unexpected error occurred on our servers. If this persists, please contact our support team.

Error Response Format

When an error occurs, the API will return a JSON object with the following structure:

{
  "type": "about:blank",
  "title": "A short summary of the problem type",
  "status": "The HTTP status code",
  "detail": "An explanation specific to this occurrence of the problem",
  "instance": "A URI reference that identifies the specific occurrence of the problem.",
  "properties": {
    "errors": [
     An optional array with specific validation errors or other detailed messages.
    ]
  }
}

Handling Specific Errors

400 Bad Request

  • Check the error message and details in the response body.
  • Ensure all required parameters are included and valid.
  • Verify that the data format meets the API specifications.

401 Unauthorized

  • Check that you're including a valid access token in the Authorization header.
  • Ensure your access token hasn't expired. If it has, obtain a new one.

403 Forbidden

  • Verify that your API key has the necessary permissions for the requested operation.
  • Check the scopes associated with your access token.

429 Too Many Requests

  • Implement exponential backoff in your client.
  • Use the Retry-After header to determine when to retry the request.
  • Consider optimizing your code to make fewer API calls.

500 Internal Server Error

  • These errors are on our end. If you consistently encounter this error, please contact our support team with details of your request.