Skip to content

API reference

Search people

people_search — Search saved people of the workspace (leads, followers seen, people messaged) by @handle / name, list or tag, with do-not-contact flag and outreach state.

people_search · Reads saved data

Search saved people of the workspace (leads, followers seen, people messaged) by @handle / name, list or tag, with do-not-contact flag and outreach state.

REST GET /api/public/v1/people
MCP tool people_search
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
query string (0–60 chars) No
list_id string (uuid) No Only people in this lead list.
tag string (0–30 chars) 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/people" \
  -H "Authorization: Bearer $XBUDDY_API_KEY"

Call over MCP

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

Errors you may get

Back to all operations