Get Workflows

GET

https://host.com/v1/workflow/

GET

/v1/workflow/

$ curl https://host.com/v1/workflow/ \
>      -H "Content-Type: application/json"

1 {
2   "next_page_token": "eyJwYWdlIjoxfQ==",
3   "workflows": [
4     {
5       "close_time": "2024-04-20T16:45:00Z",
6       "failed_stage": false,
7       "href": "https://temporal.example.com/workflow/view/abc123",
8       "id": "abc123",
9       "pending_approval": false,
10       "search_attributes": {
11         "Department": [
12           "Finance"
13         ],
14         "Priority": [
15           2
16         ],
17         "IsUrgent": [
18           true
19         ],
20         "StartDates": [
21           "2024-04-01T00:00:00Z"
22         ]
23       },
24       "start_time": "2024-04-20T14:00:00Z",
25       "started_by": "jane.doe@example.com",
26       "status": "Completed",
27       "workflow_input": null,
28       "workflow_type": "InvoiceProcessing"
29     }
30   ]
31 }

Return a filtered list of workflows.

Query parameters

userstring or nullOptional

workflow_typestring 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

limitintegerOptionalDefaults to 100

next_page_tokenstring or nullOptional

Response

Successful Response

next_page_tokenstring or null

workflowslist of objects

Errors

422

Unprocessable Entity Error