v46

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

Playbooks

Get a playbook

get/plugins/playbooks/api/v0/playbooks/{id}

Path parameters

idstring required

Example:iz0g457ikesz55dhxcfa0fk9yy

ID of the playbook to retrieve.

Response

Playbook.

idstring

A unique, 26 characters long, alphanumeric identifier for the playbook.

titlestring

The title of the playbook.

descriptionstring

The description of the playbook.

team_idstring

The identifier of the team where the playbook is in.

create_public_playbook_runboolean

A boolean indicating whether the playbook runs created from this playbook should be public or private.

create_atinteger

The playbook creation timestamp, formatted as the number of milliseconds since the Unix epoch.

delete_atinteger

The playbook deletion timestamp, formatted as the number of milliseconds since the Unix epoch. It equals 0 if the playbook is not deleted.

num_stagesinteger

The number of stages defined in this playbook.

num_stepsinteger

The total number of steps from all the stages defined in this playbook.

member_idsstring[]

The identifiers of all the users that are members of this playbook.

channel_name_templatestring

A template used to derive the channel name and the run name/title when a run is created from this playbook. May reference property fields and system tokens such as {SEQ}.

channel_name_template_lockedboolean

When true, the channel_name_template always overrides the supplied name when creating a run. When false (the default), the template is only a suggested default and the caller may supply their own name.

Example response

{
  "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}"
}