Skip to navigation

List playbook runs in a space

View as Markdown

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.

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