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

API reference

Get a batch

x_batch_get — Totals (queued / held / succeeded / failed / unknown / cancelled / rejected) and one row per item with its job id, status and error.

Markdown version

x_batch_get · Reads saved data

Totals (queued / held / succeeded / failed / unknown / cancelled / rejected) and one row per item with its job id, status and error. Pages of 200 items.
REST GET /api/public/v1/batches/{batch_id}
MCP tool x_batch_get
Permission needed view — Owner, Manager, Operator, Viewer
Scope group x:engage
Group Actions on X
Shown up front in profiles Automation, Infrastructure

Input

Field Type Required Description
batch_id string (uuid) Yes Batch id from x_batch.
cursor string (0–500 chars) No Opaque cursor from a previous page's next_cursor.

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

Call over MCP

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