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

Endpoints related to retrieving, managing Lists — 9 operation(s) in the X-published contract.

X Lists API is one of 23 APIs that X publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include List. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 6 paths, and defines 70 schemas. It is described by OpenAPI 3.2.0, at version 2.168.

Requests are made against a single base URL, https://api.x.com.

9 operations 6 paths 70 schemas 2 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.168
Base URL
https://api.x.com
Authentication
HTTP Bearer, OAuth 2.0, HTTP Oauth
Terms of Service
Resource Areas
1

Authentication & Security 3

X 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 26 scopes. It uses HTTP oauth authentication (UserToken).

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Lists 9

Endpoints related to retrieving, managing Lists

POST
/2/lists
Create Lists
createLists body → 201default
DELETE
/2/lists/{id}
Delete List
deleteLists 1 param → 200default
GET
/2/lists/{id}
Get Lists by ID
getListsById 4 params → 200default
PUT
/2/lists/{id}
Update List
updateLists 1 param body → 200default
GET
/2/lists/{id}/followers
Get Lists Followers
getListsFollowers 6 params → 200default
GET
/2/lists/{id}/members
Get Lists Members
getListsMembers 6 params → 200default
POST
/2/lists/{id}/members
Add Lists Member
addListsMember 1 param body → 200default
DELETE
/2/lists/{id}/members/{user_id}
Remove a List member
removeListsMemberByUserId 2 params → 200default
GET
/2/lists/{id}/tweets
Get Lists Posts
getListsPosts 9 params → 200default

Schemas 70

The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are Post (36 properties), User (28 properties), Media (13 properties), NotAuthorizedForFieldProblem (10 properties). Each schema is shown below with its type and property counts.

FieldHydrationFailureProblem
object
7 properties 4 required
DeleteListsResponse
object
2 properties
GetListsPostsResponse
object
4 properties
Poll
object
5 properties
UserWithheld
object
Withholding details for withheld content.
2 properties
Error
object
2 properties 2 required
ResourceUnavailableProblem
object
6 properties 4 required
UserEntities
object
A list of metadata found in the User's profile description.
2 properties
PostMediaMetadata
array
Metadata for media attached to this Post.
InternalErrorProblem
object
4 properties 3 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
Problem
UserSubscription
object
The subscription relationship between this User and you.
1 property 1 required
CreateListsResponse
object
2 properties
CreateListsResponseData
object
2 properties 2 required
GetListsMembersResponse
object
4 properties
DeleteListsResponseData
object
1 property 1 required
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.
GetListsByIdResponse
object
3 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
PostScopes
object
The scopes for this Post.
1 property 1 required
DisallowedResourceProblem
object
7 properties 3 required
UpdateListsRequest
object
3 properties
PostSuggestedSourceLinksWithCounts
array
Suggested source URLs for this Post, each with the number of times it was suggested.
Topic
object
3 properties
RemoveListsMemberByUserIdResponse
object
2 properties
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.
PostDisplayTextRange
array
The inclusive start and exclusive end indices of the displayable content of the Post.
Expansions
object
6 properties
ListId
string
Unique identifier of a List
PostGeo
object
The location tagged on the Post, if the user provided one.
2 properties
List
object
8 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.
AddListsMemberResponseData
object
1 property 1 required
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
User
object
28 properties
AddListsMemberRequest
object
1 property 1 required
UserPublicMetrics
object
A list of metrics for this User.
6 properties 4 required
Place
object
8 properties
CreateListsRequest
object
3 properties 1 required
GetListsFollowersResponse
object
4 properties
PostPublicMetrics
object
Engagement metrics for the Post at the time of the request.
6 properties 6 required
Media
object
13 properties
RemoveListsMemberByUserIdResponseData
object
1 property 1 required
PostSuggestedSourceLinks
array
URLs suggested as sources for this Post.
NotAuthorizedForResourceProblem
object
9 properties 4 required
MediaNonPublicMetrics
object
Nonpublic engagement metrics for the media at the time of the request.
5 properties
UserConnectionStatus
array
Returns detailed information about the relationship between two users.
Post
object
36 properties
InvalidRequestProblem
object
6 properties 3 required
UpdateListsResponse
object
2 properties
PostAttachments
object
Specifies the type of attachments (if any) present in this Post.
3 properties
PostContextAnnotations
array
Annotations inferred about the Post (domain and entity context).
PollOptions
array
The list of options (choices) available in this poll.
PlaceGeo
object
The geographic location of this place, expressed as a GeoJSON Feature.
3 properties 3 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
AddListsMemberResponse
object
2 properties
ResourceNotFoundProblem
object
8 properties 4 required
UpdateListsResponseData
object
1 property 1 required
PostMatchedMediaNotes
array
Community-Notes media matches for this Post.
FieldUnauthorizedProblem
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

x-lists-api-openapi.yml Raw ↑

Other APIs X publishes across the network.

X Account Activity API
X Account API
X Activity API
X Articles API
X Bots API
X Broadcasts API
X Chat API
X Communities API
X Community Notes API
X Compliance API
X Connections API
X Direct Messages API
Where this information came from

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