Errors

Sometimes your API call will generate an error. Here you will find additional information about what to expect if you don’t format your request properly, or we fail to properly process your request.

Response Codes

Status Code Description

• 400 Bad request

• 401 Requires authentication

• 403 Forbidden

• 404 Not Found

• 405 Method Not Allowed

• 406 Missing Accept header. For example: Accept: application/json

• 429 Too many requests/Rate limit exceeded

• 500 Internal server error

Failed Requests

The general format guidelines are displayed when the accompanying status code is returned.

GET {API_URL}/sample-endpoint HTTP/1.1

HTTP/1.1 404 BAD REQUEST
Content-Type: application/json

{
  "type": "{ERROR_TYPE_DOCUMENTATION_LINK}",
  "title": "{ERROR_TITLE}",
  "status": {STATUS_CODE},
  "detail": "{ERROR_DETAILS}",
  "instance": "{API_ENDPOINT}",
  "code": "{ERROR_CODE}",
  "errors": [
    {
      "field": "{FIELD}",
      "detail": "{DETAILS}"
    }
  ]
}