Get a pay rate
Crew module
GET/pay-rates/{id}payRates.get
An append-only pay rate ledger entry for a person. Restricted. Returns one pay rate with its `ETag`. A pay rate the caller may not see returns 404.
- Requires the capability crew.rate_card.read.
- OAuth scopes: crew.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the pay rate. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: PayRate
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the pay rate. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| role_code | RoleCode | Yes | Workforce role code from `xpms.dim_role`, on URID grammar.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$ |
| rate_minor | integer | Masked | null | Yes | |
| effective_from | string (date) | Yes | First day the rate applies. |
| membership_id | string (uuid) | Yes | Identifier of the membership of the person paid. |
| currency_code | string | Yes | ISO 4217 currency of the rate.Constraints: pattern ^[A-Z]{3}$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"role_code": "5000.50.01",
"rate_minor": 5200,
"effective_from": "2026-10-08",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"currency_code": "USD"
}Code samples
curl -X GET "$XOS_BASE_URL/pay-rates/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.payRates.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.pay_rates.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos pay-rates get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f