Vehicles

Vehicle inventory, pagination, lifecycle, odometer, engine-hours, counts, and type helpers.

The vehicle service is the main entry point for fleet inventory. Use field projection aggressively on list and iterate calls to keep large fleets fast.

vehicles.list()

GET

List vehicles

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

Loads one page of vehicles.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

number

optional

Number of vehicles to request.

number

optional

Page number to request.

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.

QueryValue

optional

Additional filters are forwarded as query parameters.

Returns

LinxioVehicle[] | null

optional

Vehicles for the requested page.

Show child fields

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.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when the page fails to load.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

List vehicles

// Paginated list with specific fields
const { data: vehicles, error, meta } = await linxio.vehicles.list({
  fields: ["id", "regNo", "status", "lastLoggedAt"],
  limit: 50,
});

if (error) throw error;

console.log(`${meta.total} total vehicles`);

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
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

vehicles.iterate()

GET

Load all vehicles

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

Auto-paginates all vehicle pages and returns a single result object.

Input

LinxioVehicleListParams

optional

Same parameters as vehicles.list(). limit controls the page size used while collecting all pages.

Show child parameters

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.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

Returns

LinxioVehicle[] | null

optional

Flat array containing all loaded vehicles.

Show child fields

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.

LinxioError | null

optional

Typed SDK error if any page fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Iterate vehicles

const { data: vehicles, error } = await linxio.vehicles.iterate({
  fields: ["id", "regNo", "lastLoggedAt"],
  limit: 100,
});

if (error) {
  throw error;
}

for (const vehicle of vehicles) {
  console.log(vehicle.id, vehicle.regNo);
}

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
    }
  ],
  "error": null
}

vehicles.stream()

GET

Stream vehicles

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

Streams vehicles lazily across pages. Use this for large tenants or scheduled jobs where memory use matters.

Input

LinxioVehicleListParams

optional

Same parameters as vehicles.list().

Show child parameters

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.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

Returns

LinxioVehicle

optional

One vehicle at a time.

Show child fields

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.

LinxioError

optional

The generator throws if any page fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Stream vehicles

for await (const vehicle of linxio.vehicles.stream({
  fields: ["id", "regNo"],
  limit: 100,
})) {
  console.log(vehicle.id, vehicle.regNo);
}

Example response


{
  "yield": {
    "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
  }
}

vehicles.get()

GET

Get a vehicle

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

Fetches one vehicle by internal Linxio vehicle ID.

Input

LinxioId

required

Vehicle identifier.

Returns

LinxioVehicle | null

optional

The vehicle record.

Show child fields

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.

LinxioError | null

optional

Typed SDK error when the vehicle cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Get a vehicle

const vehicle = await linxio.vehicles.get(vehicleId);

if (vehicle.error) {
  throw vehicle.error;
}

console.log(vehicle.data.regNo);

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
  },
  "error": null
}

vehicles.create()

POST

Create a vehicle

/vehicleslinxio.vehicles.create(payload)

Creates a vehicle. Tenant validation rules can vary, so send only fields you know are valid for your Linxio account.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

string

optional

Registration number or fleet identifier.

string

optional

Default display label.

string

optional

Vehicle model text.

LinxioId

optional

Vehicle type ID from vehicles.types().

LinxioId | null

optional

Depot identifier when the tenant uses depots.

LinxioId[]

optional

Vehicle group IDs.

string

optional

Vehicle identification number.

Returns

LinxioVehicle | null

optional

Created vehicle.

Show child fields

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.

LinxioError | null

optional

Typed SDK error when creation fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Create a vehicle

const created = await linxio.vehicles.create({
  regNo: "1ABC234",
  defaultLabel: "NW201",
  typeId: vehicleTypeId,
});

if (created.error) {
  throw created.error;
}

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
  },
  "error": null
}

vehicles.update()

POST

Update a vehicle

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

Updates vehicle fields using Linxio's POST update endpoint.

Input

LinxioId

required

Vehicle identifier.

LinxioVehiclePayload

required

Partial vehicle payload containing fields to change.

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.

Returns

LinxioVehicle | null

optional

Updated vehicle.

Show child fields

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.

LinxioError | null

optional

Typed SDK error when update fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Update a vehicle

const updated = await linxio.vehicles.update(vehicleId, {
  defaultLabel: "NW202",
});

if (updated.error) {
  throw updated.error;
}

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
  },
  "error": null
}

vehicles.archive()

PATCH

Archive a vehicle

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

Soft-archives a vehicle. Prefer this over destructive actions when you need reversibility.

Input

LinxioId

required

Vehicle identifier.

Returns

void

optional

Undefined on success.

LinxioError | null

optional

Typed SDK error when archive fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

vehicles.restore()

POST

Restore a vehicle

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

Restores a previously archived vehicle.

Input

LinxioId

required

Archived vehicle identifier.

Returns

void

optional

Undefined on success.

LinxioError | null

optional

Typed SDK error when restore fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

vehicles.getOdometer()

GET

Get vehicle odometer

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

Reads the current odometer value, or the value at a supplied occurrence time when Linxio supports it for the tenant.

Input

LinxioId

required

Vehicle identifier.

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

ISODateString

optional

Optional occurrence timestamp.

Returns

object

optional

Object field. Expand to see child fields.

Show child fields

number

optional

Odometer reading.

LinxioId

optional

Vehicle the reading belongs to.

LinxioError | null

optional

Typed SDK error when the reading cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Read odometer

const odometer = await linxio.vehicles.getOdometer(vehicleId);

if (odometer.error) {
  throw odometer.error;
}

console.log(odometer.data.odometer);

Example response


{
  "data": {
    "odometer": 123456,
    "vehicleId": 64553
  },
  "error": null
}

vehicles.recalibrateOdometer()

POST

Recalibrate vehicle odometer

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

Recalibrates a vehicle odometer. Treat this as an operational change and only call it with confirmed values.

Input

LinxioId

required

Vehicle identifier.

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

ISODateString

required

When the recalibrated reading applies.

number

required

New odometer value.

Returns

LinxioOdometer | null

optional

Updated odometer reading.

Show child fields

number | null

optional

Reading accuracy when supplied.

LinxioId | null

optional

Device identifier.

LinxioId | null

optional

Driver identifier.

LinxioId | null

optional

Odometer reading identifier.

boolean

optional

Whether the reading is synced with the device.

ISODateString | null

optional

Timestamp of the last tracker record.

number | null

optional

Odometer value from the last tracker record.

ISODateString | null

optional

Timestamp associated with the reading.

number

required

Odometer reading.

LinxioId

required

Vehicle identifier.

LinxioError | null

optional

Typed SDK error when recalibration fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Recalibrate odometer

const recalibrated = await linxio.vehicles.recalibrateOdometer(vehicleId, {
  occurredAt: new Date().toISOString(),
  odometer: 123456,
});

if (recalibrated.error) {
  throw recalibrated.error;
}

Example response


{
  "data": {
    "accuracy": 123,
    "deviceId": 124210,
    "driverId": "36541",
    "id": 64553,
    "isSyncedWithDevice": true,
    "lastTrackerRecordOccurredAt": "2026-06-08T12:00:00+08:00",
    "lastTrackerRecordOdometer": 123456,
    "occurredAt": "2026-06-08T12:00:00+08:00",
    "odometer": 123456,
    "vehicleId": 64553
  },
  "error": null
}

vehicles.getEngineHours()

GET

Get vehicle engine hours

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

Reads the current engine-hours value for a vehicle.

Input

LinxioId

required

Vehicle identifier.

Returns

object

optional

Object field. Expand to see child fields.

Show child fields

number

optional

Current engine-hours reading.

ISODateString | null

optional

Timestamp associated with the reading when supplied.

LinxioError | null

optional

Typed SDK error when the reading cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Read engine hours

const engineHours = await linxio.vehicles.getEngineHours(vehicleId);

if (engineHours.error) {
  throw engineHours.error;
}

console.log(engineHours.data.engineHours);

Example response


{
  "data": {
    "engineHours": 1234,
    "occurredAt": "2026-06-08T12:00:00+08:00"
  },
  "error": null
}

vehicles.count()

GET

Count vehicles

/vehicles/countlinxio.vehicles.count(params)

Returns a count without fetching vehicle records.

Input

LinxioVehicleCountParams

optional

Optional dashboard-derived filters forwarded as query parameters.

Returns

object

optional

Object field. Expand to see child fields.

Show child fields

number

optional

Vehicle count when Linxio returns count.

number

optional

Vehicle count when Linxio returns total.

LinxioError | null

optional

Typed SDK error when count fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Count vehicles

const count = await linxio.vehicles.count({ status: "active" });

if (count.error) {
  throw count.error;
}

console.log(count.data.count ?? count.data.total ?? 0);

Example response


{
  "data": {
    "count": 2,
    "total": 2
  },
  "error": null
}

vehicles.types()

GET

List vehicle types

/vehicles/typeslinxio.vehicles.types(params)

Lists vehicle type categories visible to the authenticated account.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

number

optional

Maximum number of type records.

Default: 1000

string

optional

Sort expression.

Default: order

QueryValue

optional

Additional filters forwarded as query parameters.

Returns

LinxioVehicleType[] | null

optional

Vehicle type records for the requested page, including id, name, color fields, status, and order.

Show child fields

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.

LinxioPaginationMeta | null

optional

Pagination metadata returned by Linxio.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when type loading fails.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Vehicle types

const types = await linxio.vehicles.types();

if (types.error) {
  throw types.error;
}

console.log(types.meta.total);
const lightVehicle = types.data.find((type) => type.name === "Light Vehicle");

Example response


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

Vehicles

List vehicles

Input

Returns

Load all vehicles

Input

Returns

Stream vehicles

Input

Returns

Get a vehicle

Input

Returns

Create a vehicle

Input

Returns

Update a vehicle

Input

Returns

Archive a vehicle

Input

Returns

Restore a vehicle

Input

Returns

Get vehicle odometer

Input

Returns

Recalibrate vehicle odometer

Input

Returns

Get vehicle engine hours

Input

Returns

Count vehicles

Input

Returns

List vehicle types

Input

Returns

On this page