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(
7     sort="sort",
8     direction="direction",
9     start_at="start_at",
10     limit=1,
11     query="query",
12     tags="tags",
13 )

Try it

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

List all workflows in the organization

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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 nullOptionalDefaults to 12

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_cursorstring or nullformat: "date-time"

Authentication

Query parameters

Response

Errors