Skip to main content
GET
Export conversations

Authorizations

Authorization
string
header
required

API key from your account settings

Path Parameters

agentId
string
required

The agent ID

Minimum string length: 1
Example:

"5QHA6VB-DIAbBhxwqxfdi"

Query Parameters

cursor
string

Opaque cursor from a previous response to fetch the next page

Example:

"eyJ0IjoiMjAyNC0wMS0xNVQxMDozMDowMC4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="

limit
integer
default:20

Number of items per page (1–20, default 20)

Required range: 1 <= x <= 20
Example:

20

startDate
string

Only return conversations created at or after this point. Accepts a calendar date (YYYY-MM-DD, interpreted as the start of that day in UTC) or an ISO 8601 date-time.

Example:

"2024-01-01"

endDate
string

Only return conversations created at or before this point. Accepts a calendar date (YYYY-MM-DD, interpreted as the end of that day in UTC, so the day itself is included) or an ISO 8601 date-time.

Example:

"2024-01-31"

conversationId
string

Return only the conversation with this ID. Use this to fetch a single conversation from any source (widget, API, WhatsApp, etc.).

include
enum<string>
default:messages

Whether to include message bodies. summary omits them and skips reading them from the database — use it to triage a page cheaply, then re-request a specific conversation with conversationId. Defaults to messages.

Available options:
summary,
messages
Example:

"summary"

source
string

Comma-separated conversation sources to include, e.g. API,WhatsApp. Omit for all sources.

Example:

"Widget or Iframe"

Response

Paginated list of conversations with full message history

data
object[]
required
pagination
object
required