Get Workflow

GET

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

GET

/v1/workflow/:workflow_id

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

1 {
2   "close_time": "2024-01-15T09:30:00Z",
3   "failed_stage": true,
4   "href": "https://temporal.example.com/workflow/view/abc123",
5   "id": "abc123",
6   "pending_approval": true,
7   "result": null,
8   "search_attributes": {
9     "priority": [
10       3
11     ],
12     "tags": [
13       "finance",
14       "urgent"
15     ],
16     "approved": [
17       false
18     ],
19     "due_date": [
20       "2024-01-20T00:00:00Z"
21     ]
22   },
23   "stages": [
24     {
25       "depends_on": [
26         "initial-setup"
27       ],
28       "description": "Data validation and preprocessing",
29       "execution_time": 125.5,
30       "name": "Validation Stage",
31       "requires_approval": true,
32       "retryable": true,
33       "state": "FAILED",
34       "traceback": "ValueError: Threshold parameter out of range at line 42",
35       "approval_threshold": 2,
36       "approvers": [
37         {
38           "time": "2024-01-14T15:45:00Z",
39           "user": "jane.doe@example.com"
40         }
41       ],
42       "child_workflows": [
43         "child-workflow-456"
44       ],
45       "input": {
46         "dataset": "Q4_financials.csv",
47         "parameters": {
48           "normalize": true,
49           "threshold": 0.75
50         }
51       },
52       "output": {
53         "valid_records": 987,
54         "invalid_records": 13
55       },
56       "rejecters": [
57         {
58           "time": "2024-01-14T16:00:00Z",
59           "user": "john.smith@example.com"
60         }
61       ],
62       "retry_count": 1,
63       "state_history": [
64         {
65           "state": "NOT_STARTED",
66           "time": "2024-01-14T14:00:00Z"
67         },
68         {
69           "state": "IN_PROGRESS",
70           "time": "2024-01-14T14:05:00Z"
71         },
72         {
73           "state": "FAILED",
74           "time": "2024-01-14T16:10:00Z"
75         }
76       ]
77     }
78   ],
79   "start_time": "2024-01-14T14:00:00Z",
80   "started_by": "alice.manager@example.com",
81   "status": "FAILED",
82   "workflow_input": {
83     "project": "Q4 Financial Analysis",
84     "owner": "alice.manager@example.com"
85   },
86   "workflow_type": "FinancialDataProcessing"
87 }

Get workflow execution details.

Path parameters

workflow_idstringRequired

Response

Successful Response

close_timedatetime or null

failed_stageboolean

hrefstringRead-only

Calculate URL to Temporal UI Workflow View.

idstring

pending_approvalboolean

resultany

search_attributesmap from strings to lists of strings or lists of integers or lists of doubles or lists of booleans or lists of datetimes

stageslist of objects

start_timedatetime

started_bystring

statusstring

workflow_inputany

workflow_typestring

Errors

422

Unprocessable Entity Error