Sign in

v1

latestOpenAPI 3.1.0Serval License2026-07-26202952779.1 KB
Workflow Run API

Search Workflow Runs

Search workflow runs with filters. Supports filtering by workflow ID, status, user IDs, time range, linked ticket, and parent_workflow_run_id. To investigate a run's sub-workflows, search with parent_workflow_run_id set to that run's id (combine with statuses=[FAILED] to find failing children), then recurse into each child run.

post/v2/workflow-runs/search

Request body

teamIdstring

The ID of the team. Required.

workflowIdstring nullable

Filter by workflow ID.

statusesSvflowCommonModelsWorkflowRunStatus[]

Filter by statuses (multiple allowed).

targetUserIdstring nullable

Filter by the target user for the workflow run.

initiatedByUserIdstring nullable

Filter by the user who initiated the workflow run.

createdAfterstring nullable

Filter by runs created after this timestamp (RFC3339 format).

createdBeforestring nullable

Filter by runs created before this timestamp (RFC3339 format).

linkedTicketIdstring nullable

Filter by linked ticket ID.

pageSizeinteger nullable

Maximum number of results to return. Default is 50, maximum is 200. Larger values are silently coerced server-side; the actual value used is returned in the X-Served-Page-Size response header.

pageTokenstring nullable

Token for pagination. Leave empty for the first request.

includeOutputboolean nullable

When true (default), each returned run includes its output field (the full workflow result). For multi-row search responses this can be megabytes per row — set to false if you only need run metadata; you can then fetch full output per-run via GetWorkflowRun. Strongly recommended false for any caller that does not need output.

parentWorkflowRunIdstring nullable

Filter to the direct child runs (sub-workflows) of this parent run. Pass a run ID here to list the runs it spawned one level deep; combine with statuses (e.g. FAILED) to find the failing children.

Response

Success

nextPageTokenstring nullable

Token for retrieving the next page of results. Empty if no more results.