Skip to main content
GET
Paginated Search Conversations

Authorizations

Authorization
string
header
required

Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>

Query Parameters

query
string
required

Search query (minimum 3 characters)

Minimum string length: 3
filters
string

JSON-encoded filter. Either an array of conditions that are AND-ed, e.g. [{"model":"conversations","field":"status_id","operator":"equals","value":"1"}], or a group {"logic":"AND","rules":[...]} with at most one level of nested groups. Operators: equals, not equals, greater than, less than, set, not set, in, between, contains, ilike, not contains. Filterable fields: conversations (status_id, priority_id, assigned_team_id, assigned_user_id, inbox_id, last_message_at, last_interaction_at, last_interaction_sender, created_at, waiting_since, next_sla_deadline_at, snoozed_until, sla_policy_id, tags), conversation_statuses (id, name), users (email, external_user_id), inboxes (channel).

sort
enum<string>
default:newest

newest and oldest sort by last message time. started_last and started_first sort by creation time. Defaults to newest.

Available options:
newest,
oldest,
started_first,
started_last
cursor
string

next_cursor from the previous page. A cursor works only with the sort it was created with.

page_size
integer
default:30

Number of results per page (defaults to 30). Values above 100 use 100.

Required range: 1 <= x <= 100

Response

Search results retrieved successfully

status
string
Example:

"success"

data
object