Error codes

Individual endpoints may have specific error codes relevant to their function, but you can expect to see the following error codes returned across all endpoints:

400 Bad Request

Returned when there's an error specific to an endpoint. Will use the same structure as below, but code, message and details will be specific to the endpoint.

401 Not Authorized

Returned when API authentication is invalid

{
  "code": "not_authorized",
  "message": "Error. You do not have access.",
  "details": null
}

403 Forbidden

Used when auth succeeded by the user does not have permission

{
  "code": "forbidden",
  "message": "Error. Access Denied.",
  "details": null
}

404 Not Found

Used when the record does not exist or is otherwise not visible

{
  "code": "not_found",
  "message": "Error. Not found.",
  "details": null
}

500 Internal Server Error

Used when something unexpected went wrong. We have alarms and look into these, but if you need urgent support please open a ticket.

These should not happen and we work quickly to fix them when they do.

{
  "code": "internal_server_error",
  "message": "Error. Something went wrong.",
  "details": null
}