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

API reference

People in a campaign

campaign_list_people — People enrolled in a campaign: person, account, current step, status, result, replied / followed back, next run.

Markdown version

campaign_list_people · Reads saved data

People enrolled in a campaign: person, account, current step, status, result, replied / followed back, next run.
REST GET /api/public/v1/campaigns/{campaign_id}/people
MCP tool campaign_list_people
Permission needed view — Owner, Manager, Operator, Viewer
Scope group automation:read
Group Campaigns
Shown up front in profiles Automation

Input

Field Type Required Description
campaign_id string (uuid) Yes Campaign id.
status active · waiting · done · stopped No
cursor string (0–500 chars) No Opaque cursor from a previous page's next_cursor.
limit integer (1–200) No Page size (default 50, max 200).

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

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "campaign_list_people",
    "arguments": {
      "campaign_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