Skip to main content
GET
Get conversations

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
string
required

Query Parameters

user[email]
string<email>

Email of the company admin to act as. Required: it must match an admin recipient in the company's messaging.

Response

Success

A conversation as seen by the acting recipient. Per-recipient fields such as unread, pinned, and muted describe that recipient's view of the conversation. recipients lists at most six active participants; total_recipients is the full count.

id
integer | null
required
type
string
required

The conversation type, for example GroupConversation.

kind
string | null
required

The short conversation kind (direct, group, channel, or downline), or null for SMS, email, and bot conversations.

name
string | null
required
description
string | null
required
status
string | null
required

One of initiated, open, archived, or closed. A new conversation stays initiated until its first message.

conversation_type
string | null
required

internal for conversations between company members, external for conversations with contacts.

broadcasting
boolean | null
required
auto_add_recipients
boolean | null
required
announcing
boolean | null
required
avatar_background_color
string | null
required
avatar_emoji
string | null
required
avatar_url
string | null
required
image_url
string | null
required
created_at
string<date-time> | null
required
pinned_messages_count
integer | null
required
total_recipients
integer | null
required
unread
boolean | null
required
pinned
boolean | null
required
muted
boolean | null
required
unread_messages_count
integer | null
required
scheduled_messages_count
integer | null
required
email_enabled?
boolean | null
required
sms_enabled?
boolean | null
required
messaging_enabled?
boolean | null
required

Whether the acting recipient can post in the conversation.

draft_message
object | null
required

The acting recipient's unsent draft in this conversation, or null.

recipients
object[]
required
creator
object | null
required

The recipient who created a conversation.

audience
enum<string>

Who a channel is for; admins seats only the company's admins, now and as admins come and go.

Available options:
members,
admins
can_delete_any_message
boolean

Whether you may delete other people's messages here. True for the company's own admins in a channel; false in direct and group conversations and for guests from a company the channel is shared with.

purpose
string | null

What Fluid made the conversation for, support for the company's Fluid Support channel or ticket for a Cowork ticket's channel; null otherwise.

ticket
object | null

For a Cowork ticket's channel, the ticket it discusses; null otherwise.

host_company_name
string | null

For a guest from another company, the host company's name; null for the host's own people.

uuid_v7
string<uuid>

The stable UUIDv7 identifier. Messaging routes accept it wherever they accept the numeric id.

unread_mentions_count
integer | null

Unread messages that need you — every unread message in a direct or group conversation, only mentions in a channel. Shown as the numbered badge.

last_activity_at
string<date-time> | null

When anything last happened in the conversation.

last_opened_at
string<date-time> | null

When you last opened it (your seat's last read time); null without a seat.

last_replied_at
string<date-time> | null

When you last sent a message in it; null if you never have.