Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Query Parameters

lead_id
string | null

The lead's id: the id from List or get leads. It is also the last part of that page's address in the app. Return the full thread with this lead.

channel
string | null

Filter by channel.

traffic_light
string | null

GREEN, YELLOW or RED.

archived
boolean
default:false
search
string | null
Required string length: 1 - 200
cursor
string | null
limit
integer
default:50
Required range: 1 <= x <= 100

Response

Successful Response

Paginated list envelope.

next_cursor is an opaque, AES-256-GCM-encrypted keyset position (see internal detail): pass it back as the cursor query param to get the next page. NULL when there are no more rows.

counts carries the aggregate totals that drive the filter chips (per connected service, per traffic light, unread, escalated) for the tenant's WHOLE inbox. It is returned on the first page only. The frontend previously derived these by counting the rows it had already loaded, which meant the chips silently under-reported everything past the first page.

items
ConversationOut · object[]
required

Items returned by the Sendora API.

counts
Counts · object | null

Counts returned by the Sendora API.

next_cursor
string | null

Next cursor returned by the Sendora API.