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

API reference

List campaigns

campaign_list — Outreach / care campaigns: name, goal, status (draft, running, paused, stopped), accounts, new people per day, entry source, and the funnel (enrolled, replied, finished).

Markdown version

campaign_list · Reads saved data

Outreach / care campaigns: name, goal, status (draft, running, paused, stopped), accounts, new people per day, entry source, and the funnel (enrolled, replied, finished).
REST GET /api/public/v1/campaigns
MCP tool campaign_list
Permission needed view — Owner, Manager, Operator, Viewer
Scope group automation:read
Group Campaigns
Shown up front in profiles Automation

Input

Field Type Required Description
status draft · running · paused · stopped No

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/campaigns" \
  -H "Authorization: Bearer $XBUDDY_API_KEY"

Call over MCP

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

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

Back to all operations