Skip to main content
Documentation

Reviews

reviews.unreviewed_asks

List customers asked for a review who never left one
Read-onlyRead budget

REST

Shipping
POST /api/v1/reviews/unreviewed_asks

MCP tool

Live
reviews.unreviewed_asks

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

Operating contract

The follow-up list: people the shop asked, inside the window, who did not leave a review. One row per customer — their most recent ask, newest first.

can_nudge IS THE FIELD THAT MATTERS. It is computed against the same cooldown the send path enforces, so a true means asking again would actually go out and a false means it would be refused. blocked_reason says why, in plain language.

NEVER ASK SOMEBODY WHOSE can_nudge IS FALSE. The refusal is not a technicality — it is usually 'we asked them nine days ago', and the shop's promise that it never pesters the same customer twice is the thing being protected.

clicked: true with no review is the most interesting row: they opened the link and did not follow through. That is a different conversation from somebody who never saw the text.

TRUNCATION: omitted is how many further customers match. When it is not 0, narrow the window rather than working a partial list.

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 customers who were asked and did not review. Narrow `days` or raise `limit` rather than working a partial list.

Input

FieldTypeDescription
daysinteger7–365

How far back to look for asks, 7-365 days. Defaults to 90.

Default: 90
limitinteger1–100

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

Default: 25

Output

FieldTypeDescription
itemsobject[]

items[].customer_idstring

items[].namestring

items[].last_asked_atstring

items[].clickedboolean

items[].can_nudgeboolean

items[].blocked_reasonstring | null

cooldown_daysnumber

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/unreviewed_asks \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"days":90,"limit":25}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/reviews/unreviewed_asks", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "days": 90,
    "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/unreviewed_asks",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "days": 90,
    "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.unreviewed_asks",
    "arguments": {
      "days": 90,
      "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.