List

GET

List all workflows

Query parameters

skipintegerOptional

takeintegerOptional

Response

This endpoint returns an object.

successboolean

total_pagesinteger

datalist of objectsOptional

Represents a Workflow record

GET

1 curl https://api.beta.superagent.sh/api/v1/workflows \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "success": true,
3   "data": [
4     {
5       "id": "id",
6       "name": "name",
7       "description": "description",
8       "createdAt": "2024-01-15T09:30:00Z",
9       "updatedAt": "2024-01-15T09:30:00Z",
10       "steps": [
11         {
12           "id": "id",
13           "order": 1,
14           "workflowId": "workflowId",
15           "createdAt": "2024-01-15T09:30:00Z",
16           "updatedAt": "2024-01-15T09:30:00Z",
17           "agentId": "agentId"
18         }
19       ],
20       "apiUserId": "apiUserId",
21       "apiUser": {
22         "id": "id",
23         "createdAt": "2024-01-15T09:30:00Z",
24         "updatedAt": "2024-01-15T09:30:00Z"
25       },
26       "workflowConfigs": [
27         {
28           "id": "id",
29           "createdAt": "2024-01-15T09:30:00Z",
30           "updatedAt": "2024-01-15T09:30:00Z",
31           "workflowId": "workflowId"
32         }
33       ]
34     }
35   ],
36   "total_pages": 1
37 }

Built with

1	curl https://api.beta.superagent.sh/api/v1/workflows \
2	-H "Authorization: Bearer <token>"

1	{
2	"success": true,
3	"data": [
4	{
5	"id": "id",
6	"name": "name",
7	"description": "description",
8	"createdAt": "2024-01-15T09:30:00Z",
9	"updatedAt": "2024-01-15T09:30:00Z",
10	"steps": [
11	{
12	"id": "id",
13	"order": 1,
14	"workflowId": "workflowId",
15	"createdAt": "2024-01-15T09:30:00Z",
16	"updatedAt": "2024-01-15T09:30:00Z",
17	"agentId": "agentId"
18	}
19	],
20	"apiUserId": "apiUserId",
21	"apiUser": {
22	"id": "id",
23	"createdAt": "2024-01-15T09:30:00Z",
24	"updatedAt": "2024-01-15T09:30:00Z"
25	},
26	"workflowConfigs": [
27	{
28	"id": "id",
29	"createdAt": "2024-01-15T09:30:00Z",
30	"updatedAt": "2024-01-15T09:30:00Z",
31	"workflowId": "workflowId"
32	}
33	]
34	}
35	],
36	"total_pages": 1
37	}