Skip to main content
Documentation

Leads

leads.missed_intake

List the enquiries that arrived but never became a lead
Read-onlyRead budget

REST

Shipping
POST /api/v1/leads/missed_intake

MCP tool

Live
leads.missed_intake

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

Operating contract

THE BACKLOG, ROW BY ROW. leads.intake_health reports that forty submissions never landed; this is who they were and what they said, newest first, so the shop can call them back.

EVERY ROW HERE IS A REAL PERSON WHO TRIED TO CONTACT THIS SHOP and got nothing. That outranks almost anything else in the leads domain — a broken rail is a marketing spend that bought enquiries the shop never saw.

reason is why it did not land, and the two halves are completely different problems. honeypot and blocked are the spam filter working, and there is nothing to do. error, unreadable and rejected are this product or the rail failing, and those are the ones worth reading — replayable marks them.

fields is whatever the submission actually carried, unparsed, and who is the best guess at a name or a contact from it. The submission was rejected precisely because it could not be read cleanly, so treat both as raw material and never as a validated record.

ready: false means migration 0249 is not applied to this shop's database. There is then NO backlog table to read and an empty list is not evidence of anything — say so rather than reporting that nothing was missed.

REPLAYING OR DISMISSING ONE IS NOT HERE. Replay re-fires a third party's webhook into the intake, and dismissing hides a lost enquiry for good; both stay a person at /leads/intake.

TRUNCATION: at most limit rows come back. omitted is how many more are in the backlog; raise limit or narrow with source.

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 missed submissions than were returned. Raise `limit`, or narrow with `source` to work one broken rail at a time.

Input

FieldTypeDescription
sourcestringmax 60 chars

Narrow to one intake rail, spelled exactly as leads.intake_health's `by_source` spells it.

replayable_onlyboolean

True drops the ones the spam filter caught on purpose and leaves the ones that failed.

limitinteger1–200

How many to return, 1-200, newest first. Defaults to 50.

Default: 50

Output

FieldTypeDescription
readyboolean

itemsobject[]

items[].idstring

items[].sourcestring

items[].source_labelstring | null

items[].reasonstring

items[].detailstring

items[].whostring

items[].fieldsobject

items[].received_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/leads/missed_intake \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":50}'

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

// 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/missed_intake",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "limit": 50
},
    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.missed_intake",
    "arguments": {
      "limit": 50
    }
  }
}

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.