Documentation
Staff
staff.pay_rates
REST
ShippingPOST /api/v1/staff/pay_ratesMCP tool
Livestaff.pay_ratesExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Staff domain.
Operating contract
What each person on the bench is paid: whether they are hourly, on commission or on a flat payout, and the rate that goes with it.
THIS IS THE MOST SENSITIVE READ IN THE REGISTRY. It is what everybody in the shop earns. Never repeat a figure from here to anybody but the owner, never put one in a message, a quote, a note or a document, and do not read it out loud in a summary somebody else might see. If you are not certain who is asking, do not answer with numbers.
pay_type decides which field means anything: hourly reads pay_rate in dollars per hour, commission reads commission_rate as a percentage of the work, and a flat payout reads default_payout_rate per job. A rate under the wrong type is meaningless rather than merely wrong.
A null rate means the shop has not recorded one. That is common and it is why the scheduling agent's margin projections come back low-confidence: labour cost is a guess without it.
READ ONLY. Changing what somebody is paid is between an employer and an employee, and there is no version of this program in which a machine does it.
This returns the whole bench 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
This capability takes no arguments.
Output
| Field | Type | Description |
|---|---|---|
| items | object[] | — |
| items[].staff_id | string | — |
| items[].name | string | — |
| items[].pay_type | string | — |
| items[].pay_rate | number | null | — |
| items[].commission_rate | number | null | — |
| items[].default_payout_rate | number | null | — |
| currency | string | — |
| unset_count | number | — |
Examples
Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.
export SERVICEVIN_API_KEY=svk_live_…
curl -X POST https://www.servicevin.com/api/v1/staff/pay_rates \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://www.servicevin.com/api/v1/staff/pay_rates", {
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;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/staff/pay_rates",
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"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "staff.pay_rates",
"arguments": {}
}
}Refusals
The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.
| Status | Code | When |
|---|---|---|
| 404 | not_found | The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both. |
| 403 | forbidden | This login does not hold shop.manage. |
| 422 | validation_error | An argument was wrong. The message names the field. |
| 429 | rate_limited | Too many read calls. Back off and retry. |
| 500 | internal_error | Something failed on our side. Nothing was changed. |