Skip to main content
Documentation

Leads

leads.unanswered

List the open leads nobody has replied to yet, oldest first
Read-onlyRead budget

REST

Shipping
POST /api/v1/leads/unanswered

MCP tool

Live
leads.unanswered

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

Operating contract

THE LIVE LIST BEHIND THE FIRST-RESPONSE REPORT. reports.sla says twelve enquiries were missed; this says WHICH twelve, with the name and the phone number, so somebody can pick up the phone.

SPEED IS THE WHOLE GAME ON A NEW ENQUIRY, and this is the one read where an unanswered lead is the finding rather than a row in a table. Every lead here is still open — a parked, won or lost lead is not waiting for anybody.

state is breached past the shop's target, warning past two thirds of it, and ok for one still comfortably inside. waiting_minutes is measured on the clock the shop chose: with business_hours_only set, an enquiry that landed at 9pm has not been waiting all night.

AN AI REPLY MAY OR MAY NOT COUNT, and the shop decides. When ai_satisfies is false a lead the voice agent already answered still appears here, because this shop's rule is that a person has to touch it.

enabled: false means the shop has the response clock switched off. The list is still honest — these leads genuinely have no reply — but the target it is measured against is the product's default rather than the shop's decision, and that is worth saying.

TRUNCATION: at most limit leads come back, oldest enquiry first, and omitted says how many more are waiting. A non-zero omitted on this particular read is itself the headline — it means the shop is further behind than the page shows.

Who may call it

Permission
leads.accessThe caller must hold Leads 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 unanswered leads than were returned. Raise `limit`, or set `breached_only` to see the ones already past the target first.

Input

FieldTypeDescription
breached_onlyboolean

True returns only leads already past the shop's target, not the ones still inside it.

limitinteger1–100

How many to return, 1-100, oldest enquiry first. Defaults to 25.

Default: 25

Output

FieldTypeDescription
enabledboolean

target_minutesnumber

business_hours_onlyboolean

ai_satisfiesboolean

itemsobject[]

items[].idstring

items[].namestring

items[].emailstring | null

items[].phonestring | null

items[].sourcestring | null

items[].statusstring

items[].assigned_tostring | null

items[].next_followup_atstring | null

items[].created_atstring

items[].waiting_minutesnumber

items[].statestring

items[].conversation_idstring | null

total_waitingnumber

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/leads/unanswered \
  -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/leads/unanswered", {
  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/leads/unanswered",
    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": "leads.unanswered",
    "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 leads.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.