TRtrycourier
Digests

List digest instances

Changed on

Returns the digest instances for a schedule, one per user, with cursor paging. Use it to see what has accumulated before a digest releases.

get/digests/schedules/{schedule_id}/instances

Request

Path parameters

schedule_idstring required

The ID of the digest schedule, in the form sch/{uuid}. The value must be URL-encoded (e.g. sch%2F00000000-0000-0000-0000-000000000000).

Query parameters

cursorstring

A cursor token from a previous response, used to fetch the next page of results.

limitinteger

The maximum number of digest instances to return. Defaults to 20, with a maximum of 100.

Response

type'list' required

Always list for a paginated list response.

has_moreboolean required

Whether there are more digest instances to fetch using the cursor.

cursorstring nullable

A cursor token for fetching the next page of results, or null when there are none.

urlstring

The path of the current request.

next_urlstring nullable

The path to fetch the next page of results, or null when there are none.

Changes