Error responses#

In case of an error (HTTP status code >= 400) the response contains information about the error (error object). Some errors may contain additional data (e.g. resource validation).

ANY /resource#

Return error info.

Response JSON Object:
  • error.code (integer) – error code

  • error.message (string) – error message

Example request:

GET /api/v2/resources/dummy HTTP/1.1
Host: app.example.com
Accept: application/json

Example response:

HTTP/1.1 404 Not Found
Content-Type: application/json

{
    "error": {
        "code": 404,
        "message": "Cannot find dummy resource"
    }
}