Skip to content

API reference

List X accounts

account_list — List the X accounts this connection may use: account_id, @handle, label, login/session state, safety state, paused, VPS online, busy, and why work is waiting.

account_list · Reads saved data

List the X accounts this connection may use: account_id, @handle, label, login/session state, safety state, paused, VPS online, busy, and why work is waiting. Use account_id (or @handle) in every other tool.

REST GET /api/public/v1/accounts
MCP tool account_list
Permission needed view — Owner, Manager, Operator, Viewer
Scope group accounts:read
Group Core: X accounts, jobs, tool search
Shown up front in profiles every profile (core set)

Input

Field Type Required Description
search string (0–60 chars) No Filter by @handle or label.
cursor string (0–500 chars) No Opaque cursor from a previous page's next_cursor.
limit integer (1–200) No Page size (default 100, 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/accounts" \
  -H "Authorization: Bearer $XBUDDY_API_KEY"

Call over MCP

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

Errors you may get

Back to all operations