Skip to content

Get a rider line

Advancing module

GET/rider-lines/{id}riderLines.get

A rider line, reconciled against capabilities. Returns one rider line with its `ETag`. A rider line 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

riderLines.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the rider line.
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: RiderLine

riderLines.get: RiderLine
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the rider line.
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.
rider_idstring (uuid)YesIdentifier of the rider.
quantitynumber | nullYesQuantity.
descriptionstringYesWhat is asked.Constraints: length 1 to 500
element_idstring | nullYesCatalog element that fulfills the ask.Constraints: length 1 to 64
fulfilled_atstring (date-time) | nullYesWhen the ask was fulfilled; NULL while open.
{
  "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",
  "rider_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "quantity": 2,
  "description": "Two wedge monitors per vocalist.",
  "element_id": "5000.02.01-NWL-001",
  "fulfilled_at": "2026-10-08T14:30:00Z"
}

Code samples

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