API Errors

The API uses HTTP status codes to indicate an error has occurred while processing a request. There are three main error status codes used by the API:

Code	Description
403	The request could not be authenticated or the authenticated user is not authorized to access the requested resource.
404	The requested resource does not exist.
422	The request could not be processed, usually due to a missing or invalid parameter.

In the case of 422 errors the response will also include an error object with an explanation of fields that are missing or invalid. Here is an example:

HTTP/1.1 422 Unprocessable Entity

{
  "errors": [
    {
      "title": "The connection service was not provided.",
      "source": {
        "pointer": "/data/attributes/service"
      }
    },
    {
      "title": "The connection externalid was not provided.",
      "source": {
        "pointer": "/data/attributes/externalid"
      }
    }
  ]
}