Skip to main content
Documentation

Staff

staff.on_the_clock

List the staff clocked in right now and what they are working on
Read-onlyRead budget

REST

Shipping
POST /api/v1/staff/on_the_clock

MCP tool

Live
staff.on_the_clock

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

Operating contract

WHO IS IN THE BUILDING. Everyone with an open shift, how long they have been on the clock, and the job their timer is running against.

THIS IS THE LIVE ANSWER TO 'CAN SOMEBODY LOOK AT THIS TODAY'. A roster says who works here; this says who is here now.

on_job_id WITH NO SHIFT IS NOT POSSIBLE, but a shift with no running timer very much is — somebody clocked in and not yet started on anything, or between jobs. on_job_id: null is that, and it is normal rather than a fault.

hours_so_far IS A LIVE FIGURE against an open shift and is not a payroll number. It moves every minute and it has had no break policy, rounding or approval applied. staff.timesheet is the read that answers a pay question.

A SHIFT LEFT OPEN OVERNIGHT LOOKS EXACTLY LIKE SOMEBODY WORKING A LONG DAY. Anything past about twelve hours is far more likely to be a forgotten clock-out, and saying so is more useful than reporting it straight.

Everybody currently clocked in is returned, 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

This capability takes no arguments.

Output

FieldTypeDescription
itemsobject[]

items[].staff_idstring

items[].namestring

items[].clocked_in_atstring

items[].hours_so_farnumber

items[].on_job_idstring | null

items[].timer_started_atstring | null

totalnumber

as_ofstring

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/on_the_clock \
  -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/on_the_clock", {
  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/on_the_clock",
    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.on_the_clock",
    "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.