Skip to main content
Documentation

Services

services.get

Get one service, its price shape and what it needs to run
Read-onlyRead budget

REST

Shipping
POST /api/v1/services/get

MCP tool

Live
services.get

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

Operating contract

The whole record for one service: what it is called, what it costs, how long it takes, whether it cures, whether it is live on the booking page, and — the part that is only here — what the shop needs in order to deliver it.

requires is why a slot may not exist. A service restricted to two bays cannot be booked into the third; one needing a certification only one installer holds cannot be booked when that person is off. When booking.availability comes back empty and the day looks open, this is the first thing to read.

cure_time_hours is a hold AFTER the hands-on work, during which the car keeps the bay. It is why an hour of labour can occupy a bay until tomorrow, and why a shop's day looks fuller than the sum of its jobs.

For a tiered service the price is not here — call services.tiers. base_price is null for tiered and for custom alike, and those are different situations: tiered has prices per size, custom has none at all.

Refuses when nothing in this shop has that id, which includes a service the shop has retired.

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.

Input

FieldTypeDescription
service_idrequiredstringuuid

The service's id, as returned by services.list or quotes.catalog.

Output

FieldTypeDescription
idstring

namestring

descriptionstring | null

categorystring | null

pricing_modelstring

base_pricenumber | null

duration_minutesnumber | null

cure_time_hoursnumber | null

activeboolean

bookableboolean

addonboolean

tax_exemptboolean

skustring | null

labor_hoursnumber | null

requiresobject

requires.station_idsstring[]

requires.certificationsstring[]

requires.skillsstring[]

requires.material_sku_idsstring[]

created_atstring

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/get \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"service_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/services/get", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "service_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
  }),
});

// 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/get",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "service_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
},
    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.get",
    "arguments": {
      "service_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
    }
  }
}

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.