Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

playbookId
string
required

Unique playbook identifier (integer)

playbookVersionId
string
required

Version number of the playbook (integer), as listed in the playbook's versions and in a case's playbook_version

Response

200 response

created_at
string<date-time>
required

Timestamp when the version was created

name
string
required

Name of the version

playbook_id
integer
required

Identifier of the playbook the version belongs to

state
string
required

State of the version: draft (not yet activated), active (handles the playbook's cases), draining (replaced by a newer version, still finishing its open cases) or inactive (finished draining)

updated_at
string<date-time>
required

Timestamp when the version was last updated

version_number
integer
required

Version number, unique within the playbook; cases running this version have it as playbook_version

description
string

Description of the version, null if not set

published_at
string<date-time>

Timestamp when the version was last published, null if it was never published