---
title: "List workflow recipient runs"
method: GET
path: "/v1/workflow_recipient_runs"
tags: ["Workflow recipient runs"]
---

# List workflow recipient runs

`GET /v1/workflow_recipient_runs`

Returns a paginated list of workflow recipient runs for the current environment.

## Query parameters

- `after` string
- `before` string
- `page_size` integer
- `workflow` string
- `status[]` string[]
- `tenant` string
- `has_errors` boolean
- `recipient` union — A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
  - string — The ID of the user which is used as the reference for the recipient.
  - object — A reference to a recipient object.
    - `collection` string — The collection the recipient object belongs to.
    - `id` string — An identifier for the recipient object.
- `starting_at` string, date-time
- `ending_at` string, date-time

## Response `200`

OK

- ListWorkflowRecipientRunsResponse — A paginated list of workflow recipient runs.
  - `items` WorkflowRecipientRun[], required — A list of workflow recipient runs.
    - `__typename` string, required — The typename of the schema.
    - `actor` union — The actor who triggered the workflow recipient run.
      - union — A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
        - string — The ID of the user which is used as the reference for the recipient.
        - object — A reference to a recipient object.
          - `collection` string — The collection the recipient object belongs to.
          - `id` string — An identifier for the recipient object.
      - unknown
    - `error_count` integer — The number of errors encountered during the workflow recipient run.
    - `id` string, uuid, required — The unique identifier for the workflow recipient run (per-recipient).
    - `inserted_at` string, date-time, required — Timestamp when the resource was created.
    - `recipient` union, required — A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
      - string — The ID of the user which is used as the reference for the recipient.
      - object — A reference to a recipient object.
        - `collection` string — The collection the recipient object belongs to.
        - `id` string — An identifier for the recipient object.
    - `status` 'queued' | 'processing' | 'paused' | 'completed' | 'cancelled', required — The current status of the workflow recipient run. One of `queued`, `processing`, `paused`, `completed`, or `cancelled`.
    - `tenant` string, nullable — The tenant associated with the workflow recipient run.
    - `trigger_source` WorkflowRecipientRunTriggerSource, required — Describes how the workflow was triggered.
      - `audience_key` string, nullable — The key of the audience that triggered the workflow.
      - `cancellation_key` string, nullable — The cancellation key provided when the workflow was triggered via the API.
      - `schedule_id` string, nullable — The ID of the schedule that triggered the workflow.
      - `type` 'api' | 'audience' | 'schedule' | 'broadcast' | 'workflow_step' | 'integration' | 'rehearsal', required — The type of trigger source. One of `api`, `audience`, `schedule`, `broadcast`, `workflow_step`, `integration`, or `rehearsal`.
    - `updated_at` string, date-time, required — The timestamp when the resource was last updated.
    - `workflow` string, required — The key of the workflow that was executed.
    - `workflow_run_id` string, uuid, required — The identifier for the top-level workflow run shared across all recipients in a single trigger.
  - `page_info` PageInfo, required — Pagination information for a list of resources.
    - `__typename` string, required — The typename of the schema.
    - `after` string, nullable — The cursor to fetch entries after.
    - `before` string, nullable — The cursor to fetch entries before.
    - `page_size` integer, required — The number of items per page (defaults to 50).

---

[API](https://skmtc.net/knocklabs/apis/knock-api.md) · [All operations](https://skmtc.net/knocklabs/apis/knock-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/knocklabs/knock-api/revisions/4b8499dddbc5/schema)