Skip to main content
GET
Count conversations

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Query Parameters

inbox_id
string

One inbox. An inbox this key may not read gives nothing, not an error.

channels
string

Only these kinds, comma separated: email, chat, sms, whatsapp, voicemail, call. The app's Mail asks for email,chat and its Phone for the rest. Every kind without it.

channel
enum<string>

One kind, within channels. The facets' channel group counts each kind inside channels, leaving this one out.

Available options:
email,
chat,
sms,
whatsapp,
voicemail,
call
status
enum<string>

Without it, every conversation that is not archived. With open, closed or spam, those that are not archived. With archived, only the archived ones.

Available options:
open,
closed,
spam,
archived
unread
enum<string>

true for unread conversations only.

Available options:
true
assigned_person_id
string

One person's conversations, or none for those nobody is handling.

Response

The counts.

total
integer
required

How many conversations match every filter.

unread
integer
required

How many of those are unread.

facets
object
required