Skip to main content
Documentation

Scheduling

scheduling.stations

List the bays and lifts a slot can be scheduled into
Read-onlyRead budget

REST

Shipping
POST /api/v1/scheduling/stations

MCP tool

Live
scheduling.stations

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

Operating contract

The shop's physical capacity: every active bay, what kind it is, and how many cars it takes at once. Every slot decision in the product is bounded by this list, which is why it is worth reading before concluding a shop is 'fully booked'.

station_type matters because services are restricted to bays that can run them — a tint booth is not a wash bay. A job whose services need a bay type the shop does not have will never produce a suggestion, and this is where that shows up.

capacity is how many cars one bay holds at once. Most are 1; a detailing bay may be more.

Bays the shop has retired are not returned. If a shop insists it has four bays and this shows three, one has been marked inactive rather than deleted, and that is a settings question rather than a scheduling one.

This returns every active bay and does not page, so nothing is truncated.

Bays are read-only here. Adding or retiring one re-shapes the shop's whole capacity, including its public booking grid, and is a decision an owner makes with the floor in front of them.

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

This capability takes no arguments.

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].namestring

items[].station_typestring

items[].capacitynumber

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/scheduling/stations \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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

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

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.