Skip to main content
GET
/
2
/
chat
/
conversations
Get Chat Conversations
curl --request GET \
  --url https://api.x.com/2/chat/conversations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "admin_ids": [
        "<string>"
      ],
      "created_at": "<string>",
      "group_avatar_url": "<string>",
      "group_name": "<string>",
      "is_muted": true,
      "member_ids": [
        "<string>"
      ],
      "message_ttl_msec": "<string>",
      "participant_ids": [
        "<string>"
      ],
      "screen_capture_blocking_enabled": true,
      "screen_capture_detection_enabled": true,
      "updated_at": "<string>"
    }
  ],
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ],
  "includes": {
    "media": [
      {
        "type": "<string>",
        "preview_image_url": "<string>",
        "variants": [
          {
            "bit_rate": 123,
            "content_type": "<string>",
            "url": "<string>"
          }
        ],
        "height": 1,
        "media_key": "<string>",
        "width": 1
      }
    ],
    "places": [
      {
        "full_name": "Lakewood, CO",
        "id": "f7eb2fa2fea288b1",
        "contained_within": [
          "f7eb2fa2fea288b1"
        ],
        "country": "United States",
        "country_code": "US",
        "geo": {
          "bbox": [
            -105.193475,
            39.60973,
            -105.053164,
            39.761974
          ],
          "properties": {},
          "geometry": {
            "coordinates": [
              -105.18816086351444,
              40.247749999999996
            ],
            "type": "Point"
          }
        },
        "name": "Lakewood",
        "place_type": "city"
      }
    ],
    "polls": [
      {
        "id": "1365059861688410112",
        "options": [
          {
            "label": "<string>",
            "position": 123,
            "votes": 123
          }
        ],
        "duration_minutes": 5042,
        "end_datetime": "2023-11-07T05:31:56Z"
      }
    ],
    "topics": [
      {
        "id": "<string>",
        "name": "Technology",
        "description": "All about technology"
      }
    ],
    "tweets": [
      {
        "author_id": "2244994945",
        "created_at": "Wed Jan 06 18:40:40 +0000 2021",
        "id": "1346889436626259968",
        "text": "Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i",
        "username": "XDevelopers"
      }
    ],
    "users": [
      {
        "created_at": "2013-12-14T04:35:55Z",
        "id": "2244994945",
        "name": "X Dev",
        "protected": false,
        "username": "TwitterDev"
      }
    ]
  },
  "meta": {
    "has_message_requests": true,
    "has_more": true,
    "next_token": "<string>",
    "result_count": 123
  }
}

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.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
max_results
integer<int32>
default:10

Maximum number of conversations to return.

Required range: 1 <= x <= 100
​
pagination_token
string

Token for pagination to retrieve the next page of results.

​
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:
admin_ids,
created_at,
group_avatar_url,
group_name,
id,
is_muted,
member_ids,
message_ttl_msec,
participant_ids,
screen_capture_blocking_enabled,
screen_capture_detection_enabled,
type,
updated_at
Example:
[
  "admin_ids",
  "created_at",
  "group_avatar_url",
  "group_name",
  "id",
  "is_muted",
  "member_ids",
  "message_ttl_msec",
  "participant_ids",
  "screen_capture_blocking_enabled",
  "screen_capture_detection_enabled",
  "type",
  "updated_at"
]
​
expansions
enum<string>[]

A comma separated list of fields to expand. The list of fields you can expand for a ChatConversation object. If the field has an ID, it can be expanded into a full object.

Minimum array length: 1
Available options:
admin_ids,
member_ids,
participant_ids
Example:
[
  "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:
affiliation,
confirmed_email,
connection_status,
created_at,
description,
entities,
id,
is_identity_verified,
location,
most_recent_tweet_id,
name,
parody,
pinned_tweet_id,
profile_banner_url,
profile_image_url,
protected,
public_metrics,
receives_your_dm,
subscription,
subscription_type,
url,
username,
verified,
verified_followers_count,
verified_type,
withheld
Example:
[
  "affiliation",
  "confirmed_email",
  "connection_status",
  "created_at",
  "description",
  "entities",
  "id",
  "is_identity_verified",
  "location",
  "most_recent_tweet_id",
  "name",
  "parody",
  "pinned_tweet_id",
  "profile_banner_url",
  "profile_image_url",
  "protected",
  "public_metrics",
  "receives_your_dm",
  "subscription",
  "subscription_type",
  "url",
  "username",
  "verified",
  "verified_followers_count",
  "verified_type",
  "withheld"
]

Response

The request has succeeded.

​
data
object[]

List of conversations in the user's inbox.

​
errors
object[]
Minimum array length: 1

An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).

​
includes
object
​
meta
object