Skip to main content
Documentation

Calendar

calendar.unscheduled

List live jobs with no calendar event booked in yet
Read-onlyRead budget

REST

Shipping
POST /api/v1/calendar/unscheduled

MCP tool

Live
calendar.unscheduled

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

Operating contract

The work the shop has taken on and not yet put a time against. This is the list behind 'what still needs booking in', and it is the one that quietly grows: a job with no date appears on no day, so nobody trips over it.

Completed and cancelled work is never here — a finished job needs no date. What is here is live work waiting for a slot.

Each id is a job_id. scheduling.suggest_slots will propose where one should go and jobs.schedule puts it there; do not pick a time off calendar.day and assume it is free.

created_at is how long a job has been sitting unscheduled, and it is usually the most interesting column on this list — the oldest rows are the ones a shop has forgotten.

TRUNCATION: total is the exact number of unscheduled live jobs and omitted is how many are not in this response. When omitted is not 0, raise limit before telling a shop owner how much unscheduled work they have.

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. Continue with next_offset.

Do not summarise from a truncated response

When `omitted` is not 0 there is more unscheduled work than came back. Call again with `offset` set to `next_offset`.

Input

FieldTypeDescription
limitinteger1–200

How many jobs to return, 1-200. Defaults to 50.

Default: 50
offsetintegermin 0

How many to skip. Pass the previous response's next_offset to continue.

Default: 0

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].numbernumber

items[].titlestring | null

items[].stagestring

items[].customer_idstring

items[].vehicle_idstring | null

items[].created_atstring

totalnumber

omittednumber

next_offsetnumber | null

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/calendar/unscheduled \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":50,"offset":0}'

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

// 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/calendar/unscheduled",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "limit": 50,
    "offset": 0
},
    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": "calendar.unscheduled",
    "arguments": {
      "limit": 50,
      "offset": 0
    }
  }
}

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