Sign in

v2

latestOpenAPI 3.1.02026-07-2664759910.6 KB
external
external-v2

List Collections

List collections visible to the authenticated caller with cursor pagination. Results are ordered by order_by and return next_page when additional rows are available. For relevance-ranked retrieval by query, use POST /v2/collections/search.

get/v2/collections

Query parameters

limitinteger nullable

Maximum number of collections in this page. Use smaller values for lower latency. Default is 50; valid range is 1 to 100.

Maximum number of collections in this page. Use smaller values for lower latency. Default is 50; valid range is 1 to 100.

pagestring nullable

Opaque cursor from a previous list response. Omit for the first page. IMPORTANT: Reuse with the same filters and order_by settings.

Opaque cursor from a previous list response. Omit for the first page. IMPORTANT: Reuse with the same filters and order_by settings.

order_by'created_at' | 'updated_at'

Sort key for pagination boundaries. Use updated_at (default) for recency feeds. Use created_at for creation-order views.

Sort key for pagination boundaries. Use updated_at (default) for recency feeds. Use created_at for creation-order views.

filter_by_created_afterstring date-time nullable

Optional inclusive lower bound for collection creation time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

Optional inclusive lower bound for collection creation time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

filter_by_created_beforestring date-time nullable

Optional inclusive upper bound for collection creation time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

Optional inclusive upper bound for collection creation time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

filter_by_updated_afterstring date-time nullable

Optional inclusive lower bound for collection update time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

Optional inclusive lower bound for collection update time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

filter_by_updated_beforestring date-time nullable

Optional inclusive upper bound for collection update time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

Optional inclusive upper bound for collection update time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

Response

OK

next_pagestring nullable

Opaque cursor for the next page of collection results. null when there are no more results.

request_idstring required

Identifier for this API request. Useful for tracing and support.

totalinteger required

Total number of matching collections before pagination is applied.

Example response

{
  "next_page": "eyJvcmRlcl9ieSI6InVwZGF0ZWRfYXQiLCJ2YWx1ZSI6IjIwMjUtMDUtMDRUMTQ6MjA6MTFaIiwiaWQiOiIwMThmOGQwZC01YTNjLTdhZmMtODMyMS0yZjZmNmUwZmVmYWIifQ",
  "request_id": "api-request-018f8d0d-5a3c-7afc-8321-2f6f6e0fefab",
  "results": [
    {
      "created_at": "2025-05-01T10:05:45Z",
      "description": "Initiatives and plans for Q1",
      "id": "018f8d0d-5a3c-7afc-8321-2f6f6e0fefab",
      "note_count": 12,
      "title": "Project Phoenix",
      "updated_at": "2025-05-04T14:20:11Z"
    }
  ],
  "total": 24
}