Skip to content

API reference

List playbooks

playbook_list — The workspace's saved playbooks (bundles of tasks applied to many accounts) with version and task count.

playbook_list · Reads saved data

The workspace's saved playbooks (bundles of tasks applied to many accounts) with version and task count.

REST GET /api/public/v1/playbooks
MCP tool playbook_list
Permission needed view — Owner, Manager, Operator, Viewer
Scope group automation:read
Group Tasks and playbooks
Shown up front in profiles Automation

Input

No input.

Result

Returned in the { data, meta } envelope, without creating a job on X. Lists include next_cursor and has_more.

Example

Call over REST

curl -X GET "https://reach-link-craft.lovable.app/api/public/v1/playbooks" \
  -H "Authorization: Bearer $XBUDDY_API_KEY"

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "playbook_list",
    "arguments": {}
  }
}

Errors you may get

Back to all operations