Saltar al contenido

Get a work order bid

Módulo Work

GET/work-order-bids/{id}workOrderBids.get

A bid on a work order. Returns one work order bid with its `ETag`. A work order bid the caller may not see returns 404.

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

Parámetros de ruta y de consulta

workOrderBids.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the work order bid.
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: WorkOrderBid

workOrderBids.get: WorkOrderBid
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the work order bid.
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.
work_order_idstring (uuid)SíIdentifier of the work order.
bidder_organization_idstring (uuid)SíIdentifier of the bidding organization.
amount_minorinteger (int64) | nullSíBid amount. Integer minor units of the resource currency; null means unpriced, never zero.
currencystringSíISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
bid_statestringSíBid state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
notesstring | nullSíBid notes.Restricciones: length 1 to 20000
{
  "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",
  "work_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "bidder_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "amount_minor": 790000,
  "currency": "USD",
  "bid_state": "Quoted",
  "notes": "Includes delivery and install."
}

Ejemplos de código

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