GET /conversations
Updated Oct 1, 20261 minute read
List conversations
The newest 200 conversations on one side of the archive, filters applied within that page. The same page the inbox reads.
Part of Conversations.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
archived | query | boolean | No | true for the archive instead of the inbox. |
status | query | "open" | "resolved" | "closed" | No | |
channel | query | "widget" | "email" | "discord" | "site" | No | |
needsHuman | query | boolean | No | true for only conversations waiting on a person. |
limit | query | integer | No | Up to 200. Default 50. |
Responses
| Status | Description |
|---|---|
200 | The matching conversations, newest first. |
401 | The bearer token is missing, revoked, or expired. |
429 | Too many requests. Wait the seconds in Retry-After. Limits depend on the plan. See rate limits. |
200 body
| Field | Type | Required | Description |
|---|---|---|---|
conversations | object[] | No | |
conversations[].id | string | No | |
conversations[].threadId | any | No | W-12: the workspace's initial and the thread's number, which is how the team refers to it. Null for a thread from before numbers existed. |
conversations[].subject | string | No | |
conversations[].preview | string | No | |
conversations[].status | "open" | "resolved" | "closed" | No | |
conversations[].aiStatus | "handling" | "drafting" | "needs a person" | "paused" | No | |
conversations[].channel | "widget" | "email" | "discord" | "site" | No | |
conversations[].assignee | any | No | The teammate holding it, by name, or null while the AI has it. |
conversations[].isUnread | boolean | No | |
conversations[].isArchived | boolean | No | |
conversations[].snoozedUntil | any | No | |
conversations[].lastMessageAt | integer | No | |
conversations[].createdAt | integer | No | |
conversations[].customer | object | No | |
conversations[].customer.id | any | No | |
conversations[].customer.name | any | No | |
conversations[].customer.customerNumber | any | No | |
conversations[].customer.email | any | No |
Example request
curl https://api.median.sh/v1/conversations \
-H "Authorization: Bearer $BEARER_AUTH"