Skip to content

API reference

Get a person

people_get — One saved person: profile, tags, lists, do-not-contact, campaigns they are in, and what each account did with them.

people_get · Reads saved data

One saved person: profile, tags, lists, do-not-contact, campaigns they are in, and what each account did with them.

REST GET /api/public/v1/people/{person}
MCP tool people_get
Permission needed view — Owner, Manager, Operator, Viewer
Scope group audience:read
Group Contacts and lists
Shown up front in profiles Operate X accounts, Contacts & lists

Input

Field Type Required Description
person string (1–60 chars) Yes X-Buddy person id, @handle or #userId.

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/people/%40example_person" \
  -H "Authorization: Bearer $XBUDDY_API_KEY"

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "people_get",
    "arguments": {
      "person": "@example_person"
    }
  }
}

Errors you may get

Back to all operations