Skip to main content
GET
List 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.

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.

limit
integer
default:50

How many to return. 50 unless you say, 200 at most.

Required range: 1 <= x <= 200
offset
integer
default:0

How many to skip, for the next page.

Required range: x >= 0

Response

One page of conversations.

results
object[]
required
limit
integer
required
offset
integer
required
has_more
boolean
required

Whether there is another page after this one.

total
integer
required

How many conversations match in all.