Skip to main content
POST
Get chat
Required scopes: or

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
chat_id
string
required

The chat ID.

thread_id
string

The thread ID. Default: the latest thread (if exists).

Response

200 - application/json

Chat with the requested thread.

id
string

Chat ID.

users
object[]

Array of user objects (agents and customers).

thread
object

Thread object. For full field details, see the Agent Chat API data structures reference.

properties
object

Custom properties organized by namespace, then property name.

access
object

Access object defining which groups can access the chat or thread.

is_followed
boolean

Whether the chat is followed by the requester.