Skip to main content

Base URL

All API endpoints are available under:

Authentication

Every request requires a Bearer token in the Authorization header:
Requests without a valid token return 401 Unauthorized. See Authentication for how to obtain a token.

Pagination

List endpoints support limit and offset query parameters:

Errors

All errors return a JSON response body with a detail field:

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 all POST, PUT, and PATCH requests with a request body, set:
File uploads use multipart/form-data.