Skip to main content
GET
/
v1
/
workflow-definitions
/
{definition_id}
/
runs
List Workflow Runs Handler
curl --request GET \
  --url http://localhost:8000/v1/workflow-definitions/{definition_id}/runs
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflow_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "runner_type": "SELF_HOSTED",
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "run_snapshot": {
        "workflow_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "workflow_name": "<string>",
        "runner_type": "SELF_HOSTED",
        "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "max_run_duration_seconds": 123,
        "sources": [
          {
            "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "materialized_path": "<string>"
          }
        ],
        "instructions": [
          {
            "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "materialized_path": "<string>"
          }
        ],
        "outputs": [
          {
            "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "materialized_path": "<string>"
          }
        ],
        "template": {
          "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "materialized_path": "<string>"
        }
      },
      "error": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 1,
  "limit": 2,
  "offset": 1
}

Headers

​
authorization
string | null

Path Parameters

​
definition_id
string<uuid>
required

Query Parameters

​
limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of items to skip

Required range: x >= 0

Cookies

​
ks_uat
string | null

Response

Successful Response

​
items
WorkflowRunResponse · object[]
required

List of items

​
total
integer
required

Total number of items

Required range: x >= 0
​
limit
integer
required

Number of items per page

Required range: x >= 1
​
offset
integer
required

Number of items to skip

Required range: x >= 0