Skip to main content
Documentation

Booking

booking.get

Read one booking back by its manage token
Read-onlyRead budget

REST

Shipping
POST /api/v1/booking/get

MCP tool

Live
booking.get

Exposed on: REST API · Booking MCP server. Part of the Booking domain.

Operating contract

Everything the customer's own manage page shows: the reference, what was booked, on what car, when, where, who it is with, and whether they may still change it online.

manage_token is the last path segment of the manage_url booking.book returned — the part after /manage/. It is a bearer credential: it is the whole proof that this caller may see this appointment, so treat it as a secret and never read it out.

changeable: false with a lock_reason means the appointment is inside the shop's cut-off, already started, or already finished — booking.reschedule and booking.cancel will refuse it, and the honest answer is to give the customer the shop's phone number.

awaiting_approval: true means the shop has not confirmed this booking yet. Do not describe it as confirmed.

A token from another shop, an expired one and one that never existed all answer the same way, so a wrong token tells you nothing about whether a booking exists.

Who may call it

Permission
NoneReached with the customer's own manage token, which is the credential — the same page they open from their confirmation with no login. A staff read of the same appointment is `jobs.get`, which IS section-gated.
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
manage_tokenrequiredstringmax 512 chars, min 8 chars

The token from the booking's manage_url, as returned by booking.book.

Output

FieldTypeDescription
referencestring

service_namestring | null

vehiclestring | null

scheduled_startstring | null

scheduled_endstring | null

wherestring | null

installerstring | null

awaiting_approvalboolean

changeableboolean

lock_reasonstring | null

lead_time_hoursnumber

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

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

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

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.
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.