Errors

Damn it. What happened now?

HTTP Errors

Here is a list of the most common HTTP errors you'll encounter. All errors return in a JSON format. In addition to returning the HTTP status codes, we also return an error message. There are different error types that are specific to certain use cases in the API.

HTTP Errors
JSON Error Messages

HTTP Status Code

Short Description

Description

200

OK

The action requested by the client was received, understood and accepted.

400

Bad Request

Cannot process the request. Most often because of a malformed syntax.

401

Unauthorized

The client is not authorized to make this API request.

403

Forbidden

You shall not pass. The user might not have the right permissions or may need a particular account.

404

Not Found

The resource requested is, wait for it, not found.

500

Internal Server Error

There was an unexpected error. This might be our bad, sorry.

503

Timed Out

The request timed out. There is a 30 second limit.

Error Type

HTTP Status Code

Description

ValidationError

400

Most often caused by a malformed syntax.

FieldDoesNotExist

400

A PUT request that tries to update a field that does not exist.

StateMachineError

400

An object is not allowed to change state in the order requested.

AuthorizationError

401

The client is not authorized to perform this request.

DoesNotExist

404

Used in GET request when querying for a specific ID and it doesn't exist.

The errors come in this format:

{
"code": <status code>,
"message": <A short message regarding the error>,
"description": <A generic description of the error>,
"error": {
"type": <The error type above>,
"exception_description": <A more specific error description>
}
}

The description in the returned errors may vary slightly between different API calls.

‚Äč