Skip to main content
GET
Search X community members by name or username
Requested result counts are upper bounds for paid authenticated calls. When remaining credits cannot cover the full page or ID list, 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 free · All 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. It works like the search box on x.com’s members page. X checks up to 10 accounts whose name or username starts with q. The answer holds the members among them, in X’s order. Each row is a full profile with its communityRole: 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

string
required
Community ID (numeric string), such as 1493446837214187523.

Query parameters

string
required
Name or username to find members by, such as marckohlbrugge. A leading @ is dropped. Alias: query.

User result filters

These filters apply before billing. Selective filters can return fewer rows.
integer
Require this minimum follower count. Filtering happens before billing.
integer
Allow this maximum follower count. Missing counts pass this filter.
integer
Require this minimum following count.
integer
Allow this maximum following count. Missing counts pass this filter.
integer
Require this minimum post count.
integer
Allow this maximum post count. Missing counts pass this filter.
integer
Require this minimum account age in days.
boolean
When true, only return verified profiles.
string
Match the exact verification type.
boolean
When true, require a profile website.
boolean
When true, require a profile location.
string
Require every comma-separated or line-separated bio term.
string
Require this text in the profile location.
string
Require this text in the username.

Headers

string
Full account key. Sessions and OAuth also work.
string
Bearer xq_your_guest_key_here for paid_reads.

Response

200 OK

object[]
Members X found for the name, in X’s order. Each holds the same profile fields as Community members, such as id, username, name, followers & verified.
string
The member’s role in the Community: Admin, Moderator or Member.
boolean
Always false. X sends all results in 1 answer.
string
Always an empty string.

400 Missing name or invalid Community ID

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.