List advance submission rows
Módulo Advancing
GET/advance-submissionsadvanceSubmissions.list
A recipient's submission for one section. Returns a cursor page of advance submission rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad advancing.packet.read.
- Alcances de OAuth: advancing.
- 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 AdvanceSubmission
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the advance submission. |
| 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. |
| advance_section_id | string (uuid) | Sí | Identifier of the advance section. |
| advance_recipient_id | string (uuid) | Sí | Identifier of the advance recipient. |
| submitted_at | string (date-time) | Sí | When it was submitted. |
| body | string | Sí | The answer as rich text.Restricciones: length 1 to 20000 |
| reviewed_at | string (date-time) | null | Sí | When the answer was reviewed. |
| reviewed_by | string (uuid) | null | Sí | Identifier of the person who reviewed the answer. |
| review_outcome | "Accepted" | "Returned" | null | Sí | Accepted or Returned. |
| return_reason | string | null | Sí | Why the answer was returned.Restricciones: length 1 to 1000 |
| via_link | boolean | Sí | True when the recipient answered through a Gateway link. |
{
"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",
"advance_section_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"advance_recipient_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"submitted_at": "2026-10-08T14:30:00Z",
"body": "Party of 8 lands at 14:20.",
"reviewed_at": "2026-10-08T14:30:00Z",
"reviewed_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"review_outcome": "Accepted",
"return_reason": "Please add the flight number.",
"via_link": false
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/advance-submissions" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.advanceSubmissions.listAll()) {
console.log(row);
}for row in xos.advance_submissions.list_all():
print(row)xos advance-submissions list --all