v11

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0112893437.0 KB

Users

Look up multiple users by IDs in one call

get/x/users/batch

Query parameters

idsstring required

Comma-separated numeric user IDs (1-100 values). Duplicate IDs are ignored while preserving first-seen order.

Response

Matched users plus reconciliation metadata for unavailable IDs.

has_next_pagefalse required

Batch lookups never paginate.

next_cursorstring required

Empty because batch lookups never paginate.

requested_countinteger required

Number of unique IDs requested.

processed_countinteger required

Number of requested IDs included in the lookup.

returned_countinteger required

Number of user profiles returned and charged.

unavailable_idsstring[] required

Processed IDs with no returned profile, in first-seen request order.

unprocessed_idsstring[] required

Requested IDs skipped because available credits limited processing. Retry these IDs after adding credits.

Example response

{
  "users": [
    {
      "id": "9876543210",
      "username": "elonmusk",
      "name": "Elon Musk"
    }
  ],
  "requested_count": 2,
  "processed_count": 2,
  "returned_count": 1,
  "unavailable_ids": [
    "1234567890"
  ],
  "unprocessed_ids": []
}