Catalog

Get catalog snapshot.

Changed on

Credits keys: 0.001 credits per successful metadata read.

Retrieve the saved filters, channel count, creation time, and expiration time of a snapshot owned by your user. Channel IDs are not included. An unavailable snapshot returns 404; a retained but expired snapshot returns 410. Catalog and snapshot access must both be enabled.

get/v1/catalog/snapshots/{snapshot_id}

Request

Path parameters

snapshot_idstring required

Unique snapshot identifier. Pass the value returned when creating or listing snapshots unchanged.

Response

snapshot_idstring required

Unique identifier of the original snapshot. Pass it unchanged to snapshot endpoints.

channels_countinteger required

Number of channels saved in the snapshot, up to 800,000.

created_atstring required

Creation timestamp in UTC, formatted as RFC 3339.

expires_atstring required

Expiration timestamp in UTC, formatted as RFC 3339. Resources expire 30 days after their own creation.

Example response

{
  "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