Documentation
Reviews
reviews.get
REST
ShippingPOST /api/v1/reviews/getMCP tool
Livereviews.getExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Reviews domain.
Operating contract
One review in full: who left it, what they said, when, and what the shop replied.
customer_id is set when this review has been matched to the shop's own book. READ THAT CUSTOMER BEFORE WRITING A REPLY. A reply that names the work they actually had done reads as a shop that remembers them; a reply that does not reads as a template, and the next prospective customer can tell.
reply already set means the shop has answered. Replying again REPLACES the existing reply on the public listing — it does not add a second one — so read this first and decide deliberately.
stars: null means the platform gave no rating. comment: null means a rating with no words, and there is genuinely nothing to answer.
Refuses when nothing in this shop has that id.
Who may call it
- Permission
marketing.accessThe caller must hold Reviews & market 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 |
|---|---|---|
| review_idrequired | stringuuid | The review's id, as returned by reviews.list. |
Output
| Field | Type | Description |
|---|---|---|
| id | string | — |
| reviewer_name | string | null | — |
| stars | number | null | — |
| comment | string | null | — |
| reply | string | null | — |
| replied_at | string | null | — |
| left_at | string | null | — |
| customer_id | string | null | — |
| location_name | string | null | — |
| first_seen_at | string | — |
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/reviews/get \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"review_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"}'const res = await fetch("https://www.servicevin.com/api/v1/reviews/get", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"review_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
}),
});
// 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/reviews/get",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"review_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
},
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": "reviews.get",
"arguments": {
"review_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
}
}
}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 marketing.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. |