Skip to main content
POST
ListChats
v2 available: See GET /v2/chats for the REST-native version of this endpoint.

Authorizations

Authorization
string
header
required

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

Headers

Connect-Protocol-Version
enum<number>
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
memberOnly
boolean
default:false

Whether to return only the user's chats (true) or all org chats (false)

searchTerm
string

Filter chats by summary or first message content

limit
integer<int32>

Maximum number of chats to return

Required range: x >= 0
offset
integer<int32>

Number of chats to skip

Required range: x >= 0
sortBy
enum<integer>

Sort field (0: unknown, 1: name, 2: created_at, 3: updated_at)

Available options:
0,
1,
2,
3
sortDirection
enum<integer>

Sort direction (0: unknown, 1: asc, 2: desc)

Available options:
0,
1,
2

Response

Success

chats
Chat · object[]
totalCount
integer<int32>