Workflow recipient runs

List workflow recipient runs

Changed on

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

get/v1/workflow_recipient_runs

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/workflow_recipient_runs
  • Auth: HTTP bearer

Query parameters

afterstring

The cursor to fetch entries after.

beforestring

The cursor to fetch entries before.

page_sizeinteger

The number of items per page (defaults to 50).

workflowstring

Limits the results to workflow recipient runs for the given workflow key.

statusstring[]

Limits the results to workflow recipient runs with the given status.

tenantstring

Limits the results to workflow recipient runs for the given tenant.

has_errorsboolean

Limits the results to workflow recipient runs that have errors.

string

The ID of the user which is used as the reference for the recipient.

OR
Example:user_123

Limits the results to workflow recipient runs for the given recipient. Accepts a user ID string or an object reference with id and collection.

starting_atstring date-time

Limits the results to workflow recipient runs started after the given date.

ending_atstring date-time

Limits the results to workflow recipient runs started before the given date.

Response

OK

Example response

{
  "items": [
    {
      "__typename": "WorkflowRecipientRun",
      "actor": "user_456",
      "error_count": 0,
      "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"
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "after": null,
    "before": null,
    "page_size": 25
  }
}

Changes

  • de4604427056Revision changes
    • warning

      deleted the query request parameter status[]

    • info

      added the new optional query request parameter status

  • 4b8499dddbc5Revision changes
    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status