linxio-js
SDK Reference

Devices

Device inventory, install/uninstall workflows, coordinates, sensors, vendors, installations, and cameras.

Device methods cover hardware inventory and the relationship between trackers, vehicles, sensors, and cameras.

devices.list()

GET

List devices

/devices/jsonlinxio.devices.list(params)

Loads one page of devices.

Input

params.limit
number
optional
Number of devices to request.
params.page
number
optional
Page number to request.
Default: 1
params.fields
DeviceField[]
optional
Optional fields such as id, imei, serial, status, vehicle, usage, or vendor.
params.sort
string
optional
Sort expression accepted by Linxio.

Returns

data
LinxioDevice[] | null
optional
Devices for the requested page.
meta
LinxioPaginationMeta | null
optional
Pagination metadata.
error
LinxioError | null
optional
Typed SDK error when the page fails.

devices.iterate()

GET

Load all devices

/devices/jsonlinxio.devices.iterate(params)

Auto-paginates device inventory and returns one result object.

Input

params
LinxioDeviceListParams
optional
Same filters and field projection as devices.list().

Returns

data
LinxioDevice[] | null
optional
Flat array containing every loaded device.
error
LinxioError | null
optional
Typed SDK error if any page fails.

devices.stream()

GET

Stream devices

/devices/jsonlinxio.devices.stream(params)

Streams devices lazily across pages.

Input

params
LinxioDeviceListParams
optional
Same filters and field projection as devices.list().

Returns

yield
LinxioDevice
optional
One device record at a time.
throws
LinxioError
optional
Thrown if a page request fails.

devices.get()

GET

Get a device

/devices/{deviceId}linxio.devices.get(deviceId)

Fetches one device by internal Linxio device ID.

Input

deviceId
LinxioId
required
Device identifier.

Returns

data
LinxioDevice | null
optional
Device record.
error
LinxioError | null
optional
Typed SDK error when the device cannot be loaded.

devices.create()

POST

Create a device

/deviceslinxio.devices.create(payload)

Creates a device record.

Input

payload.imei
string
optional
IMEI or unique hardware identifier.
payload.serial
string
optional
Device serial number.
payload.typeId
LinxioId
optional
Device type identifier.
payload.usage
string
optional
Usage classification accepted by the tenant.
payload.vendorId
LinxioId
optional
Vendor identifier from devices.vendors().

Returns

data
LinxioDevice | null
optional
Created device.
error
LinxioError | null
optional
Typed SDK error when creation fails.

devices.update()

PATCH

Update a device

/devices/{deviceId}linxio.devices.update(deviceId, payload)

Updates a device record.

Input

deviceId
LinxioId
required
Device identifier.
payload
LinxioDevicePayload
required
Partial device payload containing fields to change.

Returns

data
LinxioDevice | null
optional
Updated device.
error
LinxioError | null
optional
Typed SDK error when update fails.

devices.install()

POST

Install a device

/devices/{deviceId}/installlinxio.devices.install(deviceId, payload)

Installs a device into a vehicle.

Input

deviceId
LinxioId
required
Device identifier.
payload.vehicleId
LinxioId
required
Vehicle receiving the device.
payload.installedAt
ISODateString
optional
Installation timestamp.
payload.odometer
number
optional
Vehicle odometer at installation time.

Returns

data
LinxioDevice | null
optional
Updated device record.
error
LinxioError | null
optional
Typed SDK error when install fails.

devices.uninstall()

POST

Uninstall a device

/devices/{deviceId}/uninstalllinxio.devices.uninstall(deviceId, payload)

Removes a device from its currently installed vehicle.

Input

deviceId
LinxioId
required
Device identifier.
payload.uninstalledAt
ISODateString
optional
Uninstall timestamp.
payload.odometer
number
optional
Vehicle odometer at uninstall time.

Returns

data
LinxioDevice | null
optional
Updated device record.
error
LinxioError | null
optional
Typed SDK error when uninstall fails.

devices.archive()

PATCH

Archive a device

/devices/{deviceId}/archivelinxio.devices.archive(deviceId)

Soft-archives a device.

Input

deviceId
LinxioId
required
Device identifier.

Returns

data
void
optional
Undefined on success.
error
LinxioError | null
optional
Typed SDK error when archive fails.

devices.restore()

PATCH

Restore a device

/devices/{deviceId}/restorelinxio.devices.restore(deviceId)

Restores a previously archived device.

Input

deviceId
LinxioId
required
Archived device identifier.

Returns

data
void
optional
Undefined on success.
error
LinxioError | null
optional
Typed SDK error when restore fails.

devices.coordinates()

GET

List device coordinates

/devices/{deviceId}/coordinateslinxio.devices.coordinates(deviceId)

Fetches recent coordinates for a device.

Input

deviceId
LinxioId
required
Device identifier.

Returns

data
LinxioDeviceCoordinate[] | null
optional
Coordinate rows including lat, lng, and ts when supplied.
error
LinxioError | null
optional
Typed SDK error when coordinates cannot be loaded.

devices.sensors()

GET

List device sensors

/devices/{deviceId}/sensorslinxio.devices.sensors(deviceId)

Lists sensors paired with a device.

Input

deviceId
LinxioId
required
Device identifier.

Returns

data
LinxioSensor[] | null
optional
Sensors associated with the device.
error
LinxioError | null
optional
Typed SDK error when sensors cannot be loaded.

devices.history()

GET

List device history

/devices/{deviceId}/historylinxio.devices.history(deviceId)

Fetches dashboard-derived device history entries.

Input

deviceId
LinxioId
required
Device identifier.

Returns

data
LinxioRecord[] | null
optional
History entries. The exact shape can vary by tenant and device type.
error
LinxioError | null
optional
Typed SDK error when history cannot be loaded.

devices.vendors()

GET

List device vendors

/devices/vendorslinxio.devices.vendors()

Lists device vendors available to the authenticated account.

Input

none
void
optional
vendors() does not take parameters.

Returns

data
LinxioDeviceVendor[] | null
optional
Vendor records, usually including id and name.
error
LinxioError | null
optional
Typed SDK error when vendors cannot be loaded.

devices.installations()

GET

List device installations

/devices/installationlinxio.devices.installations(params)

Lists device installation rows.

Input

params
LinxioDeviceListParams
optional
Pagination, sorting, fields, and dashboard-derived filters.

Returns

data
LinxioDeviceInstallation[] | null
optional
Installation rows with deviceId, vehicleId, installedAt, and uninstalledAt when supplied.
meta
LinxioPaginationMeta | null
optional
Pagination metadata.
error
LinxioError | null
optional
Typed SDK error when installations cannot be loaded.

devices.cameras()

GET

List device cameras

/devices/{deviceId}/cameraslinxio.devices.cameras(deviceId)

Lists cameras attached to a device.

Input

deviceId
LinxioId
required
Device identifier.

Returns

data
LinxioDeviceCamera[] | null
optional
Camera records with id, deviceId, name, and status when supplied.
error
LinxioError | null
optional
Typed SDK error when cameras cannot be loaded.

Vehicles

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

Users, Clients, Drivers, and Resellers

User management, client account users, driver assignment, and reseller account helpers.

On this page

devices.list()devices.iterate()devices.stream()devices.get()devices.create()devices.update()devices.install()devices.uninstall()devices.archive()devices.restore()devices.coordinates()devices.sensors()devices.history()devices.vendors()devices.installations()devices.cameras()