Skip to main content
GET
Search 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

startDate
string

Created at or after this point (YYYY-MM-DD or ISO 8601). Must be inside the searchable window.

endDate
string

Created at or before this point (YYYY-MM-DD, inclusive, or ISO 8601).

query
string

Free-text search over messages and titles.

Maximum string length: 512
Example:

"refund"

source
string

Comma-separated sources, e.g. API,WhatsApp.

Example:

"Widget or Iframe"

sentiment
string

Comma-separated: positive, neutral, negative, or unspecified for none.

Example:

"negative"

topic
string

Comma-separated topic names, or unspecified for none.

Example:

"billing"

userId
string

Comma-separated user IDs.

activityState
string

Comma-separated: ongoing, ended, taken_over, paused.

Example:

"taken_over"

feedback
string

Comma-separated message ratings: positive, negative.

Example:

"negative"

escalated
enum<string>

true: only conversations escalated to a human (ticket or live-chat handoff).

Available options:
true
Example:

"true"

actionType
string

Comma-separated action types that ran, e.g. collect-leads.

tool
string

Comma-separated tool names that were called.

toolOutcome
string

Comma-separated tool result statuses, e.g. error. Scoped to tool when set.

Example:

"error"

procedure
string

Comma-separated procedure names that ran.

procedureOutcome
string

Comma-separated procedure run statuses. Scoped to procedure when set.

Example:

"completed"

hasVoice
enum<string>

Whether a voice session took place.

Available options:
true,
false
updatedAfter
string

Last active at or after this point (YYYY-MM-DD or ISO 8601).

updatedBefore
string

Last active at or before this point (YYYY-MM-DD, inclusive, or ISO 8601).

cursor
string

pagination.cursor from the previous page. Keep the other parameters unchanged.

Maximum string length: 2048
limit
integer
default:25

Items per page (1 to 25, default 25)

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

25

Response

Matching conversations

data
object[]
required
pagination
object
required