X Users API is one of 23 APIs that 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 and API documentation.
This API exposes
44 operations
across 38 paths,
and defines 124 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://api.x.com, https://api.x.com/2.
The identity and technical contract details declared by the specification.
RepostPostResponse
object
2 properties
FieldHydrationFailureProblem
object
7 properties
4 required
CreateUsersBookmarkResponseData
object
1 property
1 required
DeleteUsersBookmarkResponseData
object
1 property
1 required
UnfollowListResponseData
object
1 property
1 required
PinListResponseData
object
1 property
1 required
UnblockUsersDmsResponseData
object
1 property
1 required
UserWithheld
object
Withholding details for withheld content.
2 properties
Error
object
2 properties
2 required
GetUsersFollowersResponse
object
4 properties
ResourceUnavailableProblem
object
6 properties
4 required
UserEntities
object
A list of metadata found in the User's profile description.
2 properties
UnrepostPostResponseData
object
1 property
1 required
CreateUsersBookmarkRequest
object
2 properties
1 required
PostMediaMetadata
array
Metadata for media attached to this Post.
InternalErrorProblem
object
4 properties
3 required
SearchUsersResponse
object
4 properties
RepostPostRequest
object
1 property
1 required
PostEditControls
object
Indicates how much longer (if at all) this Post can be edited.
3 properties
UserAffiliation
object
Metadata about a user's affiliation.
4 properties
UnfollowUserResponse
object
2 properties
UserSubscription
object
The subscription relationship between this User and you.
1 property
1 required
GetUsersByUsernameResponse
object
3 properties
GetUsersTimelineResponse
object
4 properties
GetUsersFollowingResponse
object
4 properties
GetUsersByIdsResponse
object
3 properties
UnrepostPostResponse
object
2 properties
GetUsersOwnedListsResponse
object
4 properties
PostReferencedPosts
array
A list of Posts this Post refers to. If the Post is a Retweet, Quote or Reply, it includes the referenced Post's type and ID.
BlockUsersDmsResponse
object
2 properties
GetUsersBookmarksResponse
object
4 properties
UnblockUsersDmsResponse
object
2 properties
PostNotePost
object
The full content of the Post, including text beyond 280 characters.
2 properties
1 required
UserId
string
Unique identifier of a User
GetUsersRepostsOfMeResponse
object
4 properties
PostScopes
object
The scopes for this Post.
1 property
1 required
LikePostResponseData
object
1 property
1 required
DisallowedResourceProblem
object
7 properties
3 required
PostSuggestedSourceLinksWithCounts
array
Suggested source URLs for this Post, each with the number of times it was suggested.
GetUsersFollowedListsResponse
object
4 properties
GetUsersPublicKeysResponse
object
2 properties
GetUsersBookmarksByFolderIdResponse
object
2 properties
Topic
object
3 properties
UnmuteUserResponse
object
2 properties
MuteUserResponseData
object
1 property
1 required
PlaceContainedWithin
array
A list of unique identifiers of the Places that contain this place.
MediaPublicMetrics
object
Public engagement metrics for the media at the time of the request.
1 property
1 required
ListMemberCount
integer
The number of members in this List.
ListFollowerCount
integer
The number of users who follow this List.
PublicKeyId
string
Unique identifier of a PublicKey
PostDisplayTextRange
array
The inclusive start and exclusive end indices of the displayable content of the Post.
Expansions
object
6 properties
GetUsersListMembershipsResponse
object
4 properties
ListId
string
Unique identifier of a List
PostGeo
object
The location tagged on the Post, if the user provided one.
2 properties
LikePostResponse
object
2 properties
FollowListRequest
object
1 property
1 required
GetUsersPublicKeyResponse
object
2 properties
PostEntities
object
A list of metadata entities (hashtags, mentions, URLs) found in the Post text.
4 properties
MediaVariants
array
Each media object may have multiple display or playback variants, with different resolutions or formats.
UnfollowUserResponseData
object
1 property
1 required
CreateUsersBookmarkResponse
object
2 properties
NotAuthorizedForFieldProblem
object
10 properties
4 required
PostNoteRequestSuggestions
array
Community-Notes request suggestions for this Post.
MediaPromotedMetrics
object
Promoted nonpublic engagement metrics for the media at the time of the request.
6 properties
GetUsersMeResponse
object
3 properties
GetUsersPinnedListsResponse
object
4 properties
User
object
28 properties
FollowListResponse
object
2 properties
UserPublicMetrics
object
A list of metrics for this User.
6 properties
4 required
UnmuteUserResponseData
object
1 property
1 required
Place
object
8 properties
GetUsersAffiliatesResponse
object
4 properties
GetUsersBookmarkFoldersResponseData
object
2 properties
2 required
UnpinListResponse
object
2 properties
FollowListResponseData
object
1 property
1 required
BlockUsersDmsResponseData
object
1 property
1 required
PublicKey
object
5 properties
GetUsersLikedPostsResponse
object
4 properties
DeleteUsersBookmarkResponse
object
2 properties
PostPublicMetrics
object
Engagement metrics for the Post at the time of the request.
6 properties
6 required
GetUsersMutingResponse
object
4 properties
Media
object
13 properties
PostId
string
Unique identifier of a Post
UnlikePostResponse
object
2 properties
PinListRequest
object
1 property
1 required
MuteUserRequest
object
1 property
1 required
CreateUsersBookmarkFolderRequest
object
1 property
1 required
PostSuggestedSourceLinks
array
URLs suggested as sources for this Post.
NotAuthorizedForResourceProblem
object
9 properties
4 required
FollowUserResponse
object
2 properties
LikePostRequest
object
1 property
1 required
GetUsersPostsResponse
object
4 properties
FollowUserResponseData
object
2 properties
2 required
MediaNonPublicMetrics
object
Nonpublic engagement metrics for the media at the time of the request.
5 properties
GetUsersBookmarkFoldersResponse
object
2 properties
UserConnectionStatus
array
Returns detailed information about the relationship between two users.
PinListResponse
object
2 properties
MuteUserResponse
object
2 properties
Post
object
36 properties
InvalidRequestProblem
object
6 properties
3 required
CreateUsersBookmarkFolderResponseData
object
2 properties
2 required
PostAttachments
object
Specifies the type of attachments (if any) present in this Post.
3 properties
GetUsersBlockingResponse
object
4 properties
PostContextAnnotations
array
Annotations inferred about the Post (domain and entity context).
PollOptions
array
The list of options (choices) available in this poll.
RepostPostResponseData
object
2 properties
2 required
CreateUsersBookmarkFolderResponse
object
2 properties
UnpinListResponseData
object
1 property
1 required
PlaceGeo
object
The geographic location of this place, expressed as a GeoJSON Feature.
3 properties
3 required
GetUsersByIdResponse
object
3 properties
UnfollowListResponse
object
2 properties
UnlikePostResponseData
object
1 property
1 required
PostWithheld
object
Withholding details for withheld content.
3 properties
2 required
MediaOrganicMetrics
object
Organic nonpublic engagement metrics for the media at the time of the request.
6 properties
ResourceNotFoundProblem
object
8 properties
4 required
PostMatchedMediaNotes
array
Community-Notes media matches for this Post.
GetUsersByUsernamesResponse
object
3 properties
FieldUnauthorizedProblem
object
7 properties
4 required
GetUsersMentionsResponse
object
4 properties
FollowUserRequest
object
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs X publishes across the network.
