API
Get Started
HTTP Statuses

HTTP Statuses

In addition to the HTTP methods that the API responds to, it also returns the standard HTTP status, including the error code.

If a problem occurs, the status contains the error code and the body of the response usually contains additional information about the problem that occurred.

Generally, If the status returned is in the range of 200, the request is usually successful, and no errors have occurred.

Return codes in the 400 range usually indicate that there was a problem with the request sent. This may mean, in particular, one of the following options:

  • Are not properly authenticated
  • Requesting an unauthorized action
  • The requested object does not exist
  • There is an error in your request.

In the status of range 500, this usually indicates a server-side problem. This means there is a problem on our part and we are currently unable to meet your demands.

Responses

Example Error Response

json
// HTTP/1.1 401 Unauthorized
 
{
  "error": "unauthorized",
  "message": "Unable to authenticate you."
}