v1

latestOpenAPI 3.1.02026-07-263971,2281.1 MB

PlaybookService

GetPlaybooks

post/textql.rpc.public.playbook.PlaybookService/GetPlaybooks

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

memberOnlyboolean

limitinteger

offsetinteger

searchTermstring nullable

statusFilter'STATUS_UNKNOWN' | 'STATUS_ACTIVE' | 'STATUS_INACTIVE' | 'STATUS_EMPTY' | 'ALL_PLAYBOOKS'

creatorMemberIdstring nullable

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

sortBy'SORT_FIELD_UNKNOWN' | 'SORT_FIELD_NAME' | 'SORT_FIELD_CREATED_AT' | 'SORT_FIELD_UPDATED_AT' | 'SORT_FIELD_SCHEDULE'

sortDirection'SORT_DIRECTION_UNKNOWN' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'

Common enum for sort direction used across multiple services

subscribedFirstboolean nullable

onlySubscribedboolean nullable

sharedWithMeboolean nullable

includeSharedDraftsboolean nullable

statusesTextqlRpcPublicPlaybookPlaybookStatus[]

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

creatorMemberIdsstring[]

Response

Success

totalCountinteger

Example response

{
  "playbooks": [
    {
      "createdAt": "2023-01-15T01:30:15.01Z",
      "updatedAt": "2023-01-15T01:30:15.01Z",
      "duplicatedAt": "2023-01-15T01:30:15.01Z"
    }
  ]
}