List bid rows
Módulo Opportunities
GET/bidsbids.list
A sealed line-item bid. A bidder never sees another bidder, and the org sees bids only after the deadline unless it holds `procurement.bid.unseal`. Returns a cursor page of bid rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad opportunities.application.read.
- Alcances de OAuth: opportunities.
- 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
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Restricciones: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any |
| 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_]*)*$ |
| sort | Sort | No | Sort 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_]*)*$ |
| filter | Filter | No | Filter 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 Bid
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the bid. |
| 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. |
| application_id | string (uuid) | Sí | Identifier of the application. |
| total | MoneyTotal | Sí | A money aggregate that never coerces unpriced inputs to zero. |
| sealed | boolean | Sí | Whether the bid is still sealed. |
| currency_code | string | Sí | ISO 4217 currency of every line.Restricciones: pattern ^[A-Z]{3}$ |
| valid_until | string (date) | null | Sí | Last day the bid holds. |
| submitted_at | string (date-time) | Sí | When the bid was submitted, set by the database. |
{
"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",
"application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"total": {
"total_minor": 1250000,
"currency": "USD",
"unpriced_count": 2
},
"sealed": true,
"currency_code": "USD",
"valid_until": "2026-10-08",
"submitted_at": "2026-10-08T14:30:00Z"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/bids" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.bids.listAll()) {
console.log(row);
}for row in xos.bids.list_all():
print(row)xos bids list --all