Errors

Errors

How the API reports errors and what each code means.

The API returns errors in the standard GraphQL errors array; the HTTP status stays 200 and data may be null or partial. Each error carries a machine-readable code in extensions.code.

RESPONSE
{
  "errors": [
    {
      "message": "Issue not found",
      "extensions": {
        "code": "NOT_FOUND"
      }
    }
  ],
  "data": null
}

Errors on any request

These can be returned by any operation across the whole API.

UNAUTHENTICATEDYour API key is missing, invalid or expired.
RATE_LIMITYou have sent too many requests; wait before retrying.
INTERNALAn unexpected server error occurred; retry later.

Specific errors

Depending on the operation and the input you send, a request may also return:

NOT_FOUNDThe resource does not exist or your organization cannot access it.
VALIDATIONThe input does not meet the required rules (for example, a field is too long or a value is not allowed).
INPUTThe input is malformed or has the wrong type (for example, a badly formatted ID or a missing required field).
CONSTRAINTA unique or data constraint was violated (for example, a value already in use); extensions.field identifies the field.