Error Handling

When an error occurs, the API responds with an appropriate HTTP status code and a JSON payload containing error details.

Common Errors

400 Bad Request

Indicates the request could not be understood, often due to invalid query parameters or malformed syntax.

Example Response:

{
  "error": {
    "code": 400,
    "message": "Invalid query parameter: 'filter[unknown]'"
  }
}

401 Unauthorised

No valid API key was provided, or the format is incorrect.

Example Response:

{
  "error": {
    "code": 401,
    "message": "API key is missing or invalid."
  }
}

403 Forbidden

Your API key lacks the required privileges or has been revoked.

Example Response:

{
  "error": {
    "code": 403,
    "message": "Access to this resource is forbidden."
  }
}

404 Not Found

The requested resource (e.g. project ID) does not exist.

Example Response:

{
  "error": {
    "code": 404,
    "message": "Resource not found."
  }
}

429 Too Many Requests

Rate limit exceeded. See Rate Limiting for details.

Example Response:

{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded. Please wait before making further requests."
  }
}

500 Internal Server Error

An unexpected error occurred on the server side.

Example Response:

{
  "error": {
    "code": 500,
    "message": "An internal server error occurred."
  }
}