Sign in

v30

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-22116135580.0 KB
Workflow recipient runs

Get a workflow recipient run

Returns a single workflow recipient run with its associated events.

get/v1/workflow_recipient_runs/{id}

Path parameters

idstring required

The unique identifier for the workflow recipient run (per-recipient).

Response

OK

__typenamestring required

The typename of the schema.

error_countinteger

The number of errors encountered during the workflow recipient run.

idstring uuid required

The unique identifier for the workflow recipient run (per-recipient).

inserted_atstring date-time required

Timestamp when the resource was created.

status'queued' | 'processing' | 'paused' | 'completed' | 'cancelled' required

The current status of the workflow recipient run. One of queued, processing, paused, completed, or cancelled.

tenantstring nullable

The tenant associated with the workflow recipient run.

updated_atstring date-time required

The timestamp when the resource was last updated.

workflowstring required

The key of the workflow that was executed.

workflow_run_idstring uuid required

The identifier for the top-level workflow run shared across all recipients in a single trigger.

Example response

{
  "__typename": "WorkflowRecipientRun",
  "actor": "user_456",
  "error_count": 0,
  "events": [
    {
      "__typename": "WorkflowRecipientRunEvent",
      "attempt": 1,
      "data": {
        "channel_type": "email",
        "message_id": "2FVHPWxRqNuXQ9krvNP5A6Z4qXe"
      },
      "event": "message_enqueued",
      "id": "2FVHPWxRqNuXQ9krvNP5A6Z4qXe",
      "inserted_at": "2025-01-01T00:00:00Z",
      "status": "ok",
      "step_ref": "email_step_1",
      "step_type": "channel"
    }
  ],
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "inserted_at": "2025-01-01T00:00:00Z",
  "recipient": "user_123",
  "status": "completed",
  "tenant": "tenant_abc",
  "trigger_source": {
    "cancellation_key": "comment-123-user-456",
    "type": "api"
  },
  "updated_at": "2025-01-01T00:05:00Z",
  "workflow": "comment-created",
  "workflow_run_id": "660e8400-e29b-41d4-a716-446655440000"
}