List all playbook runs
Retrieve a paged list of playbook runs, filtered by team, status, owner, name and/or members, and sorted by ID, name, status, creation date, end date, team or owner ID.
Query parameters
ID of the team to filter by.
Zero-based index of the page to request.
Number of playbook runs to return per page.
Field to sort the returned playbook runs by.
Direction (ascending or descending) followed by the sorting of the playbook runs.
The returned list will contain only the playbook runs with the specified statuses.
The returned list will contain only the playbook runs commanded by this user. Specify "me" for current user.
The returned list will contain only the playbook runs for which the given user is a participant. Specify "me" for current user.
The returned list will contain only the playbook runs whose name contains the search term.
The returned list will contain only the playbook runs associated with this channel ID.
When set to true, only active runs (with EndAt = 0) are returned. When false or omitted, both active and ended runs are returned.
Return only PlaybookRuns created/modified since the given timestamp (in milliseconds).
Response
A paged list of playbook runs.
Example response
{
"total_count": 305,
"page_count": 2,
"has_more": true,
"items": [
{
"id": "mx3xyzdojfgyfdx8sc8of1gdme",
"name": "Server down in EU cluster",
"summary": "There is one server in the EU cluster that is not responding since April 12.",
"owner_user_id": "bqnbdf8uc0a8yz4i39qrpgkvtg",
"team_id": "61ji2mpflefup3cnuif80r5rde",
"channel_id": "hwrmiyzj3kadcilh3ukfcnsbt6",
"create_at": 1606807976289,
"active_stage": 1,
"active_stage_title": "Triage issue",
"post_id": "b2ntfcrl4ujivl456ab4b3aago",
"playbook_id": "0y4a0ntte97cxvfont8y84wa7x",
"checklists": [
{
"id": "6f6nsgxzoq84fqh1dnlyivgafd",
"title": "Triage issue",
"items": [
{
"id": "6f6nsgxzoq84fqh1dnlyivgafd",
"title": "Gather information from customer.",
"state": "closed",
"state_modified": 1607774621321,
"assignee_id": "pisdatkjtdlkdhht2v4inxuzx1",
"assignee_modified": 1608897821125,
"command": "/opsgenie on-call",
"command_last_run": 1608552221019,
"description": "Ask the customer for more information in [Zendesk](https://www.zendesk.com/).",
"delete_at": 1607774621321,
"due_date": 1607774621321,
"update_at": 1607774621321,
"condition_id": "6f6nsgxzoq84fqh1dnlyivgafd",
"condition_action": "hidden",
"condition_reason": "Severity is Critical AND Status is not Closed"
}
]
}
]
}
]
}