X (Twitter) Bookmarks 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 Bookmarks. 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
5 operations
across 4 paths,
and defines 60 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.
5 operations4 paths60 schemas1 DELETE3 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
X (Twitter) Bookmarks 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 5
Across 4 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Bookmarks 5
Endpoints related to retrieving, managing bookmarks of a user
GET
/2/users/{id}/bookmarks
X Get Bookmarks
getUsersBookmarks9 params→ 200default
POST
/2/users/{id}/bookmarks
X Create Bookmark
createUsersBookmark1 parambody→ 200default
GET
/2/users/{id}/bookmarks/folders
X Get Bookmark Folders
getUsersBookmarkFolders3 params→ 200default
GET
/2/users/{id}/bookmarks/folders/{folder_id}
X Get Bookmarks by Folder ID
getUsersBookmarksByFolderId2 params→ 200default
DELETE
/2/users/{id}/bookmarks/{tweet_id}
X Delete Bookmark
deleteUsersBookmark2 params→ 200default
Schemas 60
The contract defines 60 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.
BookmarkFolderPostsResponse
object
3 properties
NoteTweetText
string
The note content of the Tweet.
PollId
string
Unique identifier of this poll.
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
Media
object
4 properties1 required
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties2 required
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties1 required
UrlImage
object
Represent the information for the URL image.
3 properties
Geo
object
4 properties3 required
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
UserName
string
The X handle (screen name) of this user.
UserIdMatchesAuthenticatedUser
string
Unique identifier of this User. The value must be the same as the authenticated user.
BookmarkAddRequest
object
1 property1 required
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties2 required
PaginationToken36
string
A base36 pagination token.
PlaceId
string
The identifier for this place.
HttpStatusCode
integer
HTTP Status Code.
NextToken
string
The next token.
PollOptionLabel
string
The text of a poll choice.
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties1 required
PreviousToken
string
The previous token.
Poll
object
Represent a Poll attached to a Tweet.
5 properties2 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 properties2 required
MentionFields
object
Represent the portion of text recognized as a User mention, and its start and end position within the text.
2 properties1 required
HashtagEntity
PlaceType
string
BookmarkFoldersResponse
object
3 properties
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
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.
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property1 required
MediaKey
string
The Media Key identifier for this attachment.
CommunityId
string
The unique identifier of this Community.
Topic
object
The topic of a Space, as selected by its creator.
3 properties2 required
BookmarkMutationResponse
object
2 properties
Error
object
2 properties2 required
MediaHeight
integer
The height of the media in pixels.
Place
object
8 properties2 required
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property1 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…
User
object
The X User object.
21 properties3 required
MentionEntity
ResultCount
integer
The number of results returned in this response.
Get2UsersIdBookmarksResponse
object
4 properties
FullTextEntities
object
5 properties
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties1 required
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties1 required
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
PollOption
object
Describes a choice in a Poll object.
3 properties3 required
Tweet
object
29 properties
TopicId
string
Unique identifier of this Topic.
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties2 required
BookmarkFolderId
string
The unique identifier of this Bookmark folder.
CashtagEntity
TweetWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
3 properties2 required
Url
string
A validly formatted URL.
Expansions
object
6 properties
TweetText
string
The content of the Tweet.
MediaWidth
integer
The width of the media in pixels.
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.
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 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
