Skip to main content
GET
List conversations (the unified inbox).

Authorizations

x-api-key
string
header
required

Your workspace API key. It both authenticates the caller and selects the workspace.

Query Parameters

q
string

Keyword filter matched (LIKE) against the contact name, handle or phone.

status
string

Inbox triage status. One of open or done.

unread
boolean

When truthy, only conversations with unread_count greater than 0.

platform
string

Filter by the contact's denormalised messaging platform (e.g. whatsapp, facebook, instagram, sms, telegram, livechat).

per_page
integer

Items per page (alias: limit). Default 25, hard cap 100.

Response

A paginated list.

A paginated collection. per_page defaults to 25 and is capped at 100.

data
object[]
meta
object