Skip to main content
Documentation

Customers

customers.list

Search the customer book by name, email or phone
Read-onlyRead budget

REST

Shipping
POST /api/v1/customers/list

MCP tool

Live
customers.list

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

Operating contract

Returns customers newest-first, or the ones matching q when it is set.

q is matched against the customer's display name, email and phone at once, so a partial name or a partial number both work; leave it out to list the whole book.

Every result's id is what customers.get, customers.update, vehicles.list, jobs.list and quotes.list all take as customer_id.

TRUNCATION: total is the exact number of customers matching the filter and omitted is how many of them are NOT in this response. When omitted is greater than 0 you have an incomplete answer — call again with offset set to next_offset, or narrow q. Do not summarise the book from a response whose omitted is not 0.

Who may call it

Permission
customers.accessThe caller must hold Customers 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 book. Call again with `offset` set to `next_offset`, or narrow `q`.

Input

FieldTypeDescription
qstringmax 120 chars

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

limitinteger1–100

How many customers 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[].citystring | null

items[].regionstring | null

items[].postal_codestring | null

items[].tagsstring[]

items[].is_vipboolean

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/customers/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/customers/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/customers/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": "customers.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 customers.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.