Saltar al contenido

Get a rate card

Módulo Crew

GET/rate-cards/{id}rateCards.get

A labor rate card. Returns one rate card with its `ETag`. A rate card 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

rateCards.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the rate card.
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_]*)*$

Respuesta 200: RateCard

rateCards.get: RateCard
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the rate card.
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.
namestringSíRate card name.Restricciones: length 1 to 300
currency_codestringSíISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
effective_fromstring (date)SíFirst day the card applies.
effective_tostring (date) | nullSíLast day the card 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",
  "name": "Local Stagehand Rates 2026",
  "currency_code": "USD",
  "effective_from": "2026-10-08",
  "effective_to": "2026-10-08"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/rate-cards/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.rateCards.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.rate_cards.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos rate-cards get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f