playbooks

List Playbooks

Changed on

List automations (playbooks) in the workspace.

Requires the sequences:read scope on the API key.

get/v1/playbooks

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/playbooks
  • Auth: HTTP bearer

Query parameters

pageinteger
sizeinteger
status'DRAFT' | 'ENABLED' | 'PAUSED'

Filter playbooks by lifecycle status.

searchstring nullable

Search playbooks by name substring.

Response

Successful Response

total_countinteger required

Total number of records matching the query.

total_pagesinteger required

Total number of pages.

has_moreboolean required

Whether more pages remain after the current one.

Changes

  • 3535956158d8Revision changes
    • warning

      added the new ACTIVITY enum value to the // response property for the response status

  • 793d8d4affc7Revision changes
    • warning

      added the new LEAD_IMPORT_COMPLETED enum value to the // response property for the response status