Skip to main content
GET
Search Users

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowAuthorization Code
Authorization URL
https://api.x.com/2/oauth2/authorize
Token URL
https://api.x.com/2/oauth2/token
Scopes2
tweet.read
View all posts you can see, including those from protected accounts.
users.read
View any account you can see, including protected accounts.

Query Parameters

query
string
required
Pattern: ^[A-Za-z0-9_' ]{1,50}$
max_results
integer<int32>
default:100
Required range: 1 <= x <= 1000
next_token
string
Minimum string length: 1
user.fields
enum<string>[]

A comma separated list of User fields to display. The fields available for a User object.

Minimum array length: 1
Available options:
confirmed_email,
connection_status,
created_at,
description,
entities,
id,
is_identity_verified,
location,
name,
parody,
profile_banner_url,
profile_image_url,
protected,
public_metrics,
receives_your_dm,
subscriber_count,
subscribes_to_you,
subscription,
subscription_type,
url,
username,
verified,
verified_followers_count,
verified_type,
withheld
expansions
enum<string>[]

A comma separated list of fields to expand.

Minimum array length: 1
Available options:
affiliation,
most_recent_post_id,
pinned_post_id
post.fields
enum<string>[]

A comma separated list of Post fields to display. The fields available for a Post object.

Minimum array length: 1
Available options:
article,
article_title,
attachments,
card_uri,
community_id,
context_annotations,
conversation_id,
created_at,
display_text_range,
edit_controls,
entities,
geo,
id,
lang,
matched_media_notes,
media_metadata,
non_public_metrics,
note_post,
note_request_suggestions,
organic_metrics,
paid_partnership,
possibly_sensitive,
promoted_metrics,
public_metrics,
reply_settings,
scopes,
source,
suggested_source_links,
suggested_source_links_with_counts,
text,
withheld

Response

The request has succeeded.

data
object[]
errors
object[]
includes
object
meta
object