Skip to main content
GET
Get Chat Conversations; unread state via chat_conversation.fields=unread,last_read_event_id,newest_event_id

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
Required range: 1 <= x <= 1000
pagination_token
string
unread_only
boolean
default:false

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

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:
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