Skip to main content
Documentation

Staff

staff.certifications

List which staff hold which certifications and when they lapse
Read-onlyRead budget

REST

Shipping
POST /api/v1/staff/certifications

MCP tool

Live
staff.certifications

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

Operating contract

Every certification the shop's people hold, who holds it, and when it runs out.

WHY THIS IS ITS OWN READ. A service can be restricted to certified installers, so a lapsed certificate does not just look untidy — it quietly removes somebody from the shop's bookable capacity, and the first sign is usually a booking grid that has gone empty for no visible reason. Nothing else in the product warns about this before it happens.

expires_on: null means the certification does not expire. days_until_expiry is negative for one that already has.

expiring_soon marks anything inside the next 60 days, which is the window in which a renewal can still be arranged without losing capacity.

The manufacturer's own record is the authority. This is what the shop wrote down, and a certificate scan filed against it is the evidence — documents.list for that person is where it lives.

This returns every certification on the roster and does not page, so nothing is truncated.

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
expiring_onlyboolean

True returns only certifications lapsed or lapsing within 60 days.

Output

FieldTypeDescription
itemsobject[]

items[].staff_idstring

items[].staff_namestring

items[].codestring

items[].namestring

items[].issuerstring | null

items[].issued_onstring | null

items[].expires_onstring | null

items[].days_until_expirynumber | null

items[].expiring_soonboolean

items[].expiredboolean

expiring_countnumber

expired_countnumber

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/staff/certifications \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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

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

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.