Catalog

List catalog snapshots.

Changed on

Credits keys: 0.001 credits per successful page.

List your active snapshots using cursor pagination. Expired snapshots are excluded. Returns metadata only, without channel IDs. active_count is the total across all pages; active_limit is your current maximum number of active snapshots. Delete unneeded snapshots or wait for expiration to free capacity. Use next_cursor as cursor to request the next page. Page size is 1–1000 (default 100). Catalog and snapshot access must both be enabled.

get/v1/catalog/snapshots

Request

Query parameters

limitinteger

Maximum items per page. Default: 100. Allowed range: 1–1000.

cursorstring

Opaque next_cursor from the previous page. Omit for the first page; keep the same filters.

Response

active_countinteger required

Total active resources of this type owned by your user, across all pages. For diffs, includes all snapshots even when snapshot_id is specified.

active_limitinteger required

Maximum active resources of this type allowed by your current API limits. Diff limits apply across all snapshots; reaching the cap blocks creation with HTTP 429.

next_cursorstring nullable

Opaque token for the next page, or null when no more results remain.

Example response

{
  "items": [
    {
      "snapshot_id": "01900000-0000-7000-8000-000000000001",
      "channels_count": 1500,
      "created_at": "2026-09-08T12:00:00Z",
      "expires_at": "2026-10-08T12:00:00Z"
    }
  ]
}

Changes

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      endpoint added