Base URL
All API endpoints are available under:Authentication
Every request requires a Bearer token in theAuthorization header:
401 Unauthorized. See Authentication for how to obtain a token.
Pagination
List endpoints supportlimit and offset query parameters:
| Parameter | Default | Description |
|---|---|---|
limit | 50 | Number of results to return |
offset | 0 | Number of results to skip |
Errors
All errors return a JSON response body with adetail field:
| Status code | Meaning |
|---|---|
400 | Bad request: check request body or parameters |
401 | Unauthorized: missing or invalid token |
403 | Forbidden: insufficient permissions |
404 | Not found |
422 | Unprocessable entity: validation error |
500 | Server error |
Soft deletes
Most delete endpoints soft-delete resources. They are excluded from list responses but remain in the database. Some resources have a corresponding restore endpoint.Content type
For allPOST, PUT, and PATCH requests with a request body, set:
multipart/form-data.
