Sign in

v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-174421106.5 KB
Playbooks

List all playbooks

Retrieve a paged list of playbooks, filtered by team, and sorted by title, number of stages or number of steps.

get/plugins/playbooks/api/v0/playbooks

Query parameters

team_idstring required

ID of the team to filter by.

pageinteger

Zero-based index of the page to request.

per_pageinteger

Number of playbooks to return per page.

sort'title' | 'stages' | 'steps'

Field to sort the returned playbooks by title, number of stages or total number of steps.

direction'desc' | 'asc'

Direction (ascending or descending) followed by the sorting of the playbooks.

with_archivedboolean

Includes archived playbooks in the result.

Response

A paged list of playbooks.

total_countinteger

The total number of playbooks in the list, regardless of the paging.

page_countinteger

The total number of pages. This depends on the total number of playbooks in the database and the per_page parameter sent with the request.

has_moreboolean

A boolean describing whether there are more pages after the currently returned.

Example response

{
  "total_count": 305,
  "page_count": 2,
  "has_more": true,
  "items": [
    {
      "id": "iz0g457ikesz55dhxcfa0fk9yy",
      "title": "Cloud PlaybookRuns",
      "description": "A playbook to follow when there is a playbook run regarding the availability of the cloud service.",
      "team_id": "p03rbi6viyztysbqnkvcqyel2i",
      "create_public_playbook_run": true,
      "create_at": 1602235338837,
      "num_stages": 3,
      "num_steps": 18,
      "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"
            }
          ]
        }
      ],
      "member_ids": [
        "ilh6s1j4yefbdhxhtlzt179i6m"
      ],
      "channel_name_template": "Incident - {SEQ}"
    }
  ]
}