Catalog

List catalog snapshot diff changes.

Changed on

Credits keys: 0.001 credits per successful page.

Retrieve a page of internal channel IDs for either added or removed changes in a stored diff. IDs can be used with channel info endpoints; they are not Telegram numeric IDs. count is the total for the selected change type, not this page's length. The result is fixed at diff creation time. Use next_cursor as cursor with the same diff ID and change type for the next page. Page size is 1–1000 (default 100). Catalog and snapshot access must both be enabled.

get/v1/catalog/diffs/{diff_id}/changes

Request

Path parameters

diff_idstring required

Unique diff identifier. Pass the value returned when creating or listing diffs unchanged.

Query parameters

change_type'added' | 'removed' required

Select added or removed channels relative to the original snapshot.

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

diff_idstring required

Unique diff identifier. Pass it unchanged to diff endpoints.

change_typestring required

Selected change type: added or removed, relative to the original snapshot.

channel_idsstring[] required

Internal channel IDs on this page, compatible with channel info endpoints. These are not Telegram numeric IDs.

countinteger required

Total channels for the selected change type across all pages, not the current page length.

next_cursorstring nullable

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

Example response

{
  "diff_id": "01900000-0000-7000-8000-000000000002",
  "change_type": "added",
  "count": 25
}

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