API Reference
Vehicles and Routes Vehicle inventory, lifecycle, odometer, engine-hours, counts, types, and route history endpoints.
Vehicle list endpoints support field projection through repeated fields[]
query parameters. Route endpoints can produce large responses when coordinates
are requested.
Query parameters Number of records per page.
Page number to read.
Default: 1
Vehicle fields to include, such as id, regNo, status, lastLoggedAt, or lastCoordinates.
Sort expression accepted by Linxio.
Response fields dataLinxioVehicle[]
optional Vehicle rows for the current page.
Total matching vehicle count.
aggregationsunknown
optional Aggregation payload when supplied.
curl "https://api.linxio.com/api/vehicles/fields/json?fields[]=id&fields[]=regNo&limit=100&page=1" \ -H "Authorization: Bearer $LINXIO_TOKEN " { "page" : 1 , "limit" : 100 , "total" : 2 , "data" : [ { "id" : 304 , "regNo" : "ABC-123" }, { "id" : 305 , "regNo" : "DEF-456" } ], "aggregations" : null } Path parameters vehicleIdLinxioId
required Response fields Registration number when supplied.
defaultLabelstring
optional Display label when supplied.
lastLoggedAtISODateString
optional Last telemetry timestamp when supplied.
curl "https://api.linxio.com/api/vehicles/304" \ -H "Authorization: Bearer $LINXIO_TOKEN " Body parameters Registration number or fleet identifier.
defaultLabelstring
optional depotIdLinxioId | null
optional groupIdsLinxioId[]
optional Vehicle group identifiers.
Vehicle identification number.
Response fields Created vehicle registration number when supplied.
curl -X POST https://api.linxio.com/api/vehicles \ -H "Authorization: Bearer $LINXIO_TOKEN " \ -H "Content-Type: application/json" \ --data '{ "regNo": "TEST-001", "defaultLabel": "Temporary SDK Test Vehicle" }' Path and body parameters vehicleIdLinxioId
required bodyLinxioVehiclePayload
required Response fields Registration number when supplied.
curl -X POST https://api.linxio.com/api/vehicles/304 \ -H "Authorization: Bearer $LINXIO_TOKEN " \ -H "Content-Type: application/json" \ --data '{ "defaultLabel": "Updated display label" }' Path parameters vehicleIdLinxioId
required Response status204 or JSON
optional Successful archive response.
curl -X PATCH https://api.linxio.com/api/vehicles/304/archive \ -H "Authorization: Bearer $LINXIO_TOKEN " \ -H "Content-Type: application/json" \ --data '{}' Path parameters vehicleIdLinxioId
required Archived vehicle identifier.
Response status204 or JSON
optional Successful restore response.
curl -X POST https://api.linxio.com/api/vehicles/304/restore \ -H "Authorization: Bearer $LINXIO_TOKEN " \ -H "Content-Type: application/json" \ --data '{}' Path and query parameters vehicleIdLinxioId
required occurredAtISODateString
optional Optional occurrence timestamp.
Response fields vehicleIdLinxioId
optional occurredAtISODateString
optional Reading timestamp when supplied.
curl "https://api.linxio.com/api/vehicles/304/odometer" \ -H "Authorization: Bearer $LINXIO_TOKEN " Path and body parameters vehicleIdLinxioId
required occurredAtISODateString
required When the recalibrated reading applies.
Response fields vehicleIdLinxioId
optional curl -X POST https://api.linxio.com/api/vehicles/304/odometer \ -H "Authorization: Bearer $LINXIO_TOKEN " \ -H "Content-Type: application/json" \ --data '{ "occurredAt": "2026-06-08T12:00:00+08:00", "odometer": 123456 }' Path parameters vehicleIdLinxioId
required Response fields engineHoursnumber
optional Current engine-hours reading.
occurredAtISODateString
optional Reading timestamp when supplied.
vehicleIdLinxioId
optional curl "https://api.linxio.com/api/vehicles/304/engine-hours/current" \ -H "Authorization: Bearer $LINXIO_TOKEN " Query parameters [filter]QueryValue
optional Optional dashboard-derived filters.
Response fields Vehicle count when returned by Linxio.
Vehicle count when returned as total.
curl "https://api.linxio.com/api/vehicles/count?status=active" \ -H "Authorization: Bearer $LINXIO_TOKEN " Query parameters Maximum type records.
Default: 1000
Sort expression.
Default: order
Response fields Vehicle type display name.
Sort order when supplied.
curl "https://api.linxio.com/api/vehicles/types?limit=1000&sort=order" \ -H "Authorization: Bearer $LINXIO_TOKEN " GET
Get vehicle route history /vehicles/{vehicleId}/routeslinxio.routes.getVehicleRoutes(vehicleId, params)
Returns trip and stop history for one vehicle over a date range.
Path and query parameters vehicleIdLinxioId
required dateFromISODateString
optional dateToISODateString
optional Additional route fields. coordinates can be large.
Page size when supported.
Page number when supported.
Response fields vehicleIdLinxioId
optional Vehicle identifier for a route group.
driverIdLinxioId | null
optional Driver identifier when supplied.
routesLinxioVehicleRoute[]
optional Route segments including start/finish points, distance, duration, and optional coordinates.
curl "https://api.linxio.com/api/vehicles/304/routes?dateFrom=2026-06-01T00:00:00%2B08:00&dateTo=2026-06-08T00:00:00%2B08:00&fields[]=address" \ -H "Authorization: Bearer $LINXIO_TOKEN " Login, OTP verification, token refresh, current user, and logout HTTP endpoints.
Devices, Sensors, and Cameras
Device inventory, install/uninstall, coordinate history, sensor reports, and camera event endpoints.