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) Lists API

Endpoints related to retrieving, managing Lists

This API exposes 17 operations across 12 paths, and defines 77 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.

17 operations 12 paths 77 schemas 4 DELETE8 GET4 POST1 PUT

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) 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
createLists body → 200default
DELETE
/2/lists/{id}
X Delete List
deleteLists 1 param → 200default
GET
/2/lists/{id}
X Get List by ID
getListsById 4 params → 200default
PUT
/2/lists/{id}
X Update List
updateLists 1 param body → 200default
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
POST
/2/lists/{id}/members
X Add List Member
addListsMember 1 param body → 200default
DELETE
/2/lists/{id}/members/{user_id}
X Remove List Member
removeListsMemberByUserId 2 params → 200default
GET
/2/lists/{id}/tweets
X Get List Posts
getListsPosts 9 params → 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}/list_memberships
X Get List Memberships
getUsersListMemberships 6 params → 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

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), Place (8 properties). Each schema is shown below with its type and property counts.

Get2ListsIdMembersResponse
object
4 properties
List
object
A X List is a curated group of accounts.
8 properties 2 required
HashtagEntity
UserName
string
The X handle (screen name) of this user.
NextToken
string
The next token.
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.
ListUpdateRequest
object
3 properties
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
Get2UsersIdFollowedListsResponse
object
4 properties
ListMutateResponse
object
2 properties
User
object
The X User object.
21 properties 3 required
Get2ListsIdFollowersResponse
object
4 properties
ListCreateRequest
object
3 properties 1 required
HttpStatusCode
integer
HTTP Status Code.
PollOption
object
Describes a choice in a Poll object.
3 properties 3 required
CommunityId
string
The unique identifier of this Community.
PlaceId
string
The identifier for this place.
ListId
string
The unique identifier of this List.
PaginationToken36
string
A base36 pagination token.
PreviousToken
string
The previous token.
NoteTweetText
string
The note content of the Tweet.
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties 1 required
MentionEntity
PlaceType
string
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…
Get2UsersIdListMembershipsResponse
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
Error
object
2 properties 2 required
ListUnpinResponse
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
ResultCount
integer
The number of results returned in this response.
MediaHeight
integer
The height of the media in pixels.
Get2ListsIdResponse
object
3 properties
FullTextEntities
object
5 properties
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
Get2ListsIdTweetsResponse
object
4 properties
MediaKey
string
The Media Key identifier for this attachment.
PollOptionLabel
string
The text of a poll choice.
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
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
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties 1 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
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
Expansions
object
6 properties
TopicId
string
Unique identifier of this Topic.
ListCreateResponse
object
2 properties
Get2UsersIdPinnedListsResponse
object
4 properties
MediaWidth
integer
The width of the media in pixels.
ListUpdateResponse
object
2 properties
Place
object
8 properties 2 required
ListPinnedRequest
object
1 property 1 required
ListFollowedResponse
object
2 properties
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties 1 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
Topic
object
The topic of a Space, as selected by its creator.
3 properties 2 required
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.
Media
object
4 properties 1 required
ListAddUserRequest
object
1 property 1 required
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties 2 required
CashtagEntity
Get2UsersIdOwnedListsResponse
object
4 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.
Url
string
A validly formatted URL.
ListFollowedRequest
object
1 property 1 required
UrlImage
object
Represent the information for the URL image.
3 properties
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties 2 required
Poll
object
Represent a Poll attached to a Tweet.
5 properties 2 required
Geo
object
4 properties 3 required
ListPinnedResponse
object
2 properties
PaginationTokenLong
string
A 'long' pagination token.
ListDeleteResponse
object
2 properties
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties 2 required
TweetText
string
The content of the Tweet.
PollId
string
Unique identifier of this poll.
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
Tweet
object
29 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

twitter-lists-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of X (Twitter) Lists 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.