Skip to main content
Similar to an HTML error page that displays a useful message to a visitor, the API returns error information in a consumable format. Error representations use the same structure as regular resource representations, with their own set of fields.

​
Error response format

{
  "errors": [
    {
      "status": "404",
      "title": "not found http exception",
      "detail": "An entity with the requested identifier does not exist."
    }
  ]
}

​
Error object fields

​
errors
array
An array of error objects.

​
Common error examples

Resource not found 
{
  "errors": [
    {
      "status": "404",
      "title": "not found http exception",
      "detail": "An entity with the requested identifier does not exist."
    }
  ]
}
Invalid filter value 
{
  "errors": [{
    "status": "400",
    "title": "unexpected value exception",
    "detail": "Expected integer value. Given \"aaa\".",
    "source": {
      "parameter": "filter[id]"
    }
  }]
}
Unsupported filter 
{
  "errors": [{
    "status": "400",
    "title": "filter constraint",
    "detail": "Filter \"filter[unknown]\" is not supported.",
    "source": {
      "parameter": "filter[unknown]"
    }
  }]
}

Build docs developers (and LLMs) love

Get started for freeTalk to us