Get Workflows

GET

///v1/workflow/

GET

/v1/workflow/

$ curl /v1/workflow/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "next_page_token": "eyJwYWdlIjoxfQ==",
3   "page_count": 1,
4   "total_count": 1,
5   "workflows": [
6     {
7       "close_time": "2024-01-15T09:30:00Z",
8       "failed_stage": false,
9       "href": "https://temporal.example.com/workflow/view/3f2504e0-4f89-11d3-9a0c-0305e82c3301",
10       "id": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
11       "pending_approval": false,
12       "search_attributes": {
13         "DeviceId": [
14           "device-1234"
15         ],
16         "IsCritical": [
17           true
18         ],
19         "Priority": [
20           2
21         ],
22         "StartDates": [
23           "2024-01-10T08:00:00Z"
24         ]
25       },
26       "start_time": "2024-01-10T08:00:00Z",
27       "started_by": "alice@example.com",
28       "status": "Running",
29       "workflow_input": {
30         "parameters": {
31           "dataset": "sales_2023",
32           "retry": 3
33         },
34         "task": "data_processing"
35       },
36       "workflow_type": "DataProcessingWorkflow"
37     }
38   ]
39 }

Return a filtered list of workflows.

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

Query parameters

userstring or nullOptional

workflow_typestring or nullOptional

workflow_idstring or nullOptional

device_idstring or nullOptional

device_namestring or nullOptional

device_rolestring or nullOptional

device_platformstring or nullOptional

sitestring or nullOptional

statusstring or nullOptional

pending_approvalboolean or nullOptional

start_timedatetime or nullOptional

end_timedatetime or nullOptional

hide_completedbooleanOptionalDefaults to false

limitintegerOptionalDefaults to 100

next_page_tokenstring or nullOptional

Response

Successful Response

next_page_tokenstring or null

page_countinteger

total_countinteger

workflowslist of objects

Errors

422

Unprocessable Entity Error