Get an union local rate

Módulo Crew

GET/union-local-rates/{id}unionLocalRates.get

A union local's scale rate for a role. Returns one union local rate with its `ETag`. A union local rate the caller may not see returns 404.

Requiere la capacidad crew.rate_card.read.
Alcances de OAuth: crew.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

unionLocalRates.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the union local rate.
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Respuesta 200: UnionLocalRate

unionLocalRates.get: UnionLocalRate
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the union local rate.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
union_local	string	Sí	Union local.Restricciones: length 1 to 300
role_code	RoleCode	Sí	Workforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
rate_minor	integer \| Masked \| null	Sí
currency_code	string	Sí	ISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
effective_from	string (date)	Sí	First day the rate applies.
fringe_minor	integer (int64) \| null	Sí	Fringe per hour. Integer minor units of the resource currency; null means unpriced, never zero.
effective_to	string (date) \| null	Sí	Last day the rate applies.

{
  "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",
  "union_local": "Local 500",
  "role_code": "5000.50.01",
  "rate_minor": 5600,
  "currency_code": "USD",
  "effective_from": "2026-10-08",
  "fringe_minor": 1200,
  "effective_to": "2026-10-08"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/union-local-rates/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.unionLocalRates.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.union_local_rates.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos union-local-rates get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f