Skip to content

Get an advance section

Advancing module

GET/advance-sections/{id}advanceSections.get

A section of an advance packet. Returns one advance section with its `ETag`. A advance section the caller may not see returns 404.

  • Requires the capability advancing.packet.read.
  • OAuth scopes: advancing.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

advanceSections.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the advance section.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: AdvanceSection

advanceSections.get: AdvanceSection
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the advance section.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
advance_packet_idstring (uuid)YesIdentifier of the advance packet.
positionintegerYesSection order.Constraints: range 1 to any
titlestringYesSection title.Constraints: length 1 to 300
promptstring | nullYesWhat the recipient is asked.Constraints: length 1 to 2000
{
  "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_packet_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "title": "Hospitality",
  "prompt": "When does the party arrive?"
}

Code samples

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