Understanding HTTP error codes

Our API uses standard HTTP status codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided and codes in the 5xx range indicate an error with our servers.

2xx Success

These are the success codes you might encounter with our API:

  1. 200 OK: The request was successful, and the response body contains the requested data.
  2. 201 Created: The request was successful, and resulted in a resource being created.
  3. 204 No Content: The request was successful, but there's no representation to return (i.e. the response is empty).

4xx Error

These are the client error codes:

  1. 400 Bad Request: The request could not be understood or was missing required parameters.
  2. 401 Unauthorized: Authentication failed or user doesn't have permissions for the requested operation.
  3. 403 Forbidden: Authentication succeeded but authenticated user doesn't have access to the resource.
  4. 404 Not Found: The requested resource could not be found.
  5. 429 Too Many Requests: The user has sent too many requests in a given amount of time (rate limiting).

5xx Error

These are the server error codes:

  1. 500 Internal Server Error: Something went wrong on the server side.
  2. 503 Service Unavailable: The server is currently unable to handle the request due to a temporary overload or scheduled maintenance.

When an HTTP error occurs, your request will include a response body with further details about the problem. For example:

{
  "message": "You have exceeded your rate limit.",
  "documentation_url": "http://yourcompany.com/docs/rate-limits"
}

We recommend building your API client to handle these HTTP errors gracefully. If you encounter any issues or need further assistance, our support team is here to help.

Was this helpful?