Skip to navigation
WorkflowsRuns

Flows · Runs · List recent runs of one workflow, newest first

View as Markdown

Returns recent executions of one workflow definition, newest first.

Returns an array under result — not a paginated envelope, so there is no count or next. Capped at 20 rows by size. Each entry carries id (the RUN ID), workflow_id (the definition ID), status, start_time, end_time, execution_time and reason_for_incompletion. Inputs and outputs are omitted.

resource: workflow://run-control covers which read to use when.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

workflowintegerRequired

Numeric workflow-definition ID whose runs to list. Required — see above.

sizeintegerOptional<=20Defaults to 20

Maximum runs to return. Hard-capped at 20 server-side.

startintegerOptionalDefaults to 0
Offset into the result set, for walking back in time.
sortstringOptionalDefaults to startTime:DESC

Sort expression, e.g. startTime:DESC.

free_textstringOptional

Full-text filter across the run's indexed fields.

creatorintegerOptional
Restrict to runs started by this numeric user ID.
sourcestringOptional
Restrict to runs started from a given source channel.

Response

Object carrying a result array of run summaries, newest first — not a bare array. In each entry id is the RUN ID, while workflow_id is the workflow definition ID.

Errors

400
Bad Request Error