Workflow

List Steps

GET

List all steps of a workflow

Path parameters

workflow_idstringRequired

Response

This endpoint returns an object

success

boolean

data

list of objectsOptional

Represents a WorkflowStep record

GET

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

200Retrieved

1 {
2   "success": true,
3   "data": [
4     {
5       "id": "id",
6       "order": 1,
7       "workflowId": "workflowId",
8       "createdAt": "2024-01-15T09:30:00Z",
9       "updatedAt": "2024-01-15T09:30:00Z",
10       "agentId": "agentId",
11       "workflow": {
12         "id": "id",
13         "name": "name",
14         "createdAt": "2024-01-15T09:30:00Z",
15         "updatedAt": "2024-01-15T09:30:00Z",
16         "apiUserId": "apiUserId"
17       },
18       "input": "input",
19       "output": "output",
20       "agent": {
21         "id": "id",
22         "type": "SUPERAGENT",
23         "name": "name",
24         "description": "description",
25         "isActive": true,
26         "createdAt": "2024-01-15T09:30:00Z",
27         "updatedAt": "2024-01-15T09:30:00Z",
28         "apiUserId": "apiUserId"
29       }
30     }
31   ]
32 }

Built with

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

1	{
2	"success": true,
3	"data": [
4	{
5	"id": "id",
6	"order": 1,
7	"workflowId": "workflowId",
8	"createdAt": "2024-01-15T09:30:00Z",
9	"updatedAt": "2024-01-15T09:30:00Z",
10	"agentId": "agentId",
11	"workflow": {
12	"id": "id",
13	"name": "name",
14	"createdAt": "2024-01-15T09:30:00Z",
15	"updatedAt": "2024-01-15T09:30:00Z",
16	"apiUserId": "apiUserId"
17	},
18	"input": "input",
19	"output": "output",
20	"agent": {
21	"id": "id",
22	"type": "SUPERAGENT",
23	"name": "name",
24	"description": "description",
25	"isActive": true,
26	"createdAt": "2024-01-15T09:30:00Z",
27	"updatedAt": "2024-01-15T09:30:00Z",
28	"apiUserId": "apiUserId"
29	}
30	}
31	]
32	}