Get a workflow by ID

Beta

GET

https://api-prod.scoutos.com/v2/workflows/:workflow_id

GET

/v2/workflows/:workflow_id

1 from scoutos import Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.workflows.get(
7     workflow_id="workflow_id",
8 )

Try it

1 {
2   "data": {
3     "workflow_config": {
4       "workflow_display_name": "Untitled",
5       "workflow_schema_version": "1.0",
6       "workflow_img_url": "workflow_img_url",
7       "workflow_description": "workflow_description",
8       "blocks": [
9         {
10           "block_archetype_id": "block_archetype_id",
11           "block_display_name": "block_display_name",
12           "block_id": "block_id",
13           "block_inputs": {},
14           "is_output": false,
15           "dependencies": [
16             {
17               "block_id": "block_id",
18               "ui": {
19                 "edge_type": "plusSign"
20               }
21             }
22           ],
23           "input_schema": {},
24           "ui": {
25             "dimensions": {
26               "width": 0,
27               "height": 0
28             },
29             "position": {
30               "x": 0,
31               "y": 0
32             }
33           },
34           "trigger_config": {},
35           "ignore_error": false
36         }
37       ],
38       "notes": [
39         {
40           "id": "id",
41           "bgColor": "bgColor",
42           "content": "",
43           "author": "Your name",
44           "ui": {
45             "dimensions": {
46               "width": 0,
47               "height": 0
48             },
49             "position": {
50               "x": 0,
51               "y": 0
52             }
53           }
54         }
55       ],
56       "placeholders": [
57         {
58           "block_id": "block_id",
59           "type": "triggerPlaceholder",
60           "ui": {
61             "dimensions": {
62               "width": 0,
63               "height": 0
64             },
65             "position": {
66               "x": 0,
67               "y": 0
68             }
69           },
70           "dependencies": [
71             {
72               "block_id": "block_id",
73               "ui": {
74                 "edge_type": "plusSign"
75               }
76             }
77           ]
78         }
79       ],
80       "tags": [
81         "tags"
82       ],
83       "is_tool": false
84     },
85     "workflow_key": "workflow_key",
86     "last_updated_at": "last_updated_at",
87     "created_at": "created_at",
88     "created_by": {
89       "type": "user",
90       "details": {
91         "user_id": "user_id",
92         "org_id": "org_id",
93         "scout_organization_id": "scout_organization_id",
94         "email": {}
95       }
96     },
97     "last_updated_by": {
98       "type": "user",
99       "details": {
100         "user_id": "user_id",
101         "org_id": "org_id",
102         "scout_organization_id": "scout_organization_id",
103         "email": {}
104       }
105     },
106     "revision_id": "revision_id",
107     "workflow_id": "workflow_id",
108     "is_draft": false
109   }
110 }

Fetch app configuration by ID.

Path parameters

workflow_idstringRequired

Response

Successful Response

dataobject

Get a workflow by ID

Path parameters

Headers

Response

Errors