Skip to main content
Documentation

Jobs

jobs.list

List jobs by stage, customer, vehicle or title
Read-onlyRead budget

REST

Shipping
POST /api/v1/jobs/list

MCP tool

Live
jobs.list

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

Operating contract

Jobs newest-first, narrowed by any combination of stage, customer_id, vehicle_id and q (which matches the job title).

Each result's id is the job_id that jobs.get, jobs.timeline, jobs.set_stage, jobs.assign, jobs.schedule and jobs.list_services all take. customer_id and vehicle_id on a result are the ids customers.get and vehicles.get take.

stage values come from jobs.stages; a stage this shop does not use returns an empty list rather than an error.

TRUNCATION: total is the exact number of jobs matching the filter and omitted is how many are NOT in this response. A shop's whole job history runs to thousands of rows, so a question like 'how many jobs are in progress' must be answered from total, never from items.length. When omitted is not 0, call again with offset set to next_offset.

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 you have part of the answer. Use `total` for counts, and call again with `offset` set to `next_offset` for the rest.

Input

FieldTypeDescription
stagestring

Only jobs at this stage. Call jobs.stages for the list.

One of: lead, scheduled, in_progress, curing, qa, ready, completed, canceled
customer_idstringuuid

Only this customer's jobs, as returned by customers.list or customers.get.

vehicle_idstringuuid

Only this vehicle's jobs, as returned by vehicles.list or vehicles.get.

qstringmax 120 chars

Part of the job title.

limitinteger1–100

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

Default: 25
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[].customer_idstring

items[].vehicle_idstring | null

items[].stagestring

items[].assignee_idstring | null

items[].scheduled_startstring | null

items[].scheduled_endstring | null

items[].actual_startstring | null

items[].actual_endstring | null

items[].location_addressstring | 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/jobs/list \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":25,"offset":0}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/jobs/list", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "limit": 25,
    "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/jobs/list",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "limit": 25,
    "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": "jobs.list",
    "arguments": {
      "limit": 25,
      "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.