Status codes and Error Handling

Status 200 - OK

GraphQL does not return status codes in the same way that REST APIs do. For example, GraphQL can return a 200 OK in cases where a REST API would return a 5xx or 4xx status code. Due to this fact, GraphQL can return a 200 OK even when an action at the application level fails.

Error Handling

To check for errors, you need to check for the 'errors' object within the response, which contains additional information about what caused the issue. Some mutations also have a "Success" boolean as a return field, that will return true or false, depending on the success or failure of the action. To check the return fields of all mutations and queries, check our API Docs.

In the event of an error, in addition to the error messages returned within the 'errors' object, we provide an 'extensions' object. This object will display details about the error that occurred, identified by the 'code' key (refer to the Error Table below), along with a 'correlation_id' hash to facilitate issue analysis with our support team.

{
 "data": {
   "deleteCard": null
 },
 "errors": [
   {
     "message": "Card not found with id: 00000000",
     "locations": [
       {
         "line": 32,
         "column": 3
       }
     ],
     "path": [
       "deleteCard"
     ],
     "extensions": {
       "code": "RESOURCE_NOT_FOUND",
       "correlation_id": "fcc162735121ac9f71ceba9fb58a639e"
     }
   }
 ]
}

{
  "data": {
    "updateFieldsValues": {
      "success": false
    }
  }
}

Error codes

See below those errors and an explanation of them

4XX and 5XX Status Codes

As mentioned above, in most cases GraphQL will return a 200 OK response when a REST API would return a 4xx or 5xx status code. But in some specific cases, a 4xx or 5xx status code can be returned. See below those cases and an explanation of them.