Median

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

NameInTypeRequiredDescription
archivedquerybooleanNotrue for the archive instead of the inbox.
statusquery"open" | "resolved" | "closed"No
channelquery"widget" | "email" | "discord" | "site"No
needsHumanquerybooleanNotrue for only conversations waiting on a person.
limitqueryintegerNoUp to 200. Default 50.

Responses

StatusDescription
200The matching conversations, newest first.
401The bearer token is missing, revoked, or expired.
429Too many requests. Wait the seconds in Retry-After. Limits depend on the plan. See rate limits.

200 body

FieldTypeRequiredDescription
conversationsobject[]No
conversations[].idstringNo
conversations[].threadIdanyNoW-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[].subjectstringNo
conversations[].previewstringNo
conversations[].status"open" | "resolved" | "closed"No
conversations[].aiStatus"handling" | "drafting" | "needs a person" | "paused"No
conversations[].channel"widget" | "email" | "discord" | "site"No
conversations[].assigneeanyNoThe teammate holding it, by name, or null while the AI has it.
conversations[].isUnreadbooleanNo
conversations[].isArchivedbooleanNo
conversations[].snoozedUntilanyNo
conversations[].lastMessageAtintegerNo
conversations[].createdAtintegerNo
conversations[].customerobjectNo
conversations[].customer.idanyNo
conversations[].customer.nameanyNo
conversations[].customer.customerNumberanyNo
conversations[].customer.emailanyNo

Example request

curl https://api.median.sh/v1/conversations \
  -H "Authorization: Bearer $BEARER_AUTH"

Still need help?

    Esc