Errors

We follow standard conventions for using HTTP codes on all responses. For errors, where additional context can be provided, we may include this in the response body following a consistent model.

HTTP Codes

Here are some of the standard HTTP response codes we'll send back when something goes wrong:

Error Model

For any error that contains additional detail and reasoning to the standard HTTP response codes), an array of errors will be returned.

This is particularly useful in cases where validation is performed and the API responds with a number of errors.

Example

For example, when creating an item with multiple required / validated fields, the response might look like:

HTTP Response Code: 400
Response Body:
{
  "errors": [
    {
      "title": "Missing 'name'",
      "detail": "The 'name' field is required and must be specified",
      "source": "Apigee"
    },
    {
      "title": "Invalid 'phoneNumber'",
      "detail": "The 'phoneNumber' field must be of type 'number'",
      "source": "Backend"
    }
  ]
}