Skip to content

Get Inbox Chat

GET
/inbox/chats/{chat_id}

One chat thread, with its messages.

Returned whole rather than wrapped in a page: this is a single Chat, and forcing it into an items list would hide the thread from a caller reading the obvious field.

Authorizations

Parameters

Path Parameters

chat_id
required

Chat id.

string

Chat id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

A page of threads, or one thread, exactly as the inbox returns it.

object
items
Array<object>
object
key
additional properties
any
total
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string