Sign in

v5

OpenAPI 3.1.02026-07-31129337684.6 KB
Workflow Runs

Get Workflow Runs

Endpoint to retrieve workflow runs for a specific workflow if workflow_id is provided. Else, all workflow runs for the team are retrieved.

get/workflows/v1/workflow-runs

Query parameters

logical_idstring nullable

Filter by logical ID

workflow_idstring
status'not_started' | 'started' | 'running' | 'failed' | 'completed' | 'paused' | 'waiting_for_user_input' | 'cancelled' | 'aborted_looping_risk'
version_numberinteger nullable

Filter by version number

{
  "workflow_id": "5eb7cf5a86d9755df3a6c593"
}
sizeinteger

Number of items per page

Number of items per page

pageinteger

Page number

Page number

searchstring nullable

Search keywords

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

Filter by end time (ISO 8601 format)

Response

Successful Response

totalinteger nullable

Total number of workflow runs available without pagination.

Example response

{
  "workflow_runs": [
    {
      "_id": "5eb7cf5a86d9755df3a6c593",
      "workflow_run": {
        "workflow_id": "5eb7cf5a86d9755df3a6c593"
      },
      "schedule_id": "5eb7cf5a86d9755df3a6c593"
    }
  ]
}