Skip to content

List chat agent conversations

POST
/voice/chat-agent/conversations

READ-ONLY, despite the verb - voice takes the filter as a body.

Also in READ_ONLY_POST_ROUTES, for the same reason as the history route.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

Which agent’s conversations, and any paging.

object
key
additional properties
any

Responses

200

Successful Response

object
data
required

A LIST result from voice, normalised so items is always present.

Voice is inconsistent about whether a list comes back bare or under a named key (collections, files, routes, chats, …). Both are preserved: the original key is kept for anyone reading voice’s docs, and items always holds the same rows so a client can page one way.

object
items
Array
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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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