Twitter/X Users API is one of 22 APIs that Twitter/X 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, and an API reference.
This API exposes
45 operations
across 40 paths,
and defines 114 schemas.
It is described by OpenAPI 3.2.0, at version 2.166.
Requests are made against a single base URL, https://api.x.com.
The identity and technical contract details declared by the specification.
ListFollowedRequest
object
1 property
1 required
Get2UsersMeResponse
object
3 properties
PollOption
object
Describes a choice in a Poll object.
3 properties
3 required
PaginationTokenLong
string
A 'long' pagination token.
PlaceId
string
The identifier for this place.
Get2UsersIdBlockingResponse
object
4 properties
BookmarkFolderPostsResponse
object
3 properties
Get2UsersIdFollowersResponse
object
4 properties
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties
2 required
Get2UsersPublicKeysResponse
object
2 properties
PaginationToken32
string
A base32 pagination token.
ChatJuiceboxConfig
object
Key recovery configuration for Juicebox-based key storage.
6 properties
Get2UsersIdPinnedListsResponse
object
4 properties
Get2UsersIdMentionsResponse
object
4 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.
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
Get2UsersIdOwnedListsResponse
object
4 properties
UsersLikesCreateRequest
object
1 property
1 required
UsersDMUnBlockCreateResponse
object
2 properties
UsersRetweetsDeleteResponse
object
2 properties
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties
1 required
Get2UsersRepostsOfMeResponse
object
4 properties
Topic
object
The topic of a Space, as selected by its creator.
3 properties
2 required
Url
string
A validly formatted URL.
MediaKey
string
The Media Key identifier for this attachment.
Get2UsersIdBookmarksResponse
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
Tweet
object
32 properties
ListFollowedResponse
object
2 properties
UserIdMatchesAuthenticatedUser
string
Unique identifier of this User. The value must be the same as the authenticated user.
Error
object
2 properties
2 required
Get2TweetsIdLikingUsersResponse
object
4 properties
Get2ListsIdFollowersResponse
object
4 properties
Geo
object
4 properties
3 required
OldestId
string
The oldest id in this response.
UsersFollowingCreateRequest
object
1 property
1 required
BookmarkMutationResponse
object
2 properties
NextToken
string
The next token.
BookmarkAddRequest
object
1 property
1 required
Get2UsersByUsernameUsernameResponse
object
3 properties
HttpStatusCode
integer
HTTP Status Code.
Get2UsersIdPublicKeysResponse
object
2 properties
Get2UsersIdLikedTweetsResponse
object
4 properties
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties
2 required
ListPinnedResponse
object
2 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…
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties
2 required
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property
1 required
Poll
object
Represent a Poll attached to a Tweet.
5 properties
2 required
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
Get2UsersIdListMembershipsResponse
object
4 properties
Media
object
4 properties
1 required
PollId
string
Unique identifier of this poll.
ListId
string
The unique identifier of this List.
ResultCount
integer
The number of results returned in this response.
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties
1 required
MediaWidth
integer
The width of the media in pixels.
UsersFollowingCreateResponse
object
2 properties
CommunityId
string
The unique identifier of this Community.
List
object
A X List is a curated group of accounts.
8 properties
2 required
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties
1 required
TweetWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
3 properties
2 required
UrlImage
object
Represent the information for the URL image.
3 properties
PollOptionLabel
string
The text of a poll choice.
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
Get2UsersByResponse
object
3 properties
Get2UsersIdResponse
object
3 properties
MuteUserMutationResponse
object
2 properties
NewestId
string
The newest id in this response.
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
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.
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property
1 required
TweetText
string
The content of the Tweet.
MediaHeight
integer
The height of the media in pixels.
Get2UsersResponse
object
3 properties
MuteUserRequest
object
1 property
1 required
UserSearchQueryVnext
string
The the search string by which to query for users.
Get2UsersIdMutingResponse
object
4 properties
ListPinnedRequest
object
1 property
1 required
UserName
string
The X handle (screen name) of this user.
UsersLikesCreateResponse
object
2 properties
FullTextEntities
object
5 properties
TopicId
string
Unique identifier of this Topic.
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties
1 required
Place
object
8 properties
2 required
Get2UsersSearchResponse
object
4 properties
NoteId
string
The unique identifier of this Community Note.
Get2UsersIdFollowingResponse
object
4 properties
Get2TweetsIdRetweetedByResponse
object
4 properties
Get2UsersIdAffiliatesResponse
object
4 properties
PaginationToken36
string
A base36 pagination token.
PreviousToken
string
The previous token.
Get2UsersIdTweetsResponse
object
4 properties
UsersFollowingDeleteResponse
object
2 properties
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
BookmarkFolderId
string
The unique identifier of this Bookmark folder.
PublicKey
object
A user's public key with associated key recovery configuration.
5 properties
UsersRetweetsCreateRequest
object
1 property
1 required
Get2ListsIdMembersResponse
object
4 properties
NoteTweetText
string
The note content of the Tweet.
User
object
The X User object.
21 properties
3 required
Get2UsersIdTimelinesReverseChronologicalResponse
object
4 properties
ListUnpinResponse
object
2 properties
UsersLikesDeleteResponse
object
2 properties
Expansions
object
6 properties
BookmarkFoldersResponse
object
3 properties
UsersRetweetsCreateResponse
object
2 properties
Get2UsersIdFollowedListsResponse
object
4 properties
UsersDMBlockCreateResponse
object
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Twitter/X publishes across the network.
