latestOpenAPI 3.0.02026-08-08270135.7 KB

c1404d1545ba

collections

Get collections

Retrieve a paginated list of all collections visible to the API key.

Personal API keys receive the key owner's virtual Private collection with ID `private`. Workspace API keys never receive private collections.

This endpoint allows you to:
- List all collections available to the current workspace
- Paginate through large sets of collections
- Use for collection pickers, dashboards, or management UIs

**Use cases:**
- Displaying available collections to users
- Building collection management interfaces
- Syncing collections with external tools
get/api/v1/collections

Query parameters

limitinteger

The number of items to return per page.

offsetinteger

The number of items to skip before starting to collect the result set.

Response

This response returns a paginated list of collections.

limitnumber required

The maximum number of items to return.

offsetnumber required

The number of items to skip before starting to collect the result set.

hasNextPageboolean required

Indicates if there are more pages available.