X (Twitter) Lists API
Endpoints related to retrieving, managing Lists
X (Twitter) Lists 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 Lists. 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 17 operations across 12 paths, and defines 77 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.
17 operations
12 paths
77 schemas
4 DELETE8 GET4 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
X (Twitter) Lists 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 17
Across 12 paths, the API surfaces 17 operations — 4 DELETE, 8 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Lists 17
Endpoints related to retrieving, managing Lists
POST
/2/lists
X Create List
DELETE
/2/lists/{id}
X Delete List
GET
/2/lists/{id}
X Get List by ID
PUT
/2/lists/{id}
X Update List
GET
/2/lists/{id}/followers
X Get List Followers
GET
/2/lists/{id}/members
X Get List Members
POST
/2/lists/{id}/members
X Add List Member
DELETE
/2/lists/{id}/members/{user_id}
X Remove List Member
GET
/2/lists/{id}/tweets
X Get List Posts
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}/list_memberships
X Get List Memberships
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
Schemas 77
The contract defines 77 schemas that model the data the API accepts and returns. The most detailed are Tweet (29 properties), User (21 properties), UrlFields (9 properties), List (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
PollId
string
Unique identifier of this poll.
Media
object
4 properties
1 required
ListPinnedResponse
object
2 properties
Geo
object
4 properties
3 required
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.
ListAddUserRequest
object
1 property
1 required
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
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
Topic
object
The topic of a Space, as selected by its creator.
3 properties
2 required
Place
object
8 properties
2 required
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
ListMutateResponse
object
2 properties
CashtagEntity
ListUnpinResponse
object
2 properties
Get2UsersIdListMembershipsResponse
object
4 properties
NoteTweetText
string
The note content of the Tweet.
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.
ListUpdateRequest
object
3 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
FullTextEntities
object
5 properties
ListCreateResponse
object
2 properties
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties
1 required
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
TweetText
string
The content of the Tweet.
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
Get2ListsIdTweetsResponse
object
4 properties
PaginationTokenLong
string
A 'long' pagination token.
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties
1 required
ListUpdateResponse
object
2 properties
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
ListId
string
The unique identifier of this List.
PaginationToken36
string
A base36 pagination token.
HttpStatusCode
integer
HTTP Status Code.
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
ListCreateRequest
object
3 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.
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.
Get2ListsIdResponse
object
3 properties
MediaWidth
integer
The width of the media in pixels.
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
UrlImage
object
Represent the information for the URL image.
3 properties
UserName
string
The X handle (screen name) of this user.
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
ListDeleteResponse
object
2 properties
Poll
object
Represent a Poll attached to a Tweet.
5 properties
2 required
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
TopicId
string
Unique identifier of this Topic.
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.
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
#Lists