Skip to main content
Documentation

Reviews

reviews.posts

List the posts the shop published beside its reviews on Google
Read-onlyRead budget

REST

Shipping
POST /api/v1/reviews/posts

MCP tool

Live
reviews.posts

Exposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Reviews domain.

Operating contract

What the shop has posted to its own public listing — updates, offers and events — with what state each one is in.

status says whether a post is a draft, scheduled, live or failed. A FAILED post is the finding: it never reached the public, and nothing else in the product will mention it. error says why.

publish_at in the future is a scheduled post that has not gone out yet.

search_url is where the post can actually be seen, once it is live.

READ ONLY. Publishing a post puts marketing under the shop's name on its own public listing, which is a decision the shop makes rather than an operation.

TRUNCATION: omitted is how many further posts exist. When it is not 0, raise limit.

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.

Partial answers

omitted is how many matching records are not in the response, and 0 is a real answer meaning you have all of them. There is no cursor here — narrow the filter instead.

Do not summarise from a truncated response

When `omitted` is not 0 there are more posts than came back. Call again with a bigger `limit`.

Input

FieldTypeDescription
limitinteger1–100

How many posts to return, 1-100. Defaults to 25.

Default: 25

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].statusstring

items[].cta_typestring | null

items[].cta_urlstring | null

items[].event_titlestring | null

items[].publish_atstring | null

items[].posted_atstring | null

items[].search_urlstring | null

items[].errorstring | null

items[].created_atstring

totalnumber

omittednumber

Examples

Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.

curl
export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/reviews/posts \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":25}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/reviews/posts", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "limit": 25
  }),
});

// 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;

Python (requests)
import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/reviews/posts",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "limit": 25
},
    timeout=30,
)
payload = res.json()
if not res.ok:
    raise RuntimeError(payload["error"]["code"])
data = payload["data"]

MCP tools/call — https://www.servicevin.com/api/mcp
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "reviews.posts",
    "arguments": {
      "limit": 25
    }
  }
}

Refusals

The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.

StatusCodeWhen
404not_foundThe id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403forbiddenThis login does not hold marketing.access.
422validation_errorAn argument was wrong. The message names the field.
429rate_limitedToo many read calls. Back off and retry.
500internal_errorSomething failed on our side. Nothing was changed.