Search
User search
Returns Users that match a search query.
GET
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
TThe the query string by which to query for users.
The maximum number of results.
Required range:
1 <= x <= 1000
This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
Minimum length:
1
A comma separated list of User fields to display.
Available options:
affiliation
, confirmed_email
, connection_status
, created_at
, description
, entities
, id
, is_identity_verified
, location
, most_recent_tweet_id
, name
, parody
, pinned_tweet_id
, profile_banner_url
, profile_image_url
, protected
, public_metrics
, receives_your_dm
, subscription
, subscription_type
, url
, username
, verified
, verified_followers_count
, verified_type
, withheld
Example:
[
"affiliation",
"confirmed_email",
"connection_status",
"created_at",
"description",
"entities",
"id",
"is_identity_verified",
"location",
"most_recent_tweet_id",
"name",
"parody",
"pinned_tweet_id",
"profile_banner_url",
"profile_image_url",
"protected",
"public_metrics",
"receives_your_dm",
"subscription",
"subscription_type",
"url",
"username",
"verified",
"verified_followers_count",
"verified_type",
"withheld"
]
A comma separated list of fields to expand.
Available options:
affiliation.user_id
, most_recent_tweet_id
, pinned_tweet_id
Example:
[
"affiliation.user_id",
"most_recent_tweet_id",
"pinned_tweet_id"
]
A comma separated list of Tweet fields to display.
Available options:
article
, attachments
, author_id
, card_uri
, community_id
, context_annotations
, conversation_id
, created_at
, display_text_range
, edit_controls
, edit_history_tweet_ids
, entities
, geo
, id
, in_reply_to_user_id
, lang
, media_metadata
, non_public_metrics
, note_tweet
, organic_metrics
, possibly_sensitive
, promoted_metrics
, public_metrics
, referenced_tweets
, reply_settings
, scopes
, source
, text
, withheld
Example:
[
"article",
"attachments",
"author_id",
"card_uri",
"community_id",
"context_annotations",
"conversation_id",
"created_at",
"display_text_range",
"edit_controls",
"edit_history_tweet_ids",
"entities",
"geo",
"id",
"in_reply_to_user_id",
"lang",
"media_metadata",
"non_public_metrics",
"note_tweet",
"organic_metrics",
"possibly_sensitive",
"promoted_metrics",
"public_metrics",
"referenced_tweets",
"reply_settings",
"scopes",
"source",
"text",
"withheld"
]
Response
200
application/json
The request has succeeded.
The response is of type object
.