Documentation
Developer & AI platform
Every function in the shop, available to your code and to your AI.
- capabilities
- 222
- domains
- 25
- endpoints answering
- 4/5
- guides
- 9
Base URLs
- REST
https://www.servicevin.com/api/v1- Shop MCP
https://www.servicevin.com/api/mcp
Zero to an authenticated call
Mint a key in Settings → API keys, put it in your shell, and call /me. A 200 naming your shop means you are connected.
export SERVICEVIN_API_KEY=svk_live_…
curl https://www.servicevin.com/api/v1/me \
-H "Authorization: Bearer $SERVICEVIN_API_KEY"Then read Getting started, which explains what a capability is before you call one.
The surfaces
Five ways in, one registry behind them, and one audited path through the same four gates — ring, plan, permission, scope — whichever door a call comes through.
/api/v12 endpoints
/api/v1REST resources — Leads, customers, vehicles, quotes, invoices, jobs, appointments, messages, services and staff, with cursor pagination and signed webhooks.
/api/v1/<domain>/<verb>Capability endpoints — One POST per capability, taking the capability's own input schema and answering with its output shape.
/api/mcp2 endpoints
/api/mcpShop MCP server — Streamable HTTP MCP. Every capability this account may reach, as a tool, filtered by scope, permission, plan and release ring.
/api/mcp/bookingBooking MCP server — Availability and booking only, on a fixed allowlist, reached with a booking token — the surface an AI voice platform connects to.
/.well-known/oauth-authorization-server1 endpoint
/.well-known/oauth-authorization-serverClaude connector (OAuth 2.1) — The same shop server reached through OAuth with dynamic client registration and PKCE, so a shop owner clicks Connect instead of pasting a key.
A shipping endpoint is documented here because its contract is settled and generated from the same registry — build against it, and it answers the day it lands. The status on this page is read from the route file itself, not from a note somebody remembered to update.
Guides
- 01Getting startedMint a key, make your first authenticated call, and understand what a capability is before you call one.
- 02AuthenticationAPI keys for code you control, and the OAuth connector for a shop owner who clicks Connect. Which to pick, and what each one can reach.
- 03PaginationTwo paging models, on purpose: an opaque keyset cursor on the REST resources, and an exact remaining count on the capability lists.
- 04IdempotencyEvery capability declares what a repeat of the same call does — and only one of the three answers needs a key from you.
- 05Rate limitsA per-key window on the REST resources, and four capability budgets whose tightest one exists to protect the shop's sending reputation.
- 06ErrorsSuccess is an envelope and so is failure. Switch on `error.code`; the messages are written for people and may change.
- 07Webhooks & signature verificationA signed JSON envelope per event, the exact bytes to verify against, and what happens to an endpoint that keeps failing.
- 08Connecting ClaudeThree ways to point Claude at a shop: the Desktop / claude.ai connector, Claude Code's CLI, and the API's `mcp_servers` parameter.
- 09RecipesThree integrations end to end: booking a job from a voice agent, syncing a CRM, and a nightly export.
Capability domains
Grouped the way the registry groups them: the customer and their car, the money funnel, the day on the floor, the shop itself, then everything that reaches outward.
- 10Customerscustomers · acts on a customer
- 7Vehiclesvehicles · acts on a vehicle
- 15Leadsleads · acts on a lead
- 8Warrantieswarranties · acts on a warranty
- 10Quotesquotes · acts on a quote
- 13Invoicesinvoices · acts on a invoice
- 8Paymentspayments · acts on a payment
- 8Servicesservices · acts on a service
- 11Jobsjobs · acts on a job
- 3Calendarcalendar · acts on a event
- 7Schedulingscheduling · acts on a slot
- 11Staffstaff · acts on a staff
- 8Inventoryinventory · acts on a roll
- 21Commscomms · acts on a message
- 5Taskstasks · acts on a task
- 11Shopshop · acts on a shop
- 8Documentsdocuments · acts on a document
- 5Knowledgeknowledge · acts on a article
- 12Reportsreports · acts on a report
- 12Bookingbooking · acts on a booking
- 5Formsforms · acts on a form
- 5Marketingmarketing · acts on a campaign
- 11Reviewsreviews · acts on a review
- 5Automationsautomations · acts on a automation
- 3Integrationsintegrations · acts on a connection
For a reader that is not a person
Half the traffic here is an agent, a crawler or an answer engine. Four documents exist for them, and every one is generated from the registry rather than written beside it.
- /llms-full.txtThe whole reference — every guide and every capability, contract, fields and examples — as one plain-text document. One fetch, nothing withheld.
- /llms.txtThe index: what is here, and the URL of each page, in the llms.txt convention.
- /openapi.jsonThe OpenAPI 3.1 document for the REST surface, generated from the same spec the routes are checked against.
- /.well-known/mcp.jsonBoth MCP servers, described for discovery — transport, auth and what each one is for.