Skip to main content
GET
Get Lists by ID

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowAuthorization Code
Authorization URL
https://api.x.com/2/oauth2/authorize
Token URL
https://api.x.com/2/oauth2/token
Scopes3
list.read
View Lists, members, and followers of Lists you created or are a member of, including private Lists.
users.read
View any account you can see, including protected accounts.
tweet.read
View all posts you can see, including those from protected accounts.

Path Parameters

id
string
required

Unique identifier of a List

Pattern: ^[0-9]{1,19}$
Example:

"1146654567674912769"

Query Parameters

list.fields
enum<string>[]

A comma separated list of List fields to display. The fields available for a List object.

Minimum array length: 1
Available options:
created_at,
description,
follower_count,
id,
member_count,
name,
private
expansions
enum<string>[]

A comma separated list of fields to expand.

Minimum array length: 1
Available options:
owner_id
user.fields
enum<string>[]

A comma separated list of User fields to display. The fields available for a User object.

Minimum array length: 1
Available options:
confirmed_email,
connection_status,
created_at,
description,
entities,
id,
is_identity_verified,
location,
name,
parody,
profile_banner_url,
profile_image_url,
protected,
public_metrics,
receives_your_dm,
subscriber_count,
subscribes_to_you,
subscription,
subscription_type,
url,
username,
verified,
verified_followers_count,
verified_type,
withheld

Response

The request has succeeded.

data
object
errors
object[]
includes
object