---
title: "List digest instances"
method: GET
path: "/digests/schedules/{schedule_id}/instances"
tags: ["Digests"]
---

# List digest instances

`GET /digests/schedules/{schedule_id}/instances`

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

## Path parameters

- `schedule_id` string, required

## Query parameters

- `cursor` string
- `limit` integer

## Response `200`

- DigestInstanceListResponse
  - `type` 'list', required — Always `list` for a paginated list response.
  - `items` DigestInstance[], required — The digest instances for this page of results.
    - `digest_instance_id` string, required — A unique identifier for the digest instance.
    - `status` 'IN_PROGRESS' | 'COMPLETED', required — The status of the digest instance. `IN_PROGRESS` instances are still accumulating events; `COMPLETED` instances have been released.
    - `event_count` integer, required — The total number of events received for this instance.
    - `user_id` string, required — The ID of the user this digest instance belongs to.
    - `tenant_id` string, nullable — The ID of the tenant this digest instance belongs to, if any.
    - `categories` DigestCategory[] — The categories configured for the digest.
      - `category_key` string, required — The key that identifies the category within the digest.
      - `retain` 'first' | 'last' | 'highest' | 'lowest' | 'none', required — Which events to keep when the number of events exceeds the retention limit for the category.
      - `sort_key` string — The data key used to order events when `retain` is `highest` or `lowest`.
    - `category_key_counts` object — A map of category key to the number of events received for that category.
    - `disabled` boolean — Whether the digest instance has been disabled.
    - `created_at` string — An ISO 8601 timestamp of when the digest instance was created.
  - `has_more` boolean, required — Whether there are more digest instances to fetch using the cursor.
  - `cursor` string, nullable — A cursor token for fetching the next page of results, or null when there are none.
  - `url` string — The path of the current request.
  - `next_url` string, nullable — The path to fetch the next page of results, or null when there are none.

## Other responses

- `403` — The digest schedule does not belong to the authenticated workspace.

---

[API](https://skmtc.net/trycourier/apis/courier.md) · [All operations](https://skmtc.net/trycourier/apis/courier/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trycourier/courier/versions/04f69fbf96a5/schema)