List playbook runs in a space

GET

/spaces/:spaceId/playbook-runs

GET

/spaces/:spaceId/playbook-runs

$ curl https://api.cloudraker.com/spaces/spaceId/playbook-runs \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "id": "run_8f3a2b7c9d4e",
5       "spaceId": "space_12345",
6       "playbookId": "pb_98765",
7       "playbookVersion": 3,
8       "playbookName": "Incident Response",
9       "status": "running",
10       "fileScope": {
11         "mode": "space"
12       },
13       "taskProgress": {
14         "total": 12,
15         "completed": 5
16       },
17       "pendingApproval": {
18         "id": "approval_4567",
19         "kind": "pre",
20         "actionName": "Escalate to Tier 2",
21         "requestedAt": "2024-01-15T09:30:00Z"
22       },
23       "result": null,
24       "error": null,
25       "startedBy": "user_jdoe",
26       "createdAt": "2024-01-15T08:45:00Z",
27       "updatedAt": "2024-01-15T09:45:00Z",
28       "finishedAt": null
29     }
30   ],
31   "has_more": true
32 }

Lists playbook runs in this space, newest first. Authorization: space:read (org admins bypass); missing → 404. Query params: playbookId (filter to one playbook), status (one of running, waiting_approval, waiting_action, waiting_user, paused, completed, failed, cancelled — an unrecognized value returns 400 invalid_status), limit (1–100), and starting_after (opaque cursor = the id of the last run from the previous page). Returns { data: PlaybookRun[], has_more }; when has_more is true, page again using the last run id as starting_after.

Lists playbook runs in this space, newest first. Authorization: `space:read` (org admins bypass); missing → 404. Query params: `playbookId` (filter to one playbook), `status` (one of running, waiting_approval, waiting_action, waiting_user, paused, completed, failed, cancelled — an unrecognized value returns 400 `invalid_status`), `limit` (1–100), and `starting_after` (opaque cursor = the id of the last run from the previous page). Returns `{ data: PlaybookRun[], has_more }`; when `has_more` is true, page again using the last run id as `starting_after`.

Authentication

AuthorizationBearer

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

Path parameters

spaceIdstringRequired

Query parameters

playbookIdstringOptional>=1 character

Only runs of this playbook.

statusenumOptional

Run-status filter. An unrecognized value returns 400 invalid_status.

limitintegerOptional1-100Defaults to 20

Page size, 1–100. Defaults to 20.

starting_afterstringOptional>=1 character

Cursor: the id of the last run on the previous page.

Response

One page of playbook runs, newest first.

datalist of objects

has_moreboolean

Errors

400

Bad Request Error