List overtime rule rows
Crew module
GET/overtime-rulesovertimeRules.list
A jurisdiction's wage and hour rule from canon: daily and weekly overtime thresholds and minimum multipliers. A lower jurisdiction inherits its parent's rule. Returns a cursor page of overtime rule rows the caller may see. The default order is `jurisdiction_id` 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 OvertimeRule
| Field | Type | Required | Description |
|---|---|---|---|
| jurisdiction_id | JurisdictionId | Yes | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| source | string | Yes | Statute or source of the rule.Constraints: length 1 to 300 |
| weekly_ot_after_hours | number | null | Yes | Weekly hours after which overtime applies. |
| daily_ot_after_hours | number | null | Yes | Daily hours after which overtime applies. |
| daily_dt_after_hours | number | null | Yes | Daily hours after which double time applies. |
| min_ot_multiplier | number | null | Yes | Minimum overtime multiplier. |
| min_dt_multiplier | number | null | Yes | Minimum double time multiplier. |
{
"data": [
{
"jurisdiction_id": "US-FL",
"source": "Fair Labor Standards Act, 29 U.S.C. 207",
"weekly_ot_after_hours": 40,
"daily_ot_after_hours": 8,
"daily_dt_after_hours": 12,
"min_ot_multiplier": 1.5,
"min_dt_multiplier": 2
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/overtime-rules" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.overtimeRules.listAll()) {
console.log(row);
}for row in xos.overtime_rules.list_all():
print(row)xos overtime-rules list --all