v2

latestOpenAPI 3.1.02026-07-262937191.0 MB
workflows.runs

List Runs

List Runs

get/v1/workflows/runs

Query parameters

workflow_identifierstring nullable

Filter by workflow name or id

Filter by workflow name or id

root_execution_idstring nullable

Filter by root execution id; returns the whole execution tree (the root and all its descendant sub-workflows).

Filter by root execution id; returns the whole execution tree (the root and all its descendant sub-workflows).

searchstring nullable

Search by workflow name, display name, or ID

Search by workflow name, display name, or ID

'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' | 'TERMINATED' | 'CONTINUED_AS_NEW' | 'TIMED_OUT' | 'RETRYING_AFTER_ERROR'
OR
WorkflowExecutionStatus[]

Filter by workflow status

deployment_namestring nullable

Filter by deployment name

Filter by deployment name

sort_by'start_time' | 'end_time' nullable

Field to sort by

Field to sort by

order'asc' | 'desc'

Sort direction

Sort direction

start_time_afterstring date-time nullable

Include runs with start_time >= value

Include runs with start_time >= value

start_time_beforestring date-time nullable

Include runs with start_time <= value

Include runs with start_time <= value

end_time_afterstring date-time nullable

Include runs with end_time >= value. Running executions (no end_time) are excluded; use the status filter to include them.

Include runs with end_time >= value. Running executions (no end_time) are excluded; use the status filter to include them.

end_time_beforestring date-time nullable

Include runs with end_time <= value. Running executions (no end_time) are excluded; use the status filter to include them.

Include runs with end_time <= value. Running executions (no end_time) are excluded; use the status filter to include them.

user_idstring nullable

Filter by user id. Use 'current' to filter by the authenticated user

Filter by user id. Use 'current' to filter by the authenticated user

workflow_tagsstring[] nullable

Filter to runs of workflows tagged with all listed tags (AND).

Filter to runs of workflows tagged with all listed tags (AND).

include_internalboolean

Include runs of internal/technical workflows (e.g. parallel-execution)

Include runs of internal/technical workflows (e.g. parallel-execution)

page_sizeinteger

Number of items per page

Number of items per page

next_page_tokenstring nullable

Token for the next page of results

Token for the next page of results

search_keystring[] nullable

Filter executions by search key as repeated 'key:value' entries. Each entry matches an exact key and a similar value; multiple entries are AND'd together (max 3).

Filter executions by search key as repeated 'key:value' entries. Each entry matches an exact key and a similar value; multiple entries are AND'd together (max 3).

Response

Successful Response

next_page_tokenstring nullable

Token to use for fetching the next page of results. Null if this is the last page.