Documentation
Comms
comms.get_conversation
REST
ShippingPOST /api/v1/comms/get_conversationMCP tool
Livecomms.get_conversationExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Comms domain.
Operating contract
One thread's own record, plus the two things a reply depends on: who the contact is, and whether the shop is allowed to text them.
texting_blocked IS THE ONE TO READ BEFORE COMPOSING ANYTHING. It is true when the customer has opted out of texts from this shop — a STOP they sent the carrier, or a block a member of staff applied. comms.send_message will refuse, correctly, but finding that out after drafting wastes a turn and, worse, a model that treats the refusal as a transient error will retry it.
marketing_consent is a different question with a different answer: it governs campaigns, not replies. A customer who consented to nothing may still be answered when they wrote in first — that is a conversation, not marketing.
For the messages themselves call comms.list_messages with this thread's id. For what has been promised on the phone call comms.get_call_analysis on any call whose conversation is this id.
Who may call it
- Permission
inbox.accessThe caller must hold Inbox at the ACT level. A read-only dashboard grant on the same section is refused.- Plan
- Every planNo plan gate. Available on every Service VIN plan.
- Retries
naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.- Rate class
readCounted against the read budget — the widest of the four.
Input
| Field | Type | Description |
|---|---|---|
| conversationrequired | stringuuid | The thread's id, as returned by comms.list_conversations. |
Output
| Field | Type | Description |
|---|---|---|
| conversation | object | — |
| conversation.id | string | — |
| conversation.customer_id | string | null | — |
| conversation.channel | string | — |
| conversation.status | string | — |
| conversation.subject | string | null | — |
| conversation.contact_number | string | null | — |
| conversation.assigned_to | string | null | — |
| conversation.pinned | boolean | — |
| conversation.unread | boolean | — |
| conversation.is_ai_managed | boolean | — |
| conversation.last_message_at | string | null | — |
| conversation.last_inbound_at | string | null | — |
| conversation.last_outbound_at | string | null | — |
| conversation.last_human_outbound_at | string | null | — |
| conversation.created_at | string | — |
| customer_id | string | null | — |
| customer_name | string | null | — |
| customer_phone | string | null | — |
| customer_email | string | null | — |
| texting_blocked | boolean | — |
| marketing_consent | boolean | — |
Examples
Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.
export SERVICEVIN_API_KEY=svk_live_…
curl -X POST https://www.servicevin.com/api/v1/comms/get_conversation \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"conversation":"…"}'const res = await fetch("https://www.servicevin.com/api/v1/comms/get_conversation", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"conversation": "…"
}),
});
// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/comms/get_conversation",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"conversation": "…"
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["code"])
data = payload["data"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "comms.get_conversation",
"arguments": {
"conversation": "…"
}
}
}Refusals
The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.
| Status | Code | When |
|---|---|---|
| 404 | not_found | The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both. |
| 403 | forbidden | This login does not hold inbox.access. |
| 422 | validation_error | An argument was wrong. The message names the field. |
| 429 | rate_limited | Too many read calls. Back off and retry. |
| 500 | internal_error | Something failed on our side. Nothing was changed. |