HTTP Statuses

Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes.

In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered.

In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered.

Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed.

If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having an issue on our end and cannot fulfill your request currently.

400 and 500 level error responses will include a JSON object in their body, including the following attributes:

Name	Type	Description
success	boolean	A boolean value indicating whether the request was successful. This will always be false in the case of an error.
message	string	A message providing additional information about the error, including details to help resolve it when possible.
meta	Meta	Optionally, a meta object may be included in the response. This object will contain additional information about the error. This will be empty object if no additional information is available.
errors	Errors	Optionally, an errors object may be included in the response. This object will contain additional information about the error. This will be empty array if no additional information is available.
result	any	Contain array or object. This will always be null in the case of an error.

Example Error Response

HTTP/1.1 403 Forbidden
{
    "success": false,
    "message":  "Unable to authorize you.",
    "meta": {},
    "errors": [],
    "result": null
}

HTTP Statuses

Example Error Response#

Example Error Response