List workflow runs

Returns a list of workflow runs with optional filtering by workflow type

GET /workflow/runs

List workflow runs

cURL

curl --request GET \
  --url http://localhost:3001/workflow/runs

200

{
  "runs": [
    {
      "workflowId": "<string>",
      "runId": "<string>",
      "workflowType": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123
}

Query Parameters

workflowType · string

Filter by workflow type/name

catalog · string

Filter by catalog ID (scopes runs to a single worker's catalog/session)

limit · integer · default: 100

Maximum number of runs to return

Required range: 1 <= x <= 1000

Response

200

application/json

List of workflow runs

runs · object[]

Show child attributes

count · integer

Total number of runs returned