List pay rate rows
Crew module
GET/pay-ratespayRates.list
An append-only pay rate ledger entry for a person. Restricted. Returns a cursor page of pay rate rows the caller may see. The default order is `effective_from` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability crew.rate_card.read.
- OAuth scopes: crew.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| 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_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of 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}$ |
{
"data": [
{
"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"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/pay-rates" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.payRates.listAll()) {
console.log(row);
}for row in xos.pay_rates.list_all():
print(row)xos pay-rates list --all