List all workflows

Beta

GET

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

GET

/v2/workflows

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

Try it

200Retrieved

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

List all workflows in the organization

Query parameters

sortstring or nullOptional

Field to sort by

directionstring or nullOptional

Sort in ascending or descending order

start_atstring or nullOptional

created_at to start at

limitinteger or nullOptional

Limit of records to return

querystring or nullOptional

Search query

tagsstring or nullOptional

Filter by tags

Response

Successful Response

datalist of objects

has_moreboolean

next_cursordatetime or null

List all workflows

Headers

Query parameters

Response

Errors