Skip to main content
POST
Python (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
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>
offset
integer<int32>
searchTerm
string | null
statusFilter
enum<string> | null

single-select; superseded by statuses when that is non-empty

Available options:
STATUS_UNKNOWN,
STATUS_ACTIVE,
STATUS_INACTIVE,
STATUS_EMPTY,
ALL_PLAYBOOKS
creatorMemberId
string | null

single-select; superseded by creator_member_ids when that is non-empty

sortBy
enum<string>
Available options:
SORT_FIELD_UNKNOWN,
SORT_FIELD_NAME,
SORT_FIELD_CREATED_AT,
SORT_FIELD_UPDATED_AT,
SORT_FIELD_SCHEDULE
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
onlySubscribed
boolean | null
sharedWithMe
boolean | null
includeSharedDrafts
boolean | null
statuses
enum<string>[]

Multi-select filters (union). Each supersedes its single-value counterpart when non-empty.

Available options:
STATUS_UNKNOWN,
STATUS_ACTIVE,
STATUS_INACTIVE,
STATUS_EMPTY,
ALL_PLAYBOOKS
creatorMemberIds
string[]

Response

Success

playbooks
Playbook · object[]
totalCount
integer<int32>