X (Twitter) Users API
Endpoints related to retrieving, managing relationships of Users
X (Twitter) Users API is one of 23 APIs that X (Twitter) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.
This API exposes 45 operations across 40 paths, and defines 112 schemas. It is described by OpenAPI 3.0.0, at version 2.161.
Requests are made against a single base URL, https://api.x.com.
45 operations
40 paths
112 schemas
7 DELETE29 GET9 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
X (Twitter) Users API declares
3 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
It supports OAuth 2.0 (OAuth2UserToken) using the authorizationCode flow, exposing 21 scopes.
It uses HTTP oauth authentication (UserToken).
Paths & Operations 45
Across 40 paths, the API surfaces 45 operations — 7 DELETE, 29 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.
Users 45
Endpoints related to retrieving, managing relationships of Users
GET
/2/lists/{id}/followers
X Get List Followers
GET
/2/lists/{id}/members
X Get List Members
GET
/2/tweets/{id}/liking_users
X Get Liking Users
GET
/2/tweets/{id}/retweeted_by
X Get Reposted by
GET
/2/users
X Get Users by IDs
GET
/2/users/by
X Get Users by Usernames
GET
/2/users/by/username/{username}
X Get User by Username
GET
/2/users/me
X Get My User
GET
/2/users/public_keys
X Get Public Keys for Multiple Users
GET
/2/users/reposts_of_me
X Get Reposts of Me
GET
/2/users/search
X Search Users
GET
/2/users/{id}
X Get User by ID
GET
/2/users/{id}/affiliates
X Get Affiliates
GET
/2/users/{id}/blocking
X Get Blocking
GET
/2/users/{id}/bookmarks
X Get Bookmarks
POST
/2/users/{id}/bookmarks
X Create Bookmark
GET
/2/users/{id}/bookmarks/folders
X Get Bookmark Folders
GET
/2/users/{id}/bookmarks/folders/{folder_id}
X Get Bookmarks by Folder ID
DELETE
/2/users/{id}/bookmarks/{tweet_id}
X Delete Bookmark
POST
/2/users/{id}/dm/block
X Block DMs
POST
/2/users/{id}/dm/unblock
X Unblock DMs
GET
/2/users/{id}/followed_lists
X Get Followed Lists
POST
/2/users/{id}/followed_lists
X Follow List
DELETE
/2/users/{id}/followed_lists/{list_id}
X Unfollow List
GET
/2/users/{id}/followers
X Get Followers
GET
/2/users/{id}/following
X Get Following
POST
/2/users/{id}/following
X Follow User
GET
/2/users/{id}/liked_tweets
X Get Liked Posts
POST
/2/users/{id}/likes
X Like Post
DELETE
/2/users/{id}/likes/{tweet_id}
X Unlike Post
GET
/2/users/{id}/list_memberships
X Get List Memberships
GET
/2/users/{id}/mentions
X Get Mentions
GET
/2/users/{id}/muting
X Get Muting
POST
/2/users/{id}/muting
X Mute User
GET
/2/users/{id}/owned_lists
X Get Owned Lists
GET
/2/users/{id}/pinned_lists
X Get Pinned Lists
POST
/2/users/{id}/pinned_lists
X Pin List
DELETE
/2/users/{id}/pinned_lists/{list_id}
X Unpin List
GET
/2/users/{id}/public_keys
X Get User Public Keys
POST
/2/users/{id}/retweets
X Repost Post
DELETE
/2/users/{id}/retweets/{source_tweet_id}
X Unrepost Post
GET
/2/users/{id}/timelines/reverse_chronological
X Get Timeline
GET
/2/users/{id}/tweets
X Get Posts
DELETE
/2/users/{source_user_id}/following/{target_user_id}
X Unfollow User
DELETE
/2/users/{source_user_id}/muting/{target_user_id}
X Unmute User
Schemas 112
The contract defines 112 schemas that model the data the API accepts and returns. The most detailed are Tweet (29 properties), User (21 properties), UrlFields (9 properties), Place (8 properties). Each schema is shown below with its type and property counts.
List
object
A X List is a curated group of accounts.
8 properties
2 required
Get2UsersIdAffiliatesResponse
object
4 properties
PollId
string
Unique identifier of this poll.
Media
object
4 properties
1 required
ListPinnedResponse
object
2 properties
UsersFollowingCreateRequest
object
1 property
1 required
Geo
object
4 properties
3 required
Get2UsersIdTweetsResponse
object
4 properties
PlaceId
string
The identifier for this place.
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties
1 required
PreviousToken
string
The previous token.
MentionFields
object
Represent the portion of text recognized as a User mention, and its start and end position within the text.
2 properties
1 required
HashtagEntity
Get2UsersPublicKeysResponse
object
2 properties
Get2UsersIdFollowingResponse
object
4 properties
Get2UsersIdResponse
object
3 properties
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
Get2UsersIdLikedTweetsResponse
object
4 properties
Get2UsersByResponse
object
3 properties
Topic
object
The topic of a Space, as selected by its creator.
3 properties
2 required
UsersLikesCreateRequest
object
1 property
1 required
UsersDMBlockCreateResponse
object
2 properties
Place
object
8 properties
2 required
BookmarkMutationResponse
object
2 properties
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties
1 required
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
PollOption
object
Describes a choice in a Poll object.
3 properties
3 required
CashtagEntity
PaginationToken32
string
A base32 pagination token.
Get2TweetsIdRetweetedByResponse
object
4 properties
ListUnpinResponse
object
2 properties
Get2UsersResponse
object
3 properties
Get2UsersIdListMembershipsResponse
object
4 properties
UsersRetweetsCreateResponse
object
2 properties
UsersLikesDeleteResponse
object
2 properties
UserSearchQueryVnext
string
The the search string by which to query for users.
PublicKey
object
Public key information for Chat encryption
4 properties
NoteTweetText
string
The note content of the Tweet.
OldestId
string
The oldest id in this response.
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties
2 required
Get2UsersIdOwnedListsResponse
object
4 properties
UserIdMatchesAuthenticatedUser
string
Unique identifier of this User. The value must be the same as the authenticated user.
PollOptionLabel
string
The text of a poll choice.
Get2ListsIdMembersResponse
object
4 properties
PlaceType
string
CommunityId
string
The unique identifier of this Community.
Get2UsersIdPublicKeysResponse
object
2 properties
Get2UsersIdBlockingResponse
object
4 properties
DisplayTextRange
array
Represent a boundary range (start and end zero-based indices) for the portion of text that is displayed for a post. start must be smaller than end. The start i…
User
object
The X User object.
21 properties
3 required
MentionEntity
Get2UsersIdBookmarksResponse
object
4 properties
FullTextEntities
object
5 properties
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties
1 required
UsersFollowingDeleteResponse
object
2 properties
Tweet
object
29 properties
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties
2 required
Get2ListsIdFollowersResponse
object
4 properties
TweetWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
3 properties
2 required
Url
string
A validly formatted URL.
Expansions
object
6 properties
Get2UsersIdFollowedListsResponse
object
4 properties
EntityIndicesInclusiveInclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties
2 required
TweetText
string
The content of the Tweet.
Get2UsersByUsernameUsernameResponse
object
3 properties
Get2UsersIdMutingResponse
object
4 properties
Get2UsersIdTimelinesReverseChronologicalResponse
object
4 properties
PaginationTokenLong
string
A 'long' pagination token.
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties
1 required
UsersFollowingCreateResponse
object
2 properties
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
Get2UsersMeResponse
object
3 properties
ListId
string
The unique identifier of this List.
UsersDMUnBlockCreateResponse
object
2 properties
PaginationToken36
string
A base36 pagination token.
HttpStatusCode
integer
HTTP Status Code.
Get2TweetsIdLikingUsersResponse
object
4 properties
EntityIndicesInclusiveExclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties
2 required
MuteUserMutationResponse
object
2 properties
TweetId
string
Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
MediaKey
string
The Media Key identifier for this attachment.
Error
object
2 properties
2 required
Get2UsersIdPinnedListsResponse
object
4 properties
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property
1 required
ResultCount
integer
The number of results returned in this response.
MediaWidth
integer
The width of the media in pixels.
Get2UsersIdFollowersResponse
object
4 properties
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
BookmarkFolderPostsResponse
object
3 properties
UsersLikesCreateResponse
object
2 properties
UrlImage
object
Represent the information for the URL image.
3 properties
UserName
string
The X handle (screen name) of this user.
BookmarkAddRequest
object
1 property
1 required
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties
2 required
NextToken
string
The next token.
ListPinnedRequest
object
1 property
1 required
ListFollowedResponse
object
2 properties
Get2UsersIdMentionsResponse
object
4 properties
Poll
object
Represent a Poll attached to a Tweet.
5 properties
2 required
BookmarkFoldersResponse
object
3 properties
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property
1 required
MediaHeight
integer
The height of the media in pixels.
ListFollowedRequest
object
1 property
1 required
UsersRetweetsCreateRequest
object
1 property
1 required
Get2UsersRepostsOfMeResponse
object
4 properties
TopicId
string
Unique identifier of this Topic.
Get2UsersSearchResponse
object
4 properties
UsersRetweetsDeleteResponse
object
2 properties
BookmarkFolderId
string
The unique identifier of this Bookmark folder.
UserId
string
Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
NewestId
string
The newest id in this response.
MuteUserRequest
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from X (Twitter) 12
Other APIs X (Twitter) publishes across the network.
X Ads API
X Activity API
X (Twitter) Account Activity API
X (Twitter) Activity API
X (Twitter) Bookmarks API
X (Twitter) Chat API
X (Twitter) Communities API
X (Twitter) Community Notes API
X (Twitter) Compliance API
X (Twitter) Connections API
X (Twitter) Direct Messages API
X (Twitter) General API
#Users