Skip to main content
GET
Get a chat session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

session_id
string
required

The unique identifier of the chat session

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>
required
Available options:
open,
closed_resolved,
closed_unresolved
ai_closure_type
enum<string> | null
required
Available options:
assumed_resolved,
handed_off,
resolved
sentiment
enum<string> | null
required
Available options:
angry,
happy,
neutral
summary
string | null
required

AI-generated summary of the conversation. Populated for both AI-resolved and handed-off sessions once the session has been summarized; null otherwise.

channel
object
required
ticket_number
number
required
assist_mode
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
contact
object
language
string
assignee_id
string | null
custom_data
object

Session-level custom data stored on the chat session.

team
object
handoff
object
ticketing_system
object