Skip to main content
GET
Get Chat Conversation Pinned Messages

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
users.read
View any account you can see, including protected accounts.
dm.read
Read all your Direct Messages.
tweet.read
View all posts you can see, including those from protected accounts.

Path Parameters

id
string
required

The ID of the conversation: a group ID starting with g, the other user's ID for a 1:1 conversation, or both user IDs of a 1:1 conversation joined by a hyphen.

Pattern: ^([0-9]{1,19}|[0-9]{1,19}-[0-9]{1,19}|g[0-9]{1,19})$

Query Parameters

pagination_token
string

The next_token from a previous response, to fetch the next page.

Pattern: ^[0-9]{1,19}$
chat_pinned_message.fields
enum<string>[]

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

Minimum array length: 1
Available options:
encoded_event

Response

The request has succeeded.

data
object[]
errors
object[]
meta
object