Skip to main content
GET
Get a chat by ID

Authorizations

Authorization
string
header
required

Bearer token authentication. Include your API token in the Authorization header.

Format: Authorization: Bearer <your-token>

Path Parameters

chatId
string<uuid>
required

Unique identifier of the chat

Response

Chat found and returned successfully

id
string<uuid>
required

Unique identifier for the chat

display_name
string | null
required

Display name for the chat. Defaults to a comma-separated list of recipient handles. Can be updated for group chats.

handles
object[]
required
is_group
boolean
default:false
required

Whether this is a group chat

created_at
string<date-time>
required

When the chat was created

updated_at
string<date-time>
required

When the chat was last updated

group_chat_icon
string<uri> | null

URL of the group chat icon. Only set for group chats that have an icon; null otherwise.