Skip to main content
Documentation

Jobs

jobs.timeline

Read what has happened to a job, newest first
Read-onlyRead budget

REST

Shipping
POST /api/v1/jobs/timeline

MCP tool

Live
jobs.timeline

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

Operating contract

The job's activity: stage moves, assignments, reschedules, photos, notes and change orders, each already written as a sentence.

This is the answer to 'what happened to this car' and 'who did it'. It is the same trail the shop's own job screen shows.

timezone decides how times inside the summaries read. Pass the SHOP's timezone, not yours — and if you do not know it, ask rather than guessing, because an hour out is the difference between 'yesterday evening' and 'this morning'.

Capped at limit entries, newest first. A job with a long history will have older entries you have not seen; omitted says how many.

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

When `omitted` is not 0 there are older entries. Raise `limit` (up to 100) — this reads newest-first and does not page backwards.

Input

FieldTypeDescription
job_idrequiredstringuuid

The job to read, as returned by jobs.list or jobs.get.

timezonestringmax 60 chars

IANA timezone for the times in the summaries, e.g. 'America/Edmonton'.

limitinteger1–100

How many entries to return, 1-100. Defaults to 25.

Default: 25

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].typestring

items[].occurred_atstring

items[].summarystring

totalnumber

omittednumber

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/jobs/timeline \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20","limit":25}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/jobs/timeline", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "limit": 25
  }),
});

// 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/jobs/timeline",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "limit": 25
},
    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": "jobs.timeline",
    "arguments": {
      "job_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
      "limit": 25
    }
  }
}

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.