Skip to main content
GET
Get Chat Conversations

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

Query Parameters

max_results
integer<int32>
default:10
Required range: 1 <= x <= 100
pagination_token
string
chat_conversation.fields
enum<string>[]

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

Minimum array length: 1
Available options:
created_at,
group_avatar_url,
group_name,
id,
is_muted,
message_ttl_ms,
screen_capture_blocking_enabled,
screen_capture_detection_enabled,
type,
updated_at
expansions
enum<string>[]

A comma separated list of fields to expand.

Minimum array length: 1
Available options:
admin_ids,
member_ids,
participant_ids
user.fields
enum<string>[]

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

Minimum array length: 1
Available options:
confirmed_email,
connection_status,
created_at,
description,
entities,
id,
is_identity_verified,
location,
name,
parody,
profile_banner_url,
profile_image_url,
protected,
public_metrics,
receives_your_dm,
subscriber_count,
subscribes_to_you,
subscription,
subscription_type,
url,
username,
verified,
verified_followers_count,
verified_type,
withheld

Response

The request has succeeded.

data
object[]
errors
object[]
includes
object
meta
object