Skip to main content
Documentation
Service VIN developer & AI platformGetting startedAuthenticationPaginationIdempotencyRate limitsErrorsWebhooks & signature verificationConnecting ClaudeRecipesMCP servers & the Claude connectorREST resource referenceCapability indexCustomers capabilitiesVehicles capabilitiesLeads capabilitiesWarranties capabilitiesQuotes capabilitiesInvoices capabilitiesPayments capabilitiesServices capabilitiesJobs capabilitiesCalendar capabilitiesScheduling capabilitiesStaff capabilitiesInventory capabilitiesComms capabilitiesTasks capabilitiesShop capabilitiesDocuments capabilitiesKnowledge capabilitiesReports capabilitiesBooking capabilitiesForms capabilitiesMarketing capabilitiesReviews capabilitiesAutomations capabilitiesIntegrations capabilitiesChangelogSearch

Staff

staff.timesheet

Read one week of the shop's staff clock, with hours per person
Read-onlySensitiveRead budget

REST

Shipping
POST /api/v1/staff/timesheet

MCP tool

Live
staff.timesheet

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

Operating contract

One week of the time clock, Monday to Sunday, with each person's punches and their total hours.

week_start must be a MONDAY in the shop's own timezone. Any other date is snapped to the Monday of its week, and the response says which week it actually drew — read week_start back rather than assuming.

carry_over is the thing this screen exists for: shifts that are still running and started BEFORE this week. Those are almost always a forgotten clock-out, and every hour of one is an hour somebody may be paid for and did not work. Raise them.

flagged_count marks punches the clock itself thinks are wrong — impossibly long, overlapping, or missing an end. They are not corrected automatically, and correcting one changes what a worker is owed.

hours is decimal hours, which is the form payroll wants. An open shift is counted live up to as_of, so two calls a minute apart give different totals for a running shift — that is correct rather than inconsistent.

READ ONLY. Editing a punch changes what somebody is owed for hours already worked, and the timesheet screen exists so a person signs off on that.

TRUNCATION: truncated: true means the week hit the clock's row ceiling and every total on the response is INCOMPLETE and reads low. Do not report hours from a truncated week — say it could not be read in full.

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.

Partial answers

truncated 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

`truncated` is a flag rather than a count: when it is true the week hit the clock's row ceiling and every hour figure on this response reads LOW. Say the week could not be read in full rather than reporting the totals.

Input

FieldTypeDescription
week_startrequiredstring

The Monday of the week to read, YYYY-MM-DD in the shop's own timezone.

Output

FieldTypeDescription
week_startstring

—

week_endstring

—

is_currentboolean

—

as_ofstring

—

truncatedboolean

—

shop_hoursnumber

—

workersobject[]

—

workers[].staff_idstring

—

workers[].namestring

—

workers[].pay_typestring

—

workers[].hoursnumber

—

workers[].flagged_countnumber

—

carry_over_countnumber

—

flag_countsobject

—

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

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

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

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.