Skip to main content
GET
List conversations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

channel
enum<string>

Keep only threads that have carried this channel.

Available options:
sms,
sms_oneway,
whatsapp,
email,
telegram,
instagram,
messenger,
voice
senderId
string

Keep only threads last handled by this sender.

Search threads by identity: phone number (any format — +1 (555) 123-4567 and 15551234567 both match), email address (full or local part), WhatsApp group subject, WhatsApp username, or BSUID. Matching is by whole word, with prefix matching on the last term, so mar finds maria@example.com and +1555 finds +15551234567; a fragment from the middle or end of a number (4567) does not match.

It does not search message bodies — only who the thread is with.

Results come back ranked by relevance rather than by recency, so the usual "most recently active first" ordering does not apply while q is set. senderId and channel still narrow the results, and cursor paginates them as usual. An empty or whitespace-only q returns no items rather than the full list.

Required string length: 1 - 120
Example:

"+56912345678"

limit
integer
default:50
Required range: x <= 100
cursor
string

Opaque cursor from a previous response's nextCursor. Do not construct it.

Response

List of conversations.

items
object[]
required
nextCursor
string | null