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.

Query Parameters

max_results
integer<int32>
default:200

Conversations covered per page (1-1000, default 200). Filtered pages can return fewer.

Required range: 1 <= x <= 1000
pagination_token
string

meta.next_token from the previous page. Send the same filters with it, or the request fails.

unread_only
boolean
default:false

Return only unread conversations. A page can be short; keep paging while has_more.

type
enum<string>

Only direct (1:1) or only group conversations. Omit for both.

Available options:
direct,
group
is_archived
boolean

true: only archived; false: only not archived. Omit for both.

is_muted
boolean

true: only muted; false: only not muted. Omit for both.

participant_ids
string[]

Comma-separated numeric user IDs (1-10), all in the chat. Names or @handles: use participant_query.

Required array length: 1 - 10 elements
Pattern: ^[0-9]{1,19}$
participant_query
string

Name or @username prefix (1-50 chars); keeps chats where any other participant matches it.

Required string length: 1 - 50
start_time
string<date-time>

ISO 8601, e.g. 2026-10-16T00:00:00Z. Chats whose latest message is at or after this time.

end_time
string<date-time>

ISO 8601, e.g. 2026-10-17T00:00:00Z. Chats whose latest message is before this time.

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_settings,
created_at,
group_avatar_url,
group_description,
group_description_key_version,
group_name,
id,
invite,
is_archived,
is_muted,
last_read_event_id,
message_ttl_ms,
newest_event_id,
pending_member_ids,
screen_capture_blocking_enabled,
screen_capture_detection_enabled,
type,
unread,
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:
active_follower_count,
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_chat,
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