Skip to main content
Documentation

Services

services.list

List the services on the shop's menu and their prices
Read-onlyRead budget

REST

Shipping
POST /api/v1/services/list

MCP tool

Live
services.list

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

Operating contract

The shop's price book, in menu order. Filter by category, by q against the name, and by the three flags that decide where a service appears.

THE THREE FLAGS DO DIFFERENT JOBS AND ARE OFTEN CONFUSED. active is whether the shop still sells it at all. bookable is whether it shows on the PUBLIC booking page — an active service can be deliberately dashboard-only. addon marks an EXTRA that is sold alongside something else rather than booked on its own.

pricing_model decides which price field means anything. flat, per_sqft and per_hour carry a base_price; tiered carries NO base price and its real prices are per vehicle size — call services.tiers for those. custom is by-quote and has no set price at all, which is a real answer and not missing data.

Every id here is what services.get, services.tiers, services.update_price, services.set_online, booking.availability and booking.deposit_due all take.

TRUNCATION: total is the exact number of services matching the filters and omitted is how many are not in this response. When omitted is not 0, call again with offset set to next_offset — a shop's menu quoted from a truncated list is a menu with services missing from it.

Who may call it

Permission
shop.manageThe caller must hold shop.manage 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 there are more services on the menu. Call again with `offset` set to `next_offset`, or narrow `q`.

Input

FieldTypeDescription
qstringmax 120 chars

Part of a service name. Omit to list the whole menu.

categorystringmax 80 chars

One category name, as returned by services.categories.

active_onlyboolean

True returns only services the shop still sells. Defaults to all.

bookable_onlyboolean

True returns only services that appear on the public booking page.

addons_onlyboolean

True returns only extras — services sold alongside something else.

limitinteger1–200

How many services to return, 1-200. Defaults to 50.

Default: 50
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[].descriptionstring | null

items[].categorystring | null

items[].pricing_modelstring

items[].base_pricenumber | null

items[].duration_minutesnumber | null

items[].cure_time_hoursnumber | null

items[].activeboolean

items[].bookableboolean

items[].addonboolean

items[].tax_exemptboolean

items[].skustring | null

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

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