How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 User. 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.2.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.

Specification
OpenAPI 3.2.0
API Version
2.161
Base URL
https://api.x.com/2
Authentication
HTTP Bearer, OAuth 2.0, HTTP Oauth
Terms of Service
Resource Areas
1

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
getListsFollowers 6 params → 200default
GET
/2/lists/{id}/members
X Get List Members
getListsMembers 6 params → 200default
GET
/2/tweets/{id}/liking_users
X Get Liking Users
getPostsLikingUsers 6 params → 200default
GET
/2/tweets/{id}/retweeted_by
X Get Reposted by
getPostsRepostedBy 6 params → 200default
GET
/2/users
X Get Users by IDs
getUsersByIds 4 params → 200default
GET
/2/users/by
X Get Users by Usernames
getUsersByUsernames 4 params → 200default
GET
/2/users/by/username/{username}
X Get User by Username
getUsersByUsername 4 params → 200default
GET
/2/users/me
X Get My User
getUsersMe 3 params → 200default
GET
/2/users/public_keys
X Get Public Keys for Multiple Users
getUsersPublicKeys 2 params → 200default
GET
/2/users/reposts_of_me
X Get Reposts of Me
getUsersRepostsOfMe 8 params → 200default
GET
/2/users/search
X Search Users
searchUsers 6 params → 200default
GET
/2/users/{id}
X Get User by ID
getUsersById 4 params → 200default
GET
/2/users/{id}/affiliates
X Get Affiliates
getUsersAffiliates 6 params → 200default
GET
/2/users/{id}/blocking
X Get Blocking
getUsersBlocking 6 params → 200default
GET
/2/users/{id}/bookmarks
X Get Bookmarks
getUsersBookmarks 9 params → 200default
POST
/2/users/{id}/bookmarks
X Create Bookmark
createUsersBookmark 1 param body → 200default
GET
/2/users/{id}/bookmarks/folders
X Get Bookmark Folders
getUsersBookmarkFolders 3 params → 200default
GET
/2/users/{id}/bookmarks/folders/{folder_id}
X Get Bookmarks by Folder ID
getUsersBookmarksByFolderId 2 params → 200default
DELETE
/2/users/{id}/bookmarks/{tweet_id}
X Delete Bookmark
deleteUsersBookmark 2 params → 200default
POST
/2/users/{id}/dm/block
X Block DMs
blockUsersDms 1 param → 200default
POST
/2/users/{id}/dm/unblock
X Unblock DMs
unblockUsersDms 1 param → 200default
GET
/2/users/{id}/followed_lists
X Get Followed Lists
getUsersFollowedLists 6 params → 200default
POST
/2/users/{id}/followed_lists
X Follow List
followList 1 param body → 200default
DELETE
/2/users/{id}/followed_lists/{list_id}
X Unfollow List
unfollowList 2 params → 200default
GET
/2/users/{id}/followers
X Get Followers
getUsersFollowers 6 params → 200default
GET
/2/users/{id}/following
X Get Following
getUsersFollowing 6 params → 200default
POST
/2/users/{id}/following
X Follow User
followUser 1 param body → 200default
GET
/2/users/{id}/liked_tweets
X Get Liked Posts
getUsersLikedPosts 9 params → 200default
POST
/2/users/{id}/likes
X Like Post
likePost 1 param body → 200default
DELETE
/2/users/{id}/likes/{tweet_id}
X Unlike Post
unlikePost 2 params → 200default
GET
/2/users/{id}/list_memberships
X Get List Memberships
getUsersListMemberships 6 params → 200default
GET
/2/users/{id}/mentions
X Get Mentions
getUsersMentions 13 params → 200default
GET
/2/users/{id}/muting
X Get Muting
getUsersMuting 6 params → 200default
POST
/2/users/{id}/muting
X Mute User
muteUser 1 param body → 200default
GET
/2/users/{id}/owned_lists
X Get Owned Lists
getUsersOwnedLists 6 params → 200default
GET
/2/users/{id}/pinned_lists
X Get Pinned Lists
getUsersPinnedLists 4 params → 200default
POST
/2/users/{id}/pinned_lists
X Pin List
pinList 1 param body → 200default
DELETE
/2/users/{id}/pinned_lists/{list_id}
X Unpin List
unpinList 2 params → 200default
GET
/2/users/{id}/public_keys
X Get User Public Keys
getUsersPublicKey 2 params → 200default
POST
/2/users/{id}/retweets
X Repost Post
repostPost 1 param body → 200default
DELETE
/2/users/{id}/retweets/{source_tweet_id}
X Unrepost Post
unrepostPost 2 params → 200default
GET
/2/users/{id}/timelines/reverse_chronological
X Get Timeline
getUsersTimeline 14 params → 200default
GET
/2/users/{id}/tweets
X Get Posts
getUsersPosts 14 params → 200default
DELETE
/2/users/{source_user_id}/following/{target_user_id}
X Unfollow User
unfollowUser 2 params → 200default
DELETE
/2/users/{source_user_id}/muting/{target_user_id}
X Unmute User
unmuteUser 2 params → 200default

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.

UsersDMUnBlockCreateResponse
object
2 properties
NextToken
string
The next token.
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property 1 required
MuteUserRequest
object
1 property 1 required
MuteUserMutationResponse
object
2 properties
NoteTweetText
string
The note content of the Tweet.
Get2UsersIdBlockingResponse
object
4 properties
Get2UsersSearchResponse
object
4 properties
PlaceId
string
The identifier for this place.
Get2UsersResponse
object
3 properties
Poll
object
Represent a Poll attached to a Tweet.
5 properties 2 required
UsersFollowingCreateRequest
object
1 property 1 required
Get2UsersIdTweetsResponse
object
4 properties
UsersRetweetsCreateRequest
object
1 property 1 required
Media
object
4 properties 1 required
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…
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties 1 required
PaginationToken32
string
A base32 pagination token.
Place
object
8 properties 2 required
MediaWidth
integer
The width of the media in pixels.
Get2UsersIdFollowingResponse
object
4 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
TopicId
string
Unique identifier of this Topic.
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
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
PaginationTokenLong
string
A 'long' pagination token.
Error
object
2 properties 2 required
ListUnpinResponse
object
2 properties
UsersRetweetsDeleteResponse
object
2 properties
ListPinnedResponse
object
2 properties
Get2UsersIdPinnedListsResponse
object
4 properties
ListFollowedResponse
object
2 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
PreviousToken
string
The previous token.
PublicKey
object
Public key information for Chat encryption
4 properties
UsersLikesCreateResponse
object
2 properties
UsersFollowingDeleteResponse
object
2 properties
TweetText
string
The content of the Tweet.
Get2TweetsIdRetweetedByResponse
object
4 properties
Get2UsersIdAffiliatesResponse
object
4 properties
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties 1 required
Get2UsersIdListMembershipsResponse
object
4 properties
Get2UsersIdFollowersResponse
object
4 properties
ResultCount
integer
The number of results returned in this response.
Expansions
object
6 properties
Tweet
object
29 properties
MediaKey
string
The Media Key identifier for this attachment.
HashtagEntity
ListId
string
The unique identifier of this List.
CashtagEntity
PollOptionLabel
string
The text of a poll choice.
UsersRetweetsCreateResponse
object
2 properties
Get2UsersIdBookmarksResponse
object
4 properties
Url
string
A validly formatted URL.
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties 2 required
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties 2 required
UrlImage
object
Represent the information for the URL image.
3 properties
Topic
object
The topic of a Space, as selected by its creator.
3 properties 2 required
List
object
A X List is a curated group of accounts.
8 properties 2 required
Get2UsersByResponse
object
3 properties
Get2UsersIdTimelinesReverseChronologicalResponse
object
4 properties
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
FullTextEntities
object
5 properties
HttpStatusCode
integer
HTTP Status Code.
Get2ListsIdMembersResponse
object
4 properties
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties 1 required
MediaHeight
integer
The height of the media in pixels.
UserName
string
The X handle (screen name) of this user.
NewestId
string
The newest id in this response.
BookmarkAddRequest
object
1 property 1 required
BookmarkFolderId
string
The unique identifier of this Bookmark folder.
Get2UsersByUsernameUsernameResponse
object
3 properties
BookmarkFolderPostsResponse
object
3 properties
BookmarkMutationResponse
object
2 properties
PollId
string
Unique identifier of this poll.
PollOption
object
Describes a choice in a Poll object.
3 properties 3 required
OldestId
string
The oldest id in this response.
MentionEntity
Get2UsersIdMentionsResponse
object
4 properties
ListFollowedRequest
object
1 property 1 required
UsersDMBlockCreateResponse
object
2 properties
UsersLikesDeleteResponse
object
2 properties
ContextAnnotation
object
Annotation inferred from the Tweet text.
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.
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties 1 required
Get2UsersMeResponse
object
3 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.
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
Get2UsersIdPublicKeysResponse
object
2 properties
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.
Get2UsersRepostsOfMeResponse
object
4 properties
UsersLikesCreateRequest
object
1 property 1 required
Geo
object
4 properties 3 required
Get2UsersIdFollowedListsResponse
object
4 properties
Get2UsersIdMutingResponse
object
4 properties
ListPinnedRequest
object
1 property 1 required
CommunityId
string
The unique identifier of this Community.
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
Get2UsersPublicKeysResponse
object
2 properties
PaginationToken36
string
A base36 pagination token.
BookmarkFoldersResponse
object
3 properties
Get2UsersIdLikedTweetsResponse
object
4 properties
PlaceType
string
User
object
The X User object.
21 properties 3 required
Get2TweetsIdLikingUsersResponse
object
4 properties
UserSearchQueryVnext
string
The the search string by which to query for users.
Get2UsersIdResponse
object
3 properties
Get2ListsIdFollowersResponse
object
4 properties
UsersFollowingCreateResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

twitter-users-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of X (Twitter) Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.