Skip to main content

Base URL

Authentication

All endpoints (except health checks) require a Bearer token:
See Authentication for details on obtaining and managing API keys.

Pagination

List endpoints accept limit and offset query parameters: Paginated responses include:

Sorting

List endpoints accept sort and order query parameters to control result ordering: Each endpoint supports a specific set of sortable fields: Passing an invalid sort field returns a 400 error with the list of valid fields for that endpoint.

Error Format

All errors return a JSON body with code and message:

Common Error Codes

Interactive Playground

Explore the API interactively using the Swagger playground.