Saltar al contenido

List wage determination rows

Módulo Crew

GET/wage-determinationswageDeterminations.list

A prevailing wage determination by jurisdiction. Returns a cursor page of wage determination rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad crew.rate_card.read.
  • Alcances de OAuth: crew.
  • Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
  • Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

wageDeterminations.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter 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.

Respuesta 200: una página de WageDetermination

wageDeterminations.list: WageDetermination
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the wage determination.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
jurisdiction_idJurisdictionIdSíJurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
role_codeRoleCodeSíWorkforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
minimum_rate_minorinteger (int64) | nullSíPrevailing minimum rate per hour. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringSíISO 4217 currency.Restricciones: pattern ^[A-Z]{3}$
effective_fromstring (date)SíFirst day the determination applies.
effective_tostring (date) | nullSíLast day the determination applies.
sourcestringSíDetermination source or reference.Restricciones: length 1 to 300
{
  "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",
      "jurisdiction_id": "US-FL",
      "role_code": "5000.50.01",
      "minimum_rate_minor": 4800,
      "currency_code": "USD",
      "effective_from": "2026-10-08",
      "effective_to": "2026-10-08",
      "source": "FL20260001"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/wage-determinations" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.wageDeterminations.listAll()) {
  console.log(row);
}
for row in xos.wage_determinations.list_all():
    print(row)
xos wage-determinations list --all