Skip to main content
Documentation

Scheduling

scheduling.overbooked_days

Find the days already booked past the shop's own slot ceiling
Read-onlyRead budget

REST

Shipping
POST /api/v1/scheduling/overbooked_days

MCP tool

Live
scheduling.overbooked_days

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

Operating contract

THE DAYS THE SHOP HAS OVERSOLD. Each one carries what it is actually holding — jobs and bay-hours — against the ceiling the shop set, and a sentence saying both.

READ THIS BEFORE PROMISING ANY DATE. A day can be over its cap and still show open times on a grid narrowed by service or installer; the cap is a shop-wide ceiling and this is the only read that measures against it.

THE CEILING IS THE ONE THE SHOP TYPED. A shop that set no daily cap has none here — its bays' open hours are the only limit, and the storefront measures those at the slot — so an empty response from a shop with no caps means there is nothing to measure rather than that everything is fine.

IMPORTED WORK IS NOT COUNTED, deliberately. A shop that migrated its history does not want a red warning about a Tuesday whose four real cars it can comfortably finish; a warning that fires on work nobody is doing is the one a shop learns to click past, taking the true ones with it.

message is the whole finding in the product's own words — quote it rather than assembling your own from the numbers.

This measures only the days you ask about, so nothing is truncated. A day not in days was not checked and is not therefore fine.

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
fromrequiredstring

First day to check, YYYY-MM-DD in the shop's timezone.

daysinteger1–60

How many consecutive days to check from `from`, 1-60. Defaults to 14.

Default: 14

Output

FieldTypeDescription
checked_daysnumber

itemsobject[]

items[].datestring

items[].labelstring

items[].jobsnumber

items[].hoursnumber

items[].messagestring

totalnumber

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/overbooked_days \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"…","days":14}'

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

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

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.