For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • DELDelete a revision
      • GETList all revisions for a workflow
      • PUTMake a revision the active revision for a workflow
LogoLogo
Scout DocsAccess Scout
EndpointsRevisions

List all revisions for a workflow

Beta
GET
https://api.scoutos.com/v2/workflows/:workflow_id/revisions
GET
/v2/workflows/:workflow_id/revisions
$curl https://api.scoutos.com/v2/workflows/workflow_id/revisions \
>     -H "Authorization: Bearer <token>"
1{
2  "data": [
3    {
4      "workflow_config": {
5        "workflow_display_name": "Customer Onboarding",
6        "workflow_schema_version": "1.0",
7        "workflow_img_url": "https://cdn.scoutos.com/workflows/onboarding.png",
8        "workflow_description": "Automated workflow for new customer onboarding process",
9        "blocks": [
10          {
11            "block_archetype_id": "email_sender_v2",
12            "block_display_name": "Welcome Email Sender",
13            "block_id": "block_001",
14            "block_inputs": {
15              "recipient_email": "newuser@example.com",
16              "email_template": "welcome_template"
17            },
18            "is_output": false,
19            "dependencies": [
20              {
21                "block_id": "block_000",
22                "ui": {
23                  "edge_type": "plusSign"
24                }
25              }
26            ],
27            "input_schema": {
28              "recipient_email": "string",
29              "email_template": "string"
30            },
31            "ui": {
32              "dimensions": {
33                "width": 240,
34                "height": 120
35              },
36              "position": {
37                "x": 100,
38                "y": 200
39              }
40            },
41            "trigger_config": {
42              "event": "user_signup"
43            },
44            "ignore_error": false,
45            "block_config": [
46              {
47                "id": "send_welcome_email",
48                "display_name": "Send Welcome Email",
49                "type": "boolean",
50                "default_value": true,
51                "value": true
52              }
53            ],
54            "output_schema": [
55              {
56                "status": "sent"
57              }
58            ]
59          }
60        ],
61        "notes": [
62          {
63            "id": "note_123",
64            "bgColor": "#FFF9C4",
65            "content": "Ensure email templates are updated quarterly.",
66            "author": "Jane Doe",
67            "ui": {
68              "dimensions": {
69                "width": 300,
70                "height": 150
71              },
72              "position": {
73                "x": 400,
74                "y": 100
75              }
76            }
77          }
78        ],
79        "placeholders": [
80          {
81            "block_id": "block_002",
82            "type": "triggerPlaceholder",
83            "ui": {
84              "dimensions": {
85                "width": 100,
86                "height": 100
87              },
88              "position": {
89                "x": 50,
90                "y": 50
91              }
92            },
93            "dependencies": [
94              {
95                "block_id": "block_001",
96                "ui": {
97                  "edge_type": "plusSign"
98                }
99              }
100            ]
101          }
102        ],
103        "tags": [
104          "onboarding",
105          "email",
106          "automation"
107        ],
108        "is_tool": false
109      },
110      "last_updated_at": "2024-04-10T14:45:00Z",
111      "created_at": "2024-01-15T09:30:00Z",
112      "created_by": {
113        "type": "user",
114        "details": {
115          "user_id": "user_789",
116          "org_id": "org_456",
117          "scout_organization_id": "scout_org_123",
118          "email": {
119            "work": "jane.doe@scoutos.com"
120          }
121        }
122      },
123      "last_updated_by": {
124        "type": "user",
125        "details": {
126          "user_id": "user_789",
127          "org_id": "org_456",
128          "scout_organization_id": "scout_org_123",
129          "email": {
130            "work": "jane.doe@scoutos.com"
131          }
132        }
133      },
134      "revision_id": "rev_20240410_01",
135      "workflow_id": "workflow_12345",
136      "workflow_key": "customer_onboarding_v2",
137      "is_draft": false
138    }
139  ]
140}
List all app revisions in the organization
Was this page helpful?
Previous

Make a revision the active revision for a workflow

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

workflow_idstringRequired

Response

Successful Response
datalist of objects

Errors

422
Unprocessable Entity Error