Error codes

When interacting with our API, you may encounter error responses that follow standard HTTP status codes, providing meaningful feedback to help diagnose and resolve issues efficiently. While many errors use a default format, some endpoints return more specific messages or have slight variations in their response structure.

Each endpoint description includes a detailed description of its possible error responses in the Response section of its documentation. Below, you'll find an overview of default error codes, and their meanings.

Invalid request or malformed request syntax. Please review the request body

{
  "title": "Bad request",
  "status": 400,
  "detail": "Value of {field_name} is incorrect." | "Value of {field_name} is required." | "Your request was not valid. Please check the body for any mistakes.",
  "timestamp": "2025-03-05 17:57:00"
}

An issue with authorization. Please review the authorization guide

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Invalid api key" | "No API addon" | "Upgrade your plan",
  "timestamp": "2025-03-05 17:57:00"
}

Your current feature set doesn't grant access to this action. For example using agency endpoints without the Agency add-on

{
  "title": "Forbidden",
  "status": 403,
  "detail": "User do not have permissions for specified resource",
  "timestamp": "2025-03-05 17:57:00"
}

Review the request URL for errors or confirm the specified resource exists

{
  "title": "Not Found",
  "status": 404,
  "detail": "Requested resource does not exist",
  "timestamp": "2025-03-05 17:57:00"
}

Too many requests. Refer to the rate limiting guide

{
  "title": "Too Many Requests",
  "status": 429,
  "detail": "Too many requests.",
  "timestamp": "2025-03-05 17:57:00"
}

Unknown error, please try again later

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error has occurred. Please try again later.",
  "timestamp": "2025-03-05 17:57:00"
}

Body schema

Field	Type	Description
`title`	string	A short title describing the error
`status`	integer	The HTTP status code
`detail`	string	A detailed message explaining the error
`timestamp`	string	The timestamp when the error occurred, `YYYY-MM-DD HH:MM:SS` UTC

Body schema​

Body schema