Skip to content
X-Buddy
Tiếng Việt

API reference

Get a playbook

playbook_get — One playbook with every task (type, name, settings, schedule, enabled) and its revision.

Markdown version

playbook_get · Reads saved data

One playbook with every task (type, name, settings, schedule, enabled) and its revision.
REST GET /api/public/v1/playbooks/{playbook_id}
MCP tool playbook_get
Permission needed view — Owner, Manager, Operator, Viewer
Scope group automation:read
Group Tasks and playbooks
Shown up front in profiles Automation

Input

Field Type Required Description
playbook_id string (uuid) Yes Playbook id.

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/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $XBUDDY_API_KEY"

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "playbook_get",
    "arguments": {
      "playbook_id": "00000000-0000-4000-8000-000000000001"
    }
  }
}

Errors you may get

Code HTTP Retryable
unauthorized 401 No
key_expired 401 No
integration_revoked 401 No
connection_not_linked 403 No
integration_paused 403 No
workspace_integrations_paused 403 No
integration_authorization_lost 403 No
workspace_suspended 403 No
forbidden 403 No
invalid_input 422 No
rate_limited 429 Yes
internal 500 Yes
not_found 404 No

Back to all operations