Skip to main content
This guide walks you through retrieving members of a List.
PrerequisitesBefore you begin, you’ll need:

​
Get List members

1

Find the List ID

You can find the List ID in the URL when viewing a List:
https://x.com/i/lists/84839422
                      └── This is the List ID
2

Request the List members

cURL
curl "https://api.x.com/2/lists/84839422/members?\
user.fields=created_at,username,verified&\
max_results=100" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Get List members with pagination
for page in client.lists.get_members(
    "84839422",
    user_fields=["created_at", "username", "verified"],
    max_results=100
):
    for user in page.data:
        print(f"{user.username} - Joined: {user.created_at}")

import { Client } from "@xdevplatform/xdk";

const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });

// Get List members with pagination
const paginator = client.lists.getMembers("84839422", {
  userFields: ["created_at", "username", "verified"],
  maxResults: 100,
});

for await (const page of paginator) {
  page.data?.forEach((user) => {
    console.log(`${user.username} - Joined: ${user.created_at}`);
  });
}
3

Review the response

{
  "data": [
    {
      "id": "1319036828964454402",
      "name": "Birdwatch",
      "username": "birdwatch",
      "created_at": "2020-10-21T22:04:47.000Z",
      "verified": true
    },
    {
      "id": "1065249714214457345",
      "name": "Spaces",
      "username": "TwitterSpaces",
      "created_at": "2018-11-21T14:24:58.000Z",
      "verified": true
    }
  ],
  "meta": {
    "result_count": 2,
    "next_token": "5349804505549807616"
  }
}

​
Include additional data

Use expansions to get related data like pinned Posts:
cURL
curl "https://api.x.com/2/lists/84839422/members?\
user.fields=created_at&\
expansions=pinned_tweet_id&\
tweet.fields=created_at" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Get List members with expansions
for page in client.lists.get_members(
    "84839422",
    user_fields=["created_at"],
    expansions=["pinned_tweet_id"],
    tweet_fields=["created_at"]
):
    for user in page.data:
        print(f"{user.username}")
    # Pinned Posts are in page.includes.tweets

import { Client } from "@xdevplatform/xdk";

const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });

// Get List members with expansions
const paginator = client.lists.getMembers("84839422", {
  userFields: ["created_at"],
  expansions: ["pinned_tweet_id"],
  tweetFields: ["created_at"],
});

for await (const page of paginator) {
  page.data?.forEach((user) => {
    console.log(user.username);
  });
  // Pinned Posts are in page.includes?.tweets
}

​
Next steps

Manage List members

Add and remove members

List lookup

Get List details

API Reference

Full endpoint documentation