Skip to main content
GET https://xquik.com/api/v1/x/communities/{id}/members/search
Requested result counts are upper bounds for paid authenticated calls. Remaining credits may not cover the full page or ID list. If so, Xquik returns fewer results. If zero paid results are affordable, it returns 402 insufficient_credits.
1 credit per member returned · An answer without members is freeAll plans from $0.00012/credit · Supports guest paid reads

Find members by name

Use GET /x/communities/{id}/members/search to check whether people belong to a Community. The answer lists members whose name or username starts with q, in X’s order. It can leave out some matching members. Send the exact username for the best match. Each row is a full profile with its communityRole of Admin, Moderator or Member. A name that finds only people outside the Community returns an empty users list. That answer is free. Try the exact username when a common name finds no member. All results fit in 1 answer, so has_next_page is false. To list every member, use Community members.

Path parameters

Query parameters

User result filters

These filters apply before billing. Selective filters can return fewer rows.See user filters for every filter. Common ones are minFollowers, verifiedOnly, hasWebsite, hasEmail, bioContains, and locationContains.

Choose fields

Headers

Response

200 OK

400 Missing name or invalid Community ID

{ "error": "missing_query" } Send a name or username in q. A Community ID must be numeric, or the answer is invalid_community_id.

401 Unauthenticated

Anonymous requests get WWW-Authenticate: Bearer and a guest wallet checkout action. This is not a Payment challenge. Missing or invalid API key.

402 Payment required

Account keys get account options. Guest keys get guest top-up only. No checkout starts automatically. Confirm any payment action.

429 Rate limit exceeded

You exceeded your tier rate limit. Wait for the Retry-After header before retrying.

502 X API unavailable

The read service returned an error. Retry after a short delay.

Response examples

200 example

  • 400 { "error": "invalid_input", "message": "Invalid input. Check the request body." }
  • 401 { "error": "unauthenticated", "message": "Authentication required." }
  • 402 { "error": "insufficient_credits", "message": "Insufficient credits. Top up or subscribe to continue." }
  • 403 { "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." }
  • 424 { "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }
  • 502 { "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." }
  • 503 { "error": "x_api_unavailable", "message": "Xquik is busy right now. Retry shortly." }