Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.x.com/llms.txt

Use this file to discover all available pages before exploring further.

The Pinned Lists endpoints let you view, pin, and unpin Lists for the authenticated user. Pinned Lists appear prominently in the user’s X interface.

​
Overview

View pinned

Get user’s pinned Lists

Pin List

Pin a List

Unpin List

Unpin a List

​
Endpoints

MethodEndpointDescription
GET/2/users/:id/pinned_listsGet pinned Lists
POST/2/users/:id/pinned_listsPin a List
DELETE/2/users/:id/pinned_lists/:list_idUnpin a List

​
Example: Get pinned Lists

curl "https://api.x.com/2/users/123456789/pinned_lists?\
list.fields=name,description,member_count" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN"

​
Example: Pin a List

curl -X POST "https://api.x.com/2/users/123456789/pinned_lists" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"list_id": "9876543210"}'

​
Getting started

Prerequisites

Lookup quickstart

Get pinned Lists

Manage quickstart

Pin and unpin Lists

Integration guide

Key concepts and best practices

API Reference

Full endpoint documentation