GET
List agent conversations

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

status
enum<string>

active is the merchant's working inbox, closed is the archive. Omit it for both, which the dashboard can only ask for as status=all. A value outside this set is a 400 rather than an ignored filter, because a closed conversation served as part of an unfiltered page reads as one still waiting on a reply.

Available options:
active,
closed
handoff_state
enum<string>

human is the queue that matters operationally: the assistant has stopped answering those and a real person is waiting.

Available options:
bot,
human
channel
enum<string>

Where the shopper reached this store. It also decides where a reply is delivered.

Available options:
website,
whatsapp,
instagram
assigned_to
string

One teammate's conversations, by store user id. The id is CHECKED against the store roster: a user who is not a member is a 400, not an empty page, because an empty page is indistinguishable from "this teammate has no conversations" and a filter naming a renamed or offboarded teammate would otherwise report no work forever. An EMPTY value is a 400 rather than "no filter": a client building the query from a variable it forgot to set would otherwise receive the whole inbox and read it as one person's workload. There is no way to ask for the unassigned ones here.

updated_after
string<date-time>

Conversations touched at or after this RFC3339 instant, for reconciling incrementally instead of re-reading the whole list. Supplying it CHANGES THE ORDER of this endpoint: the default walk descends created_at, and this one climbs updated_at, because that is the only ordering in which a keyset walk over a column every reply rewrites cannot skip a row. A conversation that changes mid-walk moves forward past your position and is returned again, so the walk is AT LEAST ONCE: apply the state of each row you receive and a repeat costs nothing. A cursor from one ordering is refused by the other, since the same position means something different in each.

limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100
after
string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object