query · Module: Routes · Requires routes:read
Arguments
| Argument | Type | Description |
|---|---|---|
route | String | Filter by route. |
date | String | Filter by date. |
status | String | Filter by status. |
vehicle | String | Filter by vehicle. |
driver | String | Filter by driver. |
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
Returns
RouteRunList!
| Field | Type |
|---|---|
data | [RouteRun!]! |
has_more | Boolean |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query RouteRuns($limit: Int) {
routeRuns(limit: $limit) {
data {
id
object
status
livemode
created
updated
route
date
scheduled_start
started_at
completed_at
vehicle {
id
object
name
type
status
livemode
}
driver {
id
object
status
livemode
created
updated
}
stops {
id
status
facility
contact {
name
company
email
phone
}
reason
scheduled_arrival
}
legs {
id
status
departed_at
arrived_at
delay_minutes
load {
handling_units
}
}
shipment_count
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"routeRuns": {
"data": [
{
"id": "run_1a2B3c",
"object": "route_run",
"status": "planned",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"route": "rte_lax_lhr_daily",
"date": "2026-10-07",
"scheduled_start": "example",
"started_at": 1791302400,
"completed_at": 1791302400,
"vehicle": {
"id": "veh_1a2B3c",
"object": "vehicle",
"name": "Example",
"type": "car",
"status": "active",
"livemode": true
},
"driver": {
"id": "drv_1a2B3c",
"object": "driver",
"status": "active",
"livemode": true,
"created": 1791302400,
"updated": 1791302400
},
"stops": [
{
"id": "obj_1a2B3c",
"status": "pending",
"facility": "fac_lon_hub",
"contact": {
"name": "Example",
"company": "example",
"email": "ops@example.com",
"phone": "+447700900123"
},
"reason": "example",
"scheduled_arrival": "example"
}
],
"legs": [
{
"id": "obj_1a2B3c",
"status": "pending",
"departed_at": 1791302400,
"arrived_at": 1791302400,
"delay_minutes": 2,
"load": {
"handling_units": 2
}
}
],
"shipment_count": 2
}
],
"has_more": true
}
}
}