Skip to main content
Documentation

Leads

leads.list

Search the lead pipeline by name, status, owner or source
Read-onlyRead budget

REST

Shipping
POST /api/v1/leads/list

MCP tool

Live
leads.list

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

Operating contract

The shop's pipeline, newest-first, narrowed by any combination of the filters. Leave every filter out to see the whole board.

q matches a partial name, email or phone at once. status narrows to one pipeline stage — call leads.statuses for the list rather than guessing at spellings. assignee narrows to one owner's leads, and unassigned: true returns the ones nobody has picked up, which is the question behind 'what is falling through the cracks'.

due_only: true returns just the leads whose follow-up date has arrived or passed — the working list for 'who should I chase today'.

Every result's id is what leads.get, leads.update, leads.set_status, leads.assign and leads.find_duplicates all take as lead_id.

TRUNCATION: total is the exact number of leads matching the filters and omitted is how many of them are NOT in this response. When omitted is greater than 0 you are looking at part of the pipeline — call again with offset set to next_offset, or narrow the filters. Never summarise a shop's pipeline from a response whose omitted is not 0.

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. Continue with next_offset.

Do not summarise from a truncated response

When `omitted` is not 0 you are looking at part of the pipeline. Call again with `offset` set to `next_offset`, or narrow the filters.

Input

FieldTypeDescription
qstringmax 120 chars

Part of a name, email address or phone number. Omit to list everyone.

statusstring

One pipeline status, as listed by leads.statuses.

One of: new, contacted, qualified, quoted, won, lost, cold
assigneestringuuid

One teammate's user id, as returned by leads.assignees. Returns only the leads they own.

unassignedboolean

True returns only leads with no owner. Cannot be combined with assignee.

sourcestringmax 60 chars

One source key, as returned by leads.sources.

due_onlyboolean

True returns only leads whose follow-up date has arrived or passed.

limitinteger1–100

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

Default: 25
offsetintegermin 0

How many to skip. Pass the previous response's next_offset to continue.

Default: 0

Output

FieldTypeDescription
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

totalnumber

omittednumber

next_offsetnumber | null

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

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

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

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.