Median

GET /conversations/{id}

Updated Oct 1, 20261 minute read

Get a conversation

The whole thread, up to the most recent 200 messages, team-only notes and system narration included.

Part of Conversations.

Parameters

NameInTypeRequiredDescription
idpathstringYesA conversation id.

Responses

StatusDescription
200The conversation and its messages, oldest first.
401The bearer token is missing, revoked, or expired.
404Not one of yours, or not there at all.
429Too many requests. Wait the seconds in Retry-After. Limits depend on the plan. See rate limits.

200 body

FieldTypeRequiredDescription
conversationobjectNo
conversation.idstringNo
conversation.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.
conversation.subjectstringNo
conversation.previewstringNo
conversation.status"open" | "resolved" | "closed"No
conversation.aiStatus"handling" | "drafting" | "needs a person" | "paused"No
conversation.channel"widget" | "email" | "discord" | "site"No
conversation.assigneeanyNoThe teammate holding it, by name, or null while the AI has it.
conversation.isUnreadbooleanNo
conversation.isArchivedbooleanNo
conversation.snoozedUntilanyNo
conversation.lastMessageAtintegerNo
conversation.createdAtintegerNo
conversation.customerobjectNo
conversation.customer.idanyNo
conversation.customer.nameanyNo
conversation.customer.customerNumberanyNo
conversation.customer.emailanyNo
pageobject | nullNoWhere the visitor was when they started it, or null.
messagesobject[]No
messages[].idstringNo
messages[].createdAtintegerNo
messages[].author"visitor" | "ai" | "human" | "system" | "note"Novisitor is the customer, ai the agent, human a teammate, system the thread narrating itself, note team-only.
messages[].authorNameanyNo
messages[].bodystringNo
messages[].pendingbooleanNo
messages[].attachmentsobject[]No
messages[].attachments[].idstringNo
messages[].attachments[].namestringNo
messages[].attachments[].sizeintegerNo
messages[].attachments[].typestringNo
messages[].attachments[].urlanyNo
messages[].toolCallsobject[]No
messages[].toolCalls[].namestringNo
messages[].toolCalls[].inputstringNo
messages[].toolCalls[].outputanyNo
messages[].aiErroranyNo

Example request

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

Still need help?

    Esc