Workflow

List

GET
List all workflows

Query parameters

skipintegerOptional
takeintegerOptional

Response

This endpoint returns an object
success
boolean
total_pages
integer
data
list of objectsOptional
Represents a Workflow record
GET
1curl https://api.beta.superagent.sh/api/v1/workflows \
2 -H "Authorization: Bearer <token>"
200Retrieved
1{
2 "success": true,
3 "total_pages": 1,
4 "data": [
5 {
6 "id": "id",
7 "name": "name",
8 "createdAt": "2024-01-15T09:30:00Z",
9 "updatedAt": "2024-01-15T09:30:00Z",
10 "apiUserId": "apiUserId",
11 "description": "description",
12 "steps": [
13 {
14 "id": "id",
15 "order": 1,
16 "workflowId": "workflowId",
17 "createdAt": "2024-01-15T09:30:00Z",
18 "updatedAt": "2024-01-15T09:30:00Z",
19 "agentId": "agentId"
20 }
21 ],
22 "apiUser": {
23 "id": "id",
24 "createdAt": "2024-01-15T09:30:00Z",
25 "updatedAt": "2024-01-15T09:30:00Z"
26 },
27 "workflowConfigs": [
28 {
29 "id": "id",
30 "createdAt": "2024-01-15T09:30:00Z",
31 "updatedAt": "2024-01-15T09:30:00Z",
32 "workflowId": "workflowId"
33 }
34 ]
35 }
36 ]
37}