Quickstart

This guide walks you through looking up List information using the List lookup endpoints. Reference for the X API v2 standard tier covering list lookup.

This guide walks you through looking up List information using the List lookup endpoints.

Prerequisites

Before you begin, you’ll need:

• A developer account with an approved App
• Your App’s Bearer Token

---

Get a List by ID

Retrieve details for a specific List:

cURL

shellscript

curl "https://api.x.com/2/lists/1234567890?\
list.fields=description,owner_id,member_count,follower_count,private,created_at" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Get a List by ID
response = client.lists.get(
    "1234567890",
    list_fields=["description", "owner_id", "member_count", "follower_count", "private", "created_at"]
)

print(f"List: {response.data.name}")
print(f"Members: {response.data.member_count}")

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

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

// Get a List by ID
const response = await client.lists.get("1234567890", {
  listFields: ["description", "owner_id", "member_count", "follower_count", "private", "created_at"],
});

console.log(`List: ${response.data?.name}`);
console.log(`Members: ${response.data?.member_count}`);

Response

{
  "data": {
    "id": "1234567890",
    "name": "Tech News",
    "description": "Top tech journalists and publications",
    "owner_id": "2244994945",
    "private": false,
    "member_count": 50,
    "follower_count": 1250,
    "created_at": "2023-01-15T10:00:00.000Z"
  }
}

---

Get Lists owned by a user

Retrieve all Lists owned by a specific user:

cURL

shellscript

curl "https://api.x.com/2/users/2244994945/owned_lists?\
list.fields=description,member_count,follower_count&\
max_results=100" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Get Lists owned by a user with pagination
for page in client.lists.get_owned_lists(
    "2244994945",
    list_fields=["description", "member_count", "follower_count"],
    max_results=100
):
    for lst in page.data:
        print(f"{lst.name} - {lst.member_count} members")

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

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

// Get Lists owned by a user with pagination
const paginator = client.lists.getOwnedLists("2244994945", {
  listFields: ["description", "member_count", "follower_count"],
  maxResults: 100,
});

for await (const page of paginator) {
  page.data?.forEach((lst) => {
    console.log(`${lst.name} - ${lst.member_count} members`);
  });
}

Response

{
  "data": [
    {
      "id": "1234567890",
      "name": "Tech News",
      "description": "Top tech journalists",
      "member_count": 50,
      "follower_count": 1250
    },
    {
      "id": "9876543210",
      "name": "Developer Tools",
      "description": "Useful tools for developers",
      "member_count": 25,
      "follower_count": 500
    }
  ],
  "meta": {
    "result_count": 2
  }
}

---

Include owner information

Expand the owner’s user data:

cURL

shellscript

curl "https://api.x.com/2/lists/1234567890?\
list.fields=description,owner_id&\
expansions=owner_id&\
user.fields=username,verified" \
  -H "Authorization: Bearer $BEARER_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_BEARER_TOKEN")

# Get List with owner info
response = client.lists.get(
    "1234567890",
    list_fields=["description", "owner_id"],
    expansions=["owner_id"],
    user_fields=["username", "verified"]
)

print(f"List: {response.data.name}")
# Owner info is in response.includes.users

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

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

// Get List with owner info
const response = await client.lists.get("1234567890", {
  listFields: ["description", "owner_id"],
  expansions: ["owner_id"],
  userFields: ["username", "verified"],
});

console.log(`List: ${response.data?.name}`);
// Owner info is in response.includes?.users

Response with expansion

{
  "data": {
    "id": "1234567890",
    "name": "Tech News",
    "description": "Top tech journalists",
    "owner_id": "2244994945"
  },
  "includes": {
    "users": [
      {
        "id": "2244994945",
        "username": "XDevelopers",
        "verified": true
      }
    ]
  }
}

---

Available fields

Field	Description
description	List description
owner_id	Owner’s user ID
private	Whether List is private
member_count	Number of members
follower_count	Number of followers
created_at	List creation date

---

Next steps

List Posts

Get Posts from a List

List members

Get List members

Manage Lists

Create and update Lists

API Reference

Full endpoint documentation