Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Body

application/json
filter_criteria
object

Filter criteria for chats to retrieve.

sort_order
enum<string>
default:descending

Sort chats by start_timestamp in ascending or descending order.

Available options:
ascending,
descending
limit
integer
default:50

Maximum number of chats to return.

Required range: x <= 1000
skip
integer
default:0

Number of records to skip for pagination.

Required range: x >= 0
pagination_key
string

Opaque pagination cursor from a previous response.

include_total
boolean
default:false

Whether to include total (count of all chats matching filter_criteria, ignoring limit/skip/pagination_key) in the response. Defaults to false. Each enabled request triggers an additional aggregate query, so opt in only when the total is needed.

Response

Successfully retrieved chats.

pagination_key
string

Pagination key for the next page.

has_more
boolean

Whether more results are available.

items
object[]
total
integer

Total number of chats matching filter_criteria. Only present when include_total is true.