Pagination
Page-based pagination envelope used by list endpoints.
Most V1 list endpoints return a shared pagination envelope. Use the
page and page_size query parameters (where documented per
endpoint) to walk through results. The OpenAPI spec is authoritative for defaults
and maximum page sizes.
Paginated response envelope
{
"count": 142,
"page": 1,
"page_size": 20,
"total_pages": 8,
"has_next": true,
"has_previous": false,
"results": [ /* ... */ ]
}
| Field | Meaning |
|---|---|
count |
Total number of matching rows across all pages. |
page |
Current page number (1-based). |
page_size |
Maximum rows returned in this page. |
total_pages |
Total pages given the current page_size. |
has_next |
true when another page exists after this one. |
has_previous |
true when a page exists before this one. |
results |
Array of items for the current page. |
Page size
Inventory and ingestion list endpoints accept page_size between
1 and 100 where documented in OpenAPI. When omitted, the default
is endpoint-specific. check the spec rather than assuming a global default.
MusiSearch (POST /v1/search/tracks) uses the same envelope fields in
its response body; pagination parameters are described in the OpenAPI operation.
Where pagination applies
| Endpoint | Notes |
|---|---|
| GET /v1/workspace/tracks | Workspace track inventory. |
| GET /v1/atlas/tracks | Atlas track inventory. |
| GET /v1/workspace/artists | Workspace artist inventory. |
| GET /v1/atlas/artists | Atlas artist inventory. |
| GET /v1/workspace/releases | Workspace release inventory. |
| GET /v1/atlas/releases | Atlas release inventory. |
| GET /v1/workspace/works | Workspace work inventory. |
| GET /v1/workspace/labels | Workspace label inventory. |
| GET /v1/atlas/labels | Atlas label inventory. |
| GET /v1/ingestions | Ingestion delivery status list. |
| GET /v1/ingestions/{id}/entities | Delivered entities for one batch. |
| GET /v1/ingestions/{id}/items | Ingestion item rows. |
| GET /v1/storage/inbound/objects | List mode only (prefix + page_size). Pass continuation_token from the previous response next_token to continue. Exact lookup via object_key is not paginated. |
| POST /v1/search/tracks | MusiSearch results envelope. |
| GET /v1/profiling/profiles | Persisted MusiProfile history. |
| GET /v1/me/credits/history | Organisation credit ledger history. |
Where pagination does not apply
- GET /v1/catalogs. returns {count, results} without page / page_size.
- GET /v1/tagging/taxonomy. full taxonomy returned in one response.
- GET /v1/tagging/matrix. scoring matrix metadata in one response.
- POST /v1/tagging. live tagging returns a single result object.
- GET /v1/tagging/results. stored tagging lookup for one track.
- POST /v1/audio/features. live feature extraction for one object.
- POST /v1/profiling/profiles. create returns one persisted profile.
- GET /v1/me/credits. balance snapshot, not a page list.
Related documentation
- OpenAPI spec: per-endpoint parameters and schemas.
- Errors: validation errors for out-of-range page values.