A valid request URL is required to generate request examples{
"environment": "live",
"conversations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "email",
"subject": "<string>",
"status": "open",
"priority": "low",
"assignee_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"snoozed_until": "2023-11-07T05:31:56Z",
"first_responded_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"last_message_at": "2023-11-07T05:31:56Z",
"last_contact_message_at": "2023-11-07T05:31:56Z",
"first_response_due_at": "2023-11-07T05:31:56Z",
"resolution_due_at": "2023-11-07T05:31:56Z",
"sla_first_breached_at": "2023-11-07T05:31:56Z",
"sla_resolution_breached_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}List conversations
Requires support:read. The inbox: one environment’s conversations, newest movement first. Every filter is optional and they combine — status, priority, assignee, unassigned=true (its own flag, because “no assignee” and “any assignee” are different questions), tag, and q, which matches the subject only.
There is no POST here and never will be: an inbox receives. A conversation is opened by the contact (chat) or by an inbound email.
A valid request URL is required to generate request examples{
"environment": "live",
"conversations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "email",
"subject": "<string>",
"status": "open",
"priority": "low",
"assignee_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"snoozed_until": "2023-11-07T05:31:56Z",
"first_responded_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"last_message_at": "2023-11-07T05:31:56Z",
"last_contact_message_at": "2023-11-07T05:31:56Z",
"first_response_due_at": "2023-11-07T05:31:56Z",
"resolution_due_at": "2023-11-07T05:31:56Z",
"sla_first_breached_at": "2023-11-07T05:31:56Z",
"sla_resolution_breached_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Query Parameters
Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.
live, test open, pending, snoozed, resolved low, normal, high, urgent Conversations assigned to this member.
true narrows to conversations nobody has taken.
Substring match on the subject.
Page size. Values outside 1–200 fall back to 50.
1 <= x <= 200x >= 0