Skip to content

Get a gate queue entry

Logistics module

GET/gate-queue/{id}gateQueueEntries.get

A vehicle waiting at the venue gate. Returns one gate queue entry with its `ETag`. A gate queue entry the caller may not see returns 404.

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

Path and query parameters

gateQueueEntries.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the gate queue entry.
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: GateQueueEntry

gateQueueEntries.get: GateQueueEntry
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the gate queue entry.
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.
vehicle_identifierstringYesPlate or trailer number as written.Constraints: length 1 to 100
arrived_atstring (date-time)YesWhen the vehicle arrived.
released_atstring (date-time) | nullYesWhen the vehicle was released.
project_idstring (uuid)YesIdentifier of the project whose site the gate is at.
shipment_idstring (uuid) | nullYesIdentifier of the shipment the vehicle carries.
released_bystring (uuid) | nullYesIdentifier of the person who released the vehicle.
vehicle_typestring | nullYesKind of vehicle at the gate.Constraints: length 1 to 100
driver_namestring | nullYesDriver of the vehicle, as given at check-in.Constraints: length 1 to 200
{
  "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",
  "vehicle_identifier": "FL TRK-2231",
  "arrived_at": "2026-10-08T14:30:00Z",
  "released_at": "2026-10-08T14:30:00Z",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "released_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "vehicle_type": "53ft Tractor-Trailer",
  "driver_name": "Luis Ortega"
}

Code samples

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