The API expose HTTP errors in ApiProblem format specification.

By errors, we mean all responses with status codes in 4xx and 5xx ranges.

All error responses are send with a Content-Type: application/problem+json header.

Response example

HTTP/1.1 403 Forbidden
Content-Type: application/problem+json

    "type": "
    "title": "Forbidden",
    "detail": "You must provides a valid token"

The API garantee that you will alway find the following properties in response:

  • type A link to the problem documentation
  • title Usually the standard status code phrase
  • detail Human understable error message

Depending on problems, responses can have more properties related to the error. Those properties are documented in API reference bellow in resources description.