Skip to main content
GET
List conversations

Authorizations

Authorization
string
header
required

A Bearer token. Create keys in the portal under Settings > API keys (https://app.ryvo.so/developers). The token has the form ryvo_live_<64 hex characters> and is shown once.

Header: Authorization: Bearer ryvo_live_...

Query Parameters

limit
integer
default:20

Page size, 1 to 100. Default 20.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page. Opaque.

Example:

"eyJvIjoyMH0"

from
string

Only items at or after this instant. An ISO 8601 date (2026-09-01) or datetime.

Example:

"2026-09-01T00:00:00Z"

to
string

Only items at or before this instant. An ISO 8601 date or datetime.

Example:

"2026-09-30T23:59:59Z"

agent_id
string<uuid>

The Ryvo uuid of an agent on either runtime. An unknown id yields an empty list.

status
enum<string>
Available options:
completed,
failed,
unknown
channel
enum<string>
Available options:
phone,
widget_voice,
chat,
widget_chat,
whatsapp,
unknown
Example:

"phone"

phone
string

An E.164 number.

Pattern: ^\+[1-9]\d{6,14}$

Response

A page of conversations.

The envelope of every list. data is typed per endpoint.

data
object[]
required
has_more
boolean
required

Whether another page exists.

Example:

true

next_cursor
string | null
required

Pass as ?cursor= to fetch the next page. null on the last page.

Example:

"eyJvIjoyMH0"