Pinned Lists Overview

The pinned Lists endpoints let you look up a user’s pinned Lists and manage which Lists are. Reference for the X API v2 standard tier covering quickstart.

The pinned Lists endpoints let you look up a user’s pinned Lists and manage which Lists are pinned.

Prerequisites

Before you begin, you’ll need:

• A developer account with an approved App
• User Access Token (OAuth 1.0a or OAuth 2.0 PKCE)

---

Available endpoints

Pinned Lists lookup

Get your pinned Lists

Manage pinned Lists

Pin and unpin Lists

---

Authentication

Operation	Authentication
Look up pinned Lists	OAuth 1.0a or OAuth 2.0 PKCE
Pin/unpin Lists	OAuth 1.0a or OAuth 2.0 PKCE

Both lookup and manage operations require user context authentication. App-only (Bearer Token) authentication is not supported.

---

Quick example

cURL

shellscript

# Get pinned Lists
curl "https://api.x.com/2/users/2244994945/pinned_lists" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")

# Get pinned Lists
response = client.lists.get_pinned("2244994945")

for lst in response.data:
    print(f"{lst.name}")

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

const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });

// Get pinned Lists
const response = await client.lists.getPinned("2244994945");

response.data?.forEach((lst) => {
  console.log(lst.name);
});

---

Next steps

List lookup

Get List details

Manage Lists

Create and update Lists