Get a rate card line
Crew module
GET/rate-card-lines/{id}rateCardLines.get
A rate card line by role. Returns one rate card line with its `ETag`. A rate card line 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 rate card line. |
| 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: RateCardLine
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the rate card line. |
| 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. |
| rate_card_id | string (uuid) | Yes | Identifier of the rate card. |
| 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 | |
| worker_classification | string | Yes | Worker classification priced, from xpms.worker_classification.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| pay_basis | string | Yes | Pay basis; with the classification a permitted pair.Constraints: length 1 to 300 |
| arrangement | string | Yes | Arrangement; with the classification a permitted pair.Constraints: length 1 to 300 |
| overtime_rule_id | string | Yes | Canon overtime rule whose multipliers apply.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| canon_rate_card_id | string | null | Yes | Canon rate card the line was adopted from.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"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",
"rate_card_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"role_code": "5000.50.01",
"rate_minor": 4500,
"worker_classification": "EMPLOYEE",
"pay_basis": "Hourly",
"arrangement": "Per Engagement",
"overtime_rule_id": "OTR-001",
"canon_rate_card_id": "LRC-001"
}Code samples
curl -X GET "$XOS_BASE_URL/rate-card-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.rateCardLines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.rate_card_lines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos rate-card-lines get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f