linxio-js
API Reference

Devices, Sensors, and Cameras

Device inventory, install/uninstall, coordinate history, sensor reports, and camera event endpoints.

Device endpoints manage hardware inventory and related telemetry. Sensor and camera endpoints are a mix of publicly documented and dashboard-derived paths.

GET /devices/json

GET

List devices

/devices/jsonlinxio.devices.list(params)

Returns a paginated list of devices.

Query parameters

limit
number
optional
Number of records per page.
page
number
optional
Page number to read.
Default: 1
fields[]
string[]
optional
Device fields to include, such as id, imei, serial, status, vehicle, usage, or vendor.
sort
string
optional
Sort expression accepted by Linxio.

Response fields

data
LinxioDevice[]
optional
Device rows for the current page.
page
number
optional
Current page number.
limit
number
optional
Page size.
total
number
optional
Total matching device count.

GET /devices/{deviceId}

GET

Get a device

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

Returns one device by ID.

Path parameters

deviceId
LinxioId
required
Device identifier.

Response fields

id
LinxioId
optional
Device identifier.
imei
string
optional
IMEI when supplied.
serial
string
optional
Serial number when supplied.
vehicleId
LinxioId
optional
Installed vehicle ID when supplied.

POST /devices

POST

Create a device

/deviceslinxio.devices.create(payload)

Creates a device record.

Body parameters

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

Response fields

id
LinxioId
optional
Created device ID.

PATCH /devices/{deviceId}

PATCH

Update a device

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

Updates a device record.

Path and body parameters

deviceId
LinxioId
required
Device identifier.
body
LinxioDevicePayload
required
Fields to update.

Response fields

id
LinxioId
optional
Updated device ID.

POST /devices/{deviceId}/install

POST

Install a device

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

Installs a device into a vehicle.

Path and body parameters

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

Response fields

id
LinxioId
optional
Updated device ID.

POST /devices/{deviceId}/uninstall

POST

Uninstall a device

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

Removes a device from its current vehicle.

Path and body parameters

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

Response fields

id
LinxioId
optional
Updated device ID.

PATCH /devices/{deviceId}/archive

PATCH

Archive a device

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

Soft-archives a device.

Path parameters

deviceId
LinxioId
required
Device identifier.

Response

status
204 or JSON
optional
Successful archive response.

PATCH /devices/{deviceId}/restore

PATCH

Restore a device

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

Restores a previously archived device.

Path parameters

deviceId
LinxioId
required
Archived device identifier.

Response

status
204 or JSON
optional
Successful restore response.

GET /devices/{deviceId}/coordinates

GET

List device coordinates

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

Returns recent coordinates for a device.

Path parameters

deviceId
LinxioId
required
Device identifier.

Response fields

lat
number
optional
Latitude.
lng
number
optional
Longitude.
ts
ISODateString
optional
Timestamp when supplied.

GET /devices/{deviceId}/sensors

GET

List device sensors

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

Lists sensors paired with a device.

Path parameters

deviceId
LinxioId
required
Device identifier.

Response fields

id
LinxioId
optional
Sensor identifier.
name
string
optional
Sensor display name when supplied.
type
string
optional
Sensor type when supplied.

GET /devices/{deviceId}/history

GET

List device history

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

Lists dashboard-derived history entries for a device.

Path parameters

deviceId
LinxioId
required
Device identifier.

Response

data
LinxioRecord[]
optional
History records. Shape can vary by device type.

GET /devices/vendors

GET

List device vendors

/devices/vendorslinxio.devices.vendors()

Lists device vendors.

Query parameters

none
void
optional
No query parameters are required.

Response fields

id
LinxioId
optional
Vendor identifier when supplied.
name
string
optional
Vendor display name.

GET /devices/installation

GET

List device installations

/devices/installationlinxio.devices.installations(params)

Lists device installation rows.

Query parameters

limit
number
optional
Number of records per page.
page
number
optional
Page number to read.
[filter]
QueryValue
optional
Dashboard-derived installation filters.

Response fields

deviceId
LinxioId
optional
Device identifier.
vehicleId
LinxioId
optional
Vehicle identifier when supplied.
installedAt
ISODateString
optional
Installation timestamp when supplied.
uninstalledAt
ISODateString
optional
Uninstall timestamp when supplied.

GET /devices/{deviceId}/cameras

GET

List device cameras

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

Lists cameras attached to a device.

Path parameters

deviceId
LinxioId
required
Device identifier.

Response fields

id
LinxioId
optional
Camera identifier when supplied.
deviceId
LinxioId
optional
Device identifier.
name
string
optional
Camera display name when supplied.
status
string
optional
Camera status when supplied.

GET /sensors

GET

List sensors

/sensorslinxio.sensors.list()

Lists sensors visible to the authenticated account.

Query parameters

none
void
optional
No query parameters are required.

Response fields

id
LinxioId
optional
Sensor identifier.
name
string
optional
Sensor display name when supplied.
type
string
optional
Sensor type when supplied.

GET /sensors/{sensorId}

GET

Get a sensor

/sensors/{sensorId}linxio.sensors.get(sensorId)

Returns one sensor by ID.

Path parameters

sensorId
LinxioId
required
Sensor identifier.

Response fields

id
LinxioId
optional
Sensor identifier.
deviceId
LinxioId
optional
Paired device ID when supplied.
vehicleId
LinxioId
optional
Vehicle ID when supplied.

POST /sensors/{sensorId}/install

POST

Install a sensor

/sensors/{sensorId}/installlinxio.sensors.install(sensorId, deviceId)

Pairs a sensor with a device.

Path and body parameters

sensorId
LinxioId
required
Sensor identifier.
deviceId
LinxioId
required
Device identifier sent in the JSON body.

Response fields

id
LinxioId
optional
Updated sensor ID.

GET /devices/sensors/report/temp-and-humidity

GET

List device temperature and humidity readings

/devices/sensors/report/temp-and-humiditylinxio.sensors.deviceTemperatureHumidityReport(params)

Returns a paginated temperature/humidity report grouped by device sensor.

Query parameters

startDate / endDate
ISODateString
optional
Report date range.
dateFrom / dateTo
ISODateString
optional
Alternative date range names used by some Linxio report flows.
sensorId
LinxioId
optional
Optional sensor filter.
vehicleId
LinxioId
optional
Optional vehicle filter.
limit
number
optional
Number of records per page.
page
number
optional
Page number to read.

Response fields

temperature
number
optional
Temperature reading when supplied.
humidity
number
optional
Humidity reading when supplied.
occurredAt
ISODateString
optional
Reading timestamp when supplied.

GET /vehicles/report/sensors/temp-and-humidity

GET

List vehicle temperature and humidity readings

/vehicles/report/sensors/temp-and-humiditylinxio.sensors.vehicleTemperatureHumidityReport(params)

Returns a paginated temperature/humidity report grouped by vehicle.

Query parameters

startDate / endDate
ISODateString
optional
Report date range.
sensorId
LinxioId
optional
Optional sensor filter.
vehicleId
LinxioId
optional
Optional vehicle filter.
limit
number
optional
Number of records per page.
page
number
optional
Page number to read.

Response fields

vehicleId
LinxioId
optional
Vehicle identifier when supplied.
temperature
number
optional
Temperature reading when supplied.
humidity
number
optional
Humidity reading when supplied.
occurredAt
ISODateString
optional
Reading timestamp when supplied.

GET /devices/cameras/events

GET

List camera events

/devices/cameras/eventslinxio.cameras.events(params)

Returns a paginated list of camera events.

Query parameters

limit
number
optional
Number of records per page.
page
number
optional
Page number to read.
fields[]
string[]
optional
Optional field projection.
[filter]
QueryValue
optional
Camera-event filters accepted by Linxio.

Response

data
LinxioRecord[]
optional
Camera event records. Shape can vary by provider.

GET /devices/cameras/events/types

GET

List camera event types

/devices/cameras/events/typeslinxio.cameras.eventTypes()

Returns camera event types known to Linxio.

Query parameters

none
void
optional
No query parameters are required.

Response

data
LinxioRecord[]
optional
Camera event type records.

On this page