Errors

Errors returned from API endpoints will typically have the following format.

JSON

{
  "statusCode": 400,
  "message": "BadRequest",
  "data": null,
  "errors": null
}

Error Schema

Attribute	Type	Description
statusCode	Integer	Standard HTTP response code.
message	String	A human-readable message providing more details about the status code.
data	String	Any data returned, typically null.
errors	Array of Strings	An array of human-readable error messages, if available (null otherwise).

HTTP Status Codes

Status Code	Message	Description
200 - OK	Success	Everything worked as expected.
400 - BAD REQUEST	Bad Request	The request was not accepted, likely due to missing a required parameter or incorrect syntax.
401 - UNAUTHORIZED	Unauthorized	A valid authorization token was not included in the request header.
403 - FORBIDDEN	Forbidden	Your account is not configured to allow access to the requested API endpoint.
404 - NOT FOUND	Not Found	The requested resource does not exist.
405 - METHOD NOT ALLOWED	Method Not Allowed	A request method is not supported for the requested endpoint. For example, a GET request on a form that requires data to be presented via POST, or the request was made using HTTP instead of HTTPS.
500 - INTERNAL SERVER ERROR	Internal Server Error	Something went wrong on our end.