Help and Support

For help with using the API, or if a new feature is required, contact us at [email protected]

Errors

We try to make sure that all error messages are self-explanatory and easier to understand. For example, a validation error will show a message such as Variable "$xyz" got invalid value "X".

This allows for easier debugging of the queries and requests that are made to the API. An example error JSON object, returned by the API, is shown below.

{
  "errors": [
    {
      "message": "Variable \"$status\" got invalid value \"UNKNOWN\" at \"status[2]\"; Value \"UNKNOWN\" does not exist in \"InvoiceStatus\" enum.",
      "locations": [
        {
          "line": 1,
          "column": 25
        }
      ],
      "extensions": {
        "code": "BAD_USER_INPUT"
      }
    }
  ]
}