Get Workflow

GET

///v1/workflow/:workflow_id

GET

/v1/workflow/:workflow_id

$ curl /v1/workflow/workflow_id \
>      -H "Authorization: Bearer <token>" \
>      -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     "CostEstimate": [
10       1250.75
11     ],
12     "IsCritical": [
13       true
14     ],
15     "Priority": [
16       "High"
17     ],
18     "RetryCount": [
19       3
20     ],
21     "ScheduledDate": [
22       "2024-01-10T08:00:00Z"
23     ]
24   },
25   "stages": [
26     {
27       "depends_on": [
28         "initialization"
29       ],
30       "description": "Data validation and preprocessing",
31       "execution_time": 120.5,
32       "name": "Validation Stage",
33       "requires_approval": true,
34       "retryable": true,
35       "state": "FAILED",
36       "traceback": "ValueError: Invalid data format in row 42",
37       "approval_threshold": 2,
38       "approvers": [
39         {
40           "time": "2024-01-15T08:45:00Z",
41           "user": "jane.doe@example.com"
42         }
43       ],
44       "child_workflows": [
45         "child-workflow-001"
46       ],
47       "input": {
48         "dataset": "customer_data.csv",
49         "validationRules": [
50           "rule1",
51           "rule2"
52         ]
53       },
54       "output": {
55         "invalidRecords": 50,
56         "validRecords": 950
57       },
58       "rejecters": [
59         {
60           "time": "2024-01-15T09:00:00Z",
61           "user": "john.smith@example.com"
62         }
63       ],
64       "retry_count": 1,
65       "state_history": [
66         {
67           "state": "NOT_STARTED",
68           "time": "2024-01-15T07:30:00Z"
69         },
70         {
71           "state": "IN_PROGRESS",
72           "time": "2024-01-15T07:45:00Z"
73         },
74         {
75           "state": "FAILED",
76           "time": "2024-01-15T09:30:00Z"
77         }
78       ]
79     }
80   ],
81   "start_time": "2024-01-15T07:30:00Z",
82   "started_by": "alice.manager@example.com",
83   "status": "FAILED",
84   "workflow_input": {
85     "jobId": "job-789",
86     "parameters": {
87       "notifyOnCompletion": true,
88       "runMode": "full"
89     }
90   },
91   "workflow_type": "DataProcessingWorkflow"
92 }

Get workflow execution details.

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.

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