Documentation
Scheduling
scheduling.readiness
REST
ShippingPOST /api/v1/scheduling/readinessMCP tool
Livescheduling.readinessExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Scheduling domain.
Operating contract
THE THREE THINGS THE SCHEDULER NEEDS BEFORE IT CAN PLACE ANYTHING: at least one active bay, at least one bookable installer, and at least one active service.
MAKE THIS READ BEFORE BLAMING AN EMPTY GRID ON A FULL DIARY. booking.availability and scheduling.suggest_slots both return nothing at all for a shop missing any one of these, and 'we are fully booked' is a very different sentence from 'this shop has not set its bays up'.
ready: false NAMES THE MISSING PIECE in blocking, and each is a five-minute fix in Settings. Say which one it is — an owner told their scheduling is 'not configured' does not know where to click.
A zero here is a setup gap, not a busy shop. A shop with three bays, two installers and forty services and no availability is genuinely full.
Three counts, entirely returned, so nothing is truncated.
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
| Field | Type | Description |
|---|---|---|
| ready | boolean | — |
| stations | number | — |
| bookable_staff | number | — |
| services | number | — |
| blocking | string[] | — |
Examples
Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.
export SERVICEVIN_API_KEY=svk_live_…
curl -X POST https://www.servicevin.com/api/v1/scheduling/readiness \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://www.servicevin.com/api/v1/scheduling/readiness", {
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;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/scheduling/readiness",
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"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "scheduling.readiness",
"arguments": {}
}
}Refusals
The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.
| Status | Code | When |
|---|---|---|
| 404 | not_found | The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both. |
| 403 | forbidden | This login does not hold shop.manage. |
| 422 | validation_error | An argument was wrong. The message names the field. |
| 429 | rate_limited | Too many read calls. Back off and retry. |
| 500 | internal_error | Something failed on our side. Nothing was changed. |