Errors

GraphCMS uses conventional HTTP responses codes when returning API requests.

Codes in the 2xx range refer to a successful request, whereas responses in the 4xx range indicate there was an error due to the information you provided, such as invalid query arguments, or auth token.

A typical GraphQL error will look like the below. The format of the error is typical for any 400 query or mutation request.

{
  "errors": [
    {
      "message": "input:1: Field \"idd\" is not defined by type PostWhereInput. Did you mean id?\n"
    }
  ],
  "data": null,
  "extensions": {
    "requestId": "ckff8k1tc0nsg0150cssdkzxm"
  }
}

It's clear from the error above that the field idd is not part of the Input Type.

400: Bad requestAnchor

GraphCMS will return a 400 if there is an error with the request. 400 errors are typically thrown when there is a client-side validation error, such as a missing required argument in your GraphQL query, or a malformed Permanent Auth Token.

401: UnauthorizedAnchor

The endpoint you requested requires a valid Permanent Auth Token, or a environment may not exist for this project.

429: Too Many RequestsAnchor

To ensure delivery of optimal experiences to all customers, a rate limit is enforced on all GraphQL queries for the free community plan.

You'll get a 429 when you exceed the rate limit, and you will get a response with the following payload:

{
  "errors": [
    {
      "message": "Too Many Requests"
    }
  ],
  "data": null
}