---
title: "Get a workflow recipient run"
method: GET
path: "/v1/workflow_recipient_runs/{id}"
tags: ["Workflow recipient runs"]
---

# Get a workflow recipient run

`GET /v1/workflow_recipient_runs/{id}`

Returns a single workflow recipient run with its associated events.

## Path parameters

- `id` string, required

## Response `200`

OK

- WorkflowRecipientRunDetail — A single workflow recipient run with its events.
  - `__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.
  - `events` WorkflowRecipientRunEvent[], required — A list of events that occurred during the workflow recipient run.
    - `__typename` string, required — The typename of the schema.
    - `attempt` integer — The attempt number of the workflow recipient run event. Increments for each retry.
    - `data` object, nullable — Event-specific data associated with the event.
    - `event` string, required — The type of event that occurred.
    - `id` string, required — The unique identifier for the event.
    - `inserted_at` string, date-time, required — Timestamp when the resource was created.
    - `status` 'ok' | 'error', required — Whether the event represents a successful or error state.
    - `step_ref` string, nullable — The reference of the workflow step associated with this event.
    - `step_type` string, nullable — The type of workflow step associated with this event.

---

[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)