v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Agent Playbooks

List agent playbooks

Lists reusable agent playbooks (instruction sets) visible to the caller. Requires a USER API key.

get/public/v1/playbooks

Query parameters

isActiveboolean

filterTextstring

Example:example

visibility'PRIVATE' | 'ACCOUNT'

Example:PRIVATE

Response

Paginated playbooks

totalnumber required

pagenumber required

pageSizenumber required

totalPagesnumber required

Example response

{
  "results": [
    {
      "id": 1,
      "name": "example",
      "description": "example",
      "instructions": "example",
      "tools": [
        "example"
      ],
      "accountId": 1,
      "createdByUserId": 1,
      "createdBy": {
        "id": 1,
        "firstName": "example",
        "lastName": "example",
        "email": "example",
        "avatar": "example"
      },
      "visibility": "PRIVATE",
      "createdAt": "example",
      "updatedAt": "example",
      "playbookConnectedAccounts": [
        {
          "id": 1,
          "connectedAccountId": 1,
          "selectedToolSlugs": [
            "example"
          ],
          "connectedAccount": {
            "id": 1,
            "toolkit": "example",
            "connectedEmail": "example",
            "alias": "example"
          }
        }
      ],
      "selectedRecordTypes": [
        {
          "recordTypeId": 1
        }
      ],
      "selectedCustomTools": [
        {
          "id": 1
        }
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}