Skip to main content
GET
List conversations

Autorisierungen

Authorization
string
header
erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

Abfrageparameter

page
integer
Standard:1

Page number, starting at 1.

Erforderlicher Bereich: x >= 1
per_page
integer
Standard:20

Conversations per page (1-50).

Erforderlicher Bereich: 1 <= x <= 50
from_date
string

Inclusive lower bound on the creation time. ISO 8601 date or timestamp; a value without offset is read in Europe/Berlin time.

Beispiele:

"2026-10-01"

"2026-10-01T08:00:00+02:00"

to_date
string

Inclusive upper bound on the creation time. ISO 8601 date or timestamp. Must not be earlier than from_date.

number
string

Filter by voice agent: its id, or its phone number. all disables the filter.

from_number
string

Substring match on the caller or sender number.

search_text
string

Substring match on the conversation name, caller number or dialed number. Transcript content is not searched.

channel
enum<string>

Restrict to one channel. Repeat the parameter as channel[]=voice&channel[]=whatsapp to select several. Unknown values are ignored.

Verfügbare Optionen:
voice,
livechat,
whatsapp,
email
result
string

Restrict to conversations with a given call result (outcomes of voice tool calls). Accepts a result key such as appointment_booked, transferred or sms_sent; group:<category> for a whole category (forwarding, appointments, messaging, transfer, api_calls); api_call:<tool name> for one API tool; any for conversations with at least one result; all for no filter.

Beispiele:

"appointment_booked"

"group:transfer"

"api_call:get_customer"

"any"

Antwort

A page of conversations.

conversations
object[]
erforderlich

The page of conversations, newest first.

current_page
integer
erforderlich

Page returned.

per_page
integer
erforderlich

Page size applied.

has_more
boolean
erforderlich

True when another page exists. Totals are not provided.