Documentation
Calendar
calendar.day
REST
ShippingPOST /api/v1/calendar/dayMCP tool
Livecalendar.dayExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Calendar domain.
Operating contract
What the shop is actually doing on a given date, in start order: every job with a time on it, who it is for, which car, who it is assigned to and what stage it is in.
THIS IS THE BOARD, NOT AVAILABILITY. A gap here is not a bookable slot — a bay may be curing, the day may be at a cap, and the shop's minimum notice may rule the whole morning out. booking.availability is the only honest answer to 'when can you fit me in'.
Cancelled work is left off by default, because it is not something anybody is doing. Pass include_canceled: true when the question is really 'what happened to that appointment'.
Every id here is a job_id: jobs.get opens it, jobs.schedule moves it, jobs.assign re-assigns it, and booking.cancel takes it off the board.
The date is read in the SHOP's timezone, which is on this response. A shop in Calgary and a caller in London disagree about what 'today' is, and this answers in the shop's terms.
TRUNCATION: total is the exact count of scheduled events that day and omitted is how many are not in this response. When omitted is not 0, raise limit — a day summary built from a truncated board is a plan with cars missing from it.
Who may call it
- Permission
jobs.accessThe caller must hold Jobs 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.
Partial answers
omitted is how many matching records are not in the response, and 0 is a real answer meaning you have all of them. There is no cursor here — narrow the filter instead.
Do not summarise from a truncated response
Input
| Field | Type | Description |
|---|---|---|
| daterequired | string | The day to read, YYYY-MM-DD in the shop's own timezone. |
| include_canceled | boolean | True also returns cancelled work. Defaults to false. |
| limit | integer1–200 | How many events to return, 1-200. Defaults to 100. Default:100 |
Output
| Field | Type | Description |
|---|---|---|
| date | string | — |
| timezone | string | — |
| items | object[] | — |
| items[].id | string | — |
| items[].number | number | — |
| items[].title | string | null | — |
| items[].stage | string | — |
| items[].customer_id | string | — |
| items[].vehicle_id | string | null | — |
| items[].assignee_id | string | null | — |
| items[].scheduled_start | string | null | — |
| items[].scheduled_end | string | null | — |
| total | number | — |
| omitted | number | — |
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/calendar/day \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"date":"…","limit":100}'const res = await fetch("https://www.servicevin.com/api/v1/calendar/day", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"date": "…",
"limit": 100
}),
});
// 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/calendar/day",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"date": "…",
"limit": 100
},
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": "calendar.day",
"arguments": {
"date": "…",
"limit": 100
}
}
}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 jobs.access. |
| 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. |