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.

GET /vehicles/fields/json

GET

List vehicles

/vehicles/fields/jsonlinxio.vehicles.list(params)

Returns a paginated list of vehicles.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

number

optional

Number of records per page.

number

optional

Page number to read.

Default: 1

VehicleField[]

optional

Vehicle fields to include in the response projection.

Possible enum values

id

Vehicle identifier.

regNo

Registration number or fleet code.

defaultLabel

Default display label.

model

Vehicle model text.

depot

Depot object.

groups

Vehicle group objects.

driver

Assigned driver object.

type

Vehicle type key.

typeId

Vehicle type identifier.

typeName

Vehicle type display name.

make

Vehicle make.

makeModel

Vehicle make/model label.

vin

Vehicle identification number.

deviceId

Installed device identifier.

status

Vehicle status.

lastLoggedAt

Last telemetry timestamp.

lastCoordinates

Last known vehicle coordinates.

todayData

Current-day telemetry summary.

string

optional

Sort expression accepted by Linxio.

Response body fields

LinxioVehicle[]

optional

Vehicle rows for the current page.

Show child parameters

LinxioId

required

Vehicle identifier.

LinxioId | null

optional

Owning team identifier.

LinxioRecord | null

optional

Owning team object.

LinxioRecord | null

optional

Depot object, typically including id, name, status, createdAt, and color.

string | null

optional

Vehicle type key.

LinxioId | null

optional

Vehicle type identifier.

string | null

optional

Vehicle type display name.

string | null

optional

Vehicle manufacturer.

string | null

optional

Manufacturer model label returned by Linxio.

string | null

optional

Vehicle model text.

string | null

optional

Registration number or fleet identifier.

string | null

optional

Default display label.

string | null

optional

Vehicle identification number.

ISODateString | null

optional

Vehicle registration date when supplied.

string | null

optional

Registration certificate number when supplied.

number | null

optional

Vehicle model year when supplied.

number | null

optional

Engine power rating when supplied.

number | null

optional

Engine capacity when supplied.

number | null

optional

Accumulated engine-on time.

LinxioId | null

optional

Fuel type identifier.

number | null

optional

Fuel tank capacity.

number | null

optional

Average fuel value returned by Linxio.

string | null

optional

Emission class when supplied.

number | null

optional

CO2 emissions value when supplied.

number | null

optional

Gross vehicle weight when supplied.

LinxioRecord[]

optional

Vehicle group objects with id, name, and color.

LinxioRecord[]

optional

Current area assignments with arrival/departure timestamps.

string | null

optional

Vehicle status, such as online or offline.

LinxioRecord | null

optional

Assigned driver object. Optional extras such as driverSensorId and driverFOBId appear only when configured.

LatLng & { ts?: ISODateString } | null

optional

Last known vehicle coordinates.

ISODateString | null

optional

Last telemetry timestamp.

LinxioId | null

optional

Installed device identifier.

{ avgSpeed?: number; distance?: number; duration?: number; idleDuration?: number } | null

optional

Current-day telemetry summary when selected.

number | null

optional

Tenant-configured economical speed threshold when supplied.

number | null

optional

Tenant-configured excessive idling threshold when supplied.

number | null

optional

Average daily mileage value returned by Linxio.

ISODateString | null

optional

Vehicle creation timestamp.

LinxioRecord | null

optional

User object for the creator when supplied.

ISODateString | null

optional

Vehicle update timestamp.

LinxioRecord | null

optional

User object for the last updater when supplied.

string | null

optional

Vehicle picture URL when supplied.

string | null

optional

Unavailable reason when supplied.

number

optional

Current page number.

number

optional

Page size.

number

optional

Total matching vehicle count.

unknown

optional

Aggregation payload when supplied.

Request

curl "https://api.linxio.com/api/vehicles/fields/json?fields[]=id&fields[]=regNo&limit=100&page=1" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "data": [
    {
      "id": 64553,
      "teamId": 5932,
      "team": {
        "id": 5932,
        "type": "client",
        "clientId": 5598,
        "resellerId": null,
        "resellerName": null,
        "clientName": "EXAMPLE CLIENT"
      },
      "depot": {
        "id": 1128,
        "name": "Westminster Depot",
        "status": 1,
        "createdAt": "2026-01-15T03:59:25+00:00",
        "color": "#0065d1"
      },
      "type": "Truck",
      "typeId": 5,
      "typeName": "Utility Vehicle",
      "make": "Ford",
      "makeModel": "Ranger",
      "model": "Ford Ranger",
      "regNo": "1ABC234",
      "defaultLabel": "NW201",
      "vin": "MPBUMEF50KX208999",
      "regDate": "2019-01-02T00:00:00+00:00",
      "regCertNo": null,
      "year": 2019,
      "enginePower": 147,
      "engineCapacity": 3198,
      "engineOnTime": 95330,
      "fuelType": 9,
      "fuelTankCapacity": 80,
      "averageFuel": 0,
      "emissionClass": "5",
      "co2Emissions": 229,
      "grossWeight": 3200,
      "groups": [
        {
          "id": 1391,
          "name": "North Metropolitan",
          "color": "#009221"
        }
      ],
      "areas": [
        {
          "id": "23535401",
          "area": {
            "id": 100037,
            "name": "Nollamara District",
            "status": "active",
            "color": "#2bb100"
          },
          "driverArrived": null,
          "driverDeparted": null,
          "arrived": "2026-05-31T05:46:13+00:00",
          "departed": null
        }
      ],
      "status": "online",
      "driver": {
        "id": "36541",
        "email": "driver@example.com.au",
        "name": "Example",
        "surname": "Driver",
        "role": {
          "id": 6,
          "name": "admin",
          "displayName": "Admin"
        },
        "phone": "+61401000123",
        "status": "active",
        "lastLoggedAt": "2026-05-24T08:31:46+00:00",
        "driverSensorId": "F4CFB22527B2",
        "driverFOBId": "1"
      },
      "lastCoordinates": {
        "lat": -31.9523,
        "lng": 115.8613,
        "ts": "2026-06-08T12:00:00+08:00"
      },
      "lastLoggedAt": "2026-06-08T12:00:00+00:00",
      "deviceId": 124210,
      "todayData": {
        "distance": 0,
        "duration": 0,
        "avgSpeed": 0,
        "idleDuration": 0
      },
      "ecoSpeed": 85,
      "excessiveIdling": 120,
      "averageDailyMileage": 9047,
      "createdAt": "2026-01-15T04:07:48+00:00",
      "createdBy": {
        "id": "36421",
        "fullName": "Example User",
        "email": "user@example.com.au",
        "teamType": "client"
      },
      "updatedAt": "2026-05-30T00:35:15+00:00",
      "updatedBy": {
        "id": "36421",
        "fullName": "Example User",
        "email": "user@example.com.au",
        "teamType": "client"
      },
      "picture": null,
      "unavailableMessage": null
    }
  ],
  "page": 1,
  "limit": 100,
  "total": 2,
  "aggregations": {}
}

GET `/vehicles/{vehicleId}`

GET

Get a vehicle

/vehicles/{vehicleId}linxio.vehicles.get(vehicleId)

Returns one vehicle by ID.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Vehicle identifier.

Response body fields

LinxioId

optional

Vehicle identifier.

string

optional

Registration number when supplied.

string

optional

Display label when supplied.

ISODateString

optional

Last telemetry timestamp when supplied.

Request

curl "https://api.linxio.com/api/vehicles/304" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "id": 64553,
  "regNo": "1ABC234",
  "defaultLabel": "NW201",
  "lastLoggedAt": "2026-06-08T12:00:00+00:00"
}

POST /vehicles

POST

Create a vehicle

/vehicleslinxio.vehicles.create(payload)

Creates a vehicle record.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request body parameters

string

optional

Registration number or fleet identifier.

string

optional

Default display label.

string

optional

Vehicle model.

LinxioId

optional

Vehicle type identifier.

LinxioId | null

optional

Depot identifier.

LinxioId[]

optional

Vehicle group identifiers.

string

optional

Vehicle identification number.

Response body fields

LinxioId

optional

Created vehicle ID.

string

optional

Created vehicle registration number when supplied.

Request

curl -X POST https://api.linxio.com/api/vehicles \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "regNo": "1ABC234",
    "defaultLabel": "NW201"
  }'

Example response


{
  "id": 64553,
  "regNo": "1ABC234"
}

POST `/vehicles/{vehicleId}`

POST

Update a vehicle

/vehicles/{vehicleId}linxio.vehicles.update(vehicleId, payload)

Updates an existing vehicle.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

Vehicle identifier.

LinxioVehiclePayload

required

Fields to update.

Show child parameters

string

optional

Default display label.

LinxioId | null

optional

Depot identifier when the tenant uses depots.

LinxioId[]

optional

Vehicle group identifiers.

string

optional

Vehicle model text.

string

optional

Registration number or fleet identifier.

LinxioId

optional

Vehicle type identifier.

string

optional

Vehicle identification number.

Response body fields

LinxioId

optional

Updated vehicle ID.

string

optional

Registration number when supplied.

Request

curl -X POST https://api.linxio.com/api/vehicles/304 \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "defaultLabel": "NW202"
  }'

Example response


{
  "id": 64553,
  "regNo": "1ABC234"
}

PATCH `/vehicles/{vehicleId}/archive`

PATCH

Archive a vehicle

/vehicles/{vehicleId}/archivelinxio.vehicles.archive(vehicleId)

Soft-archives a vehicle.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Vehicle identifier.

Response headers

204 or JSON

optional

Successful archive response.

Request

curl -X PATCH https://api.linxio.com/api/vehicles/304/archive \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Example response


{
  "status": "online"
}

POST `/vehicles/{vehicleId}/restore`

POST

Restore a vehicle

/vehicles/{vehicleId}/restorelinxio.vehicles.restore(vehicleId)

Restores a previously archived vehicle.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Archived vehicle identifier.

Response headers

204 or JSON

optional

Successful restore response.

Request

curl -X POST https://api.linxio.com/api/vehicles/304/restore \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Example response


{
  "status": "online"
}

GET `/vehicles/{vehicleId}/odometer`

GET

Get vehicle odometer

/vehicles/{vehicleId}/odometerlinxio.vehicles.getOdometer(vehicleId, params)

Returns a vehicle odometer reading.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Path and query parameters

LinxioId

required

Vehicle identifier.

ISODateString

optional

Optional occurrence timestamp.

Response body fields

number

optional

Odometer reading.

LinxioId

optional

Vehicle identifier.

ISODateString

optional

Reading timestamp when supplied.

Request

curl "https://api.linxio.com/api/vehicles/304/odometer" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "odometer": 123456,
  "vehicleId": 64553,
  "occurredAt": "2026-06-08T12:00:00+08:00"
}

POST `/vehicles/{vehicleId}/odometer`

POST

Recalibrate vehicle odometer

/vehicles/{vehicleId}/odometerlinxio.vehicles.recalibrateOdometer(vehicleId, payload)

Recalibrates a vehicle odometer.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

Vehicle identifier.

ISODateString

required

When the recalibrated reading applies.

number

required

New odometer value.

Response body fields

number

optional

Updated odometer value.

LinxioId

optional

Vehicle identifier.

Request

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
  }'

Example response


{
  "odometer": 123456,
  "vehicleId": 64553
}

GET `/vehicles/{vehicleId}/engine-hours/current`

GET

Get vehicle engine hours

/vehicles/{vehicleId}/engine-hours/currentlinxio.vehicles.getEngineHours(vehicleId)

Returns the current engine-hours reading for a vehicle.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Vehicle identifier.

Response body fields

number

optional

Current engine-hours reading.

ISODateString

optional

Reading timestamp when supplied.

LinxioId

optional

Vehicle identifier.

Request

curl "https://api.linxio.com/api/vehicles/304/engine-hours/current" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "engineHours": 1234,
  "occurredAt": "2026-06-08T12:00:00+08:00",
  "vehicleId": 64553
}

GET /vehicles/count

GET

Count vehicles

/vehicles/countlinxio.vehicles.count(params)

Returns a vehicle count without fetching records.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

QueryValue

optional

Optional dashboard-derived filters.

Response body fields

number

optional

Vehicle count when returned by Linxio.

number

optional

Vehicle count when returned as total.

GET /vehicles/types

GET

List vehicle types

/vehicles/typeslinxio.vehicles.types(params)

Lists vehicle type categories.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

number

optional

Maximum type records.

Default: 1000

string

optional

Sort expression.

Default: order

Response body fields

LinxioVehicleType[]

optional

Vehicle type rows for the current page.

Show child parameters

string | null

optional

Default color for this vehicle type.

string | null

optional

Driving-state color for this vehicle type.

LinxioId

required

Vehicle type identifier.

string | null

optional

Idling-state color for this vehicle type.

string

optional

Vehicle type display name.

number

optional

Sort order when supplied.

string | null

optional

Vehicle type status.

string | null

optional

Stopped-state color for this vehicle type.

LinxioId

optional

Vehicle type identifier.

string

optional

Vehicle type display name.

string | null

optional

Dashboard color values for type states.

string | null

optional

Vehicle type status.

number

optional

Sort order when supplied.

number

optional

Current page number.

number

optional

Page size.

number

optional

Total matching type count.

Request

curl "https://api.linxio.com/api/vehicles/types?limit=1000&sort=order" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "data": [
    {
      "default": "string",
      "driving": "string",
      "id": 64553,
      "idling": "string",
      "name": "Example",
      "order": 123,
      "status": "online",
      "stopped": "string"
    }
  ],
  "data[]": {
    "id": 64553,
    "name": "Example",
    "default/driving/idling/stopped": "string",
    "status": "active",
    "order": 123
  },
  "page": 1,
  "limit": 100,
  "total": 2
}

GET `/vehicles/{vehicleId}/routes`

GET

Get vehicle route history

/vehicles/{vehicleId}/routeslinxio.routes.getVehicleRoutes(vehicleId, params)

Returns trip and stop history for one vehicle over a date range.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Path and query parameters

LinxioId

required

Vehicle identifier.

ISODateString

optional

Start date/time.

ISODateString

optional

End date/time.

RouteField[]

optional

Route fields to include in the response projection.

Possible enum values

coordinates

Route coordinate points. This can produce large responses.

driver

Driver summary for each route.

vehicle

Vehicle summary for each route.

address

Resolved start/finish addresses.

number

optional

Page size when supported.

number

optional

Page number when supported.

Response body fields

LinxioId

optional

Vehicle identifier for a route group.

LinxioId | null

optional

Driver identifier when supplied.

LinxioVehicleRoute[]

optional

Route segments including start/finish points, distance, duration, and optional coordinates.

Show child parameters

string | null

optional

Resolved address for the segment.

number | null

optional

Average speed.

string | null

optional

Route comment when supplied.

LinxioRouteCoordinate[]

optional

Route coordinate points. This field can be large.

LinxioId | null

optional

Device identifier.

number | string | null

optional

Route distance.

LinxioId | null

optional

Driver identifier.

number | null

optional

Route duration.

LinxioId

required

Route segment identifier.

number | null

optional

Maximum speed.

LinxioRoutePoint | null

optional

Finish point for the segment.

LinxioRoutePoint | null

optional

Start point for the segment.

unknown

optional

Route scope payload when supplied by Linxio.

driving | idle | stopped | string

optional

Route segment type.

LinxioId

required

Vehicle identifier.

Request

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"

Example response


{
  "vehicleId": 64553,
  "driverId": "36541",
  "routes": [
    {
      "address": "string",
      "avgSpeed": 0,
      "comment": "string",
      "coordinates": [
        {
          "lat": -31.9523,
          "lng": 115.8613,
          "ts": "2026-06-08T12:00:00+08:00",
          "id": 64553,
          "nullable": true
        }
      ],
      "deviceId": 124210,
      "distance": 0,
      "driverId": "36541",
      "duration": 0,
      "id": 64553,
      "maxSpeed": 123,
      "pointFinish": {
        "address": "string",
        "lastCoordinates": {
          "lat": -31.9523,
          "lng": 115.8613,
          "ts": "2026-06-08T12:00:00+08:00"
        }
      },
      "pointStart": {
        "address": "string",
        "lastCoordinates": {
          "lat": -31.9523,
          "lng": 115.8613,
          "ts": "2026-06-08T12:00:00+08:00"
        }
      },
      "scope": {},
      "type": "Truck",
      "vehicleId": 64553
    }
  ]
}

Vehicles and Routes

List vehicles

Request headers

Request query parameters

Response body fields

Get a vehicle

Request headers

Request url parameters

Response body fields

Create a vehicle

Request headers

Request body parameters

Response body fields

Update a vehicle

Request headers

Path and body parameters

Response body fields

Archive a vehicle

Request headers

Request url parameters

Response headers

Restore a vehicle

Request headers

Request url parameters

Response headers

Get vehicle odometer

Request headers

Path and query parameters

Response body fields

Recalibrate vehicle odometer

Request headers

Path and body parameters

Response body fields

Get vehicle engine hours

Request headers

Request url parameters

Response body fields

Count vehicles

Request headers

Request query parameters

Response body fields

List vehicle types

Request headers

Request query parameters

Response body fields

Get vehicle route history

Request headers

Path and query parameters

Response body fields

On this page