Skip to main content
POST
ListPlaybooks
v2 available: See GET /v2/playbooks for the REST-native version of this endpoint.

Authorizations

Authorization
string
header
required

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

Headers

Connect-Protocol-Version
enum<number>
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
memberOnly
boolean
limit
integer<int32>
Required range: 0 <= x <= 100
offset
integer<int32>
Required range: x >= 0
searchTerm
string | null
statusFilter
enum<string> | null
Available options:
STATUS_UNKNOWN,
STATUS_ACTIVE,
STATUS_INACTIVE,
STATUS_EMPTY,
ALL_PLAYBOOKS
creatorMemberId
string | null
sortBy
enum<string>
Available options:
SORT_FIELD_UNKNOWN,
SORT_FIELD_NAME,
SORT_FIELD_CREATED_AT,
SORT_FIELD_UPDATED_AT
sortDirection
enum<string>

Common enum for sort direction used across multiple services

Available options:
SORT_DIRECTION_UNKNOWN,
SORT_DIRECTION_ASC,
SORT_DIRECTION_DESC
subscribedFirst
boolean | null

Response

Success

playbooks
Playbook · object[]
totalCount
integer<int32>