Devices

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

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

number

optional

Number of devices to request.

number

optional

Page number to request.

Default: 1

DeviceField[]

optional

Device fields to include in the response projection.

Possible enum values

id

Device identifier.

imei

Device IMEI.

serial

Device serial number.

status

Device status.

vehicle

Assigned vehicle summary.

usage

Usage label when supplied.

vendor

Device vendor label.

model

Device model object.

trackerData

Last tracker data object.

deviceInstallation

Current installation details when assigned.

string

optional

Sort expression accepted by Linxio.

Returns

LinxioDevice[] | null

optional

Devices for the requested page.

Show child fields

LinxioId

required

Device identifier.

string | null

optional

Device IMEI when supplied.

LinxioDeviceVendor | string | null

optional

Device vendor object when expanded.

LinxioRecord | string | null

optional

Device model object when expanded.

string | null

optional

SIM phone number when supplied.

string | null

optional

SIM IMSI when supplied.

string | null

optional

SIM ICCID when supplied.

ISODateString | null

optional

Current install date when assigned.

ISODateString | null

optional

Uninstall date when no longer assigned.

LinxioDeviceInstallation | null

optional

Current installation object.

LatLng & { ts?: ISODateString } | null

optional

Last known device coordinates.

string | null

optional

Device serial number.

string | null

optional

Device status.

string | null

optional

Extended device status.

ISODateString | null

optional

Last active timestamp.

ISODateString | null

optional

Last tracker data timestamp.

LinxioRecord | null

optional

Last tracker payload when supplied.

string | null

optional

Usage label when supplied.

LinxioId | null

optional

Assigned vehicle identifier.

boolean

optional

Whether Linxio reports cameras on this device.

boolean

optional

Whether the device is deactivated.

boolean

optional

Whether the device is unavailable.

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.

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 devices

const devices = await linxio.devices.list({
  fields: ["id", "imei", "serial", "vehicle"],
  limit: 100,
});

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

Example response


{
  "data": [
    {
      "id": 64553,
      "imei": "string",
      "vendor": {
        "id": 64553,
        "name": "Example",
        "models": [
          {}
        ]
      },
      "model": "Ford Ranger",
      "phone": "string",
      "imsi": "string",
      "iccid": "string",
      "installDate": "2026-06-08T12:00:00+08:00",
      "uninstallDate": "2026-06-08T12:00:00+08:00",
      "deviceInstallation": {
        "device": {},
        "deviceId": 124210,
        "files": [
          {}
        ],
        "id": 64553,
        "installDate": "2026-06-08T12:00:00+08:00",
        "odometer": 123456,
        "uninstallDate": "2026-06-08T12:00:00+08:00",
        "vehicle": {},
        "vehicleId": 64553
      },
      "lastCoordinates": {
        "lat": -31.9523,
        "lng": 115.8613,
        "ts": "2026-06-08T12:00:00+08:00"
      },
      "serial": "string",
      "status": "online",
      "statusExt": "active",
      "lastActiveTime": "2026-06-08T12:00:00+08:00",
      "lastDataReceivedAt": "2026-06-08T12:00:00+08:00",
      "trackerData": {},
      "usage": "string",
      "vehicleId": 64553,
      "hasCameras": true,
      "isDeactivated": true,
      "isUnavailable": true
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

devices.iterate()

GET

Load all devices

/devices/jsonlinxio.devices.iterate(params)

Auto-paginates device inventory and returns one result object.

Input

LinxioDeviceListParams

optional

Same filters and field projection as devices.list().

Show child parameters

DeviceField[]

optional

Device fields to include in the response projection.

Possible enum values

id

Device identifier.

imei

Device IMEI.

serial

Device serial number.

status

Device status.

vehicle

Assigned vehicle summary.

usage

Usage label when supplied.

vendor

Device vendor label.

model

Device model object.

trackerData

Last tracker data object.

deviceInstallation

Current installation details when assigned.

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

LinxioDevice[] | null

optional

Flat array containing every loaded device.

Show child fields

LinxioId

required

Device identifier.

string | null

optional

Device IMEI when supplied.

LinxioDeviceVendor | string | null

optional

Device vendor object when expanded.

LinxioRecord | string | null

optional

Device model object when expanded.

string | null

optional

SIM phone number when supplied.

string | null

optional

SIM IMSI when supplied.

string | null

optional

SIM ICCID when supplied.

ISODateString | null

optional

Current install date when assigned.

ISODateString | null

optional

Uninstall date when no longer assigned.

LinxioDeviceInstallation | null

optional

Current installation object.

LatLng & { ts?: ISODateString } | null

optional

Last known device coordinates.

string | null

optional

Device serial number.

string | null

optional

Device status.

string | null

optional

Extended device status.

ISODateString | null

optional

Last active timestamp.

ISODateString | null

optional

Last tracker data timestamp.

LinxioRecord | null

optional

Last tracker payload when supplied.

string | null

optional

Usage label when supplied.

LinxioId | null

optional

Assigned vehicle identifier.

boolean

optional

Whether Linxio reports cameras on this device.

boolean

optional

Whether the device is deactivated.

boolean

optional

Whether the device is unavailable.

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 devices

const { data: devices, error } = await linxio.devices.iterate({
  fields: ["id", "imei", "status"],
  limit: 100,
});

if (error) {
  throw error;
}

Example response


{
  "data": [
    {
      "id": 64553,
      "imei": "string",
      "vendor": {
        "id": 64553,
        "name": "Example",
        "models": [
          {}
        ]
      },
      "model": "Ford Ranger",
      "phone": "string",
      "imsi": "string",
      "iccid": "string",
      "installDate": "2026-06-08T12:00:00+08:00",
      "uninstallDate": "2026-06-08T12:00:00+08:00",
      "deviceInstallation": {
        "device": {},
        "deviceId": 124210,
        "files": [
          {}
        ],
        "id": 64553,
        "installDate": "2026-06-08T12:00:00+08:00",
        "odometer": 123456,
        "uninstallDate": "2026-06-08T12:00:00+08:00",
        "vehicle": {},
        "vehicleId": 64553
      },
      "lastCoordinates": {
        "lat": -31.9523,
        "lng": 115.8613,
        "ts": "2026-06-08T12:00:00+08:00"
      },
      "serial": "string",
      "status": "online",
      "statusExt": "active",
      "lastActiveTime": "2026-06-08T12:00:00+08:00",
      "lastDataReceivedAt": "2026-06-08T12:00:00+08:00",
      "trackerData": {},
      "usage": "string",
      "vehicleId": 64553,
      "hasCameras": true,
      "isDeactivated": true,
      "isUnavailable": true
    }
  ],
  "error": null
}

devices.stream()

GET

Stream devices

/devices/jsonlinxio.devices.stream(params)

Streams devices lazily across pages.

Input

LinxioDeviceListParams

optional

Same filters and field projection as devices.list().

Show child parameters

DeviceField[]

optional

Device fields to include in the response projection.

Possible enum values

id

Device identifier.

imei

Device IMEI.

serial

Device serial number.

status

Device status.

vehicle

Assigned vehicle summary.

usage

Usage label when supplied.

vendor

Device vendor label.

model

Device model object.

trackerData

Last tracker data object.

deviceInstallation

Current installation details when assigned.

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

LinxioDevice

optional

One device record at a time.

Show child fields

LinxioId

required

Device identifier.

string | null

optional

Device IMEI when supplied.

LinxioDeviceVendor | string | null

optional

Device vendor object when expanded.

LinxioRecord | string | null

optional

Device model object when expanded.

string | null

optional

SIM phone number when supplied.

string | null

optional

SIM IMSI when supplied.

string | null

optional

SIM ICCID when supplied.

ISODateString | null

optional

Current install date when assigned.

ISODateString | null

optional

Uninstall date when no longer assigned.

LinxioDeviceInstallation | null

optional

Current installation object.

LatLng & { ts?: ISODateString } | null

optional

Last known device coordinates.

string | null

optional

Device serial number.

string | null

optional

Device status.

string | null

optional

Extended device status.

ISODateString | null

optional

Last active timestamp.

ISODateString | null

optional

Last tracker data timestamp.

LinxioRecord | null

optional

Last tracker payload when supplied.

string | null

optional

Usage label when supplied.

LinxioId | null

optional

Assigned vehicle identifier.

boolean

optional

Whether Linxio reports cameras on this device.

boolean

optional

Whether the device is deactivated.

boolean

optional

Whether the device is unavailable.

LinxioError

optional

Thrown if a page request 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 devices

for await (const device of linxio.devices.stream({ limit: 100 })) {
  console.log(device.id, device.imei);
}

Example response


{
  "yield": {
    "id": 64553,
    "imei": "string",
    "vendor": {
      "id": 64553,
      "name": "Example",
      "models": [
        {}
      ]
    },
    "model": "Ford Ranger",
    "phone": "string",
    "imsi": "string",
    "iccid": "string",
    "installDate": "2026-06-08T12:00:00+08:00",
    "uninstallDate": "2026-06-08T12:00:00+08:00",
    "deviceInstallation": {
      "device": {},
      "deviceId": 124210,
      "files": [
        {}
      ],
      "id": 64553,
      "installDate": "2026-06-08T12:00:00+08:00",
      "odometer": 123456,
      "uninstallDate": "2026-06-08T12:00:00+08:00",
      "vehicle": {},
      "vehicleId": 64553
    },
    "lastCoordinates": {
      "lat": -31.9523,
      "lng": 115.8613,
      "ts": "2026-06-08T12:00:00+08:00"
    },
    "serial": "string",
    "status": "online",
    "statusExt": "active",
    "lastActiveTime": "2026-06-08T12:00:00+08:00",
    "lastDataReceivedAt": "2026-06-08T12:00:00+08:00",
    "trackerData": {},
    "usage": "string",
    "vehicleId": 64553,
    "hasCameras": true,
    "isDeactivated": true,
    "isUnavailable": true
  }
}

devices.get()

GET

Get a device

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

Fetches one device by internal Linxio device ID.

Input

LinxioId

required

Device identifier.

Returns

LinxioDevice | null

optional

Device record.

Show child fields

LinxioId

required

Device identifier.

string | null

optional

Device IMEI when supplied.

LinxioDeviceVendor | string | null

optional

Device vendor object when expanded.

LinxioRecord | string | null

optional

Device model object when expanded.

string | null

optional

SIM phone number when supplied.

string | null

optional

SIM IMSI when supplied.

string | null

optional

SIM ICCID when supplied.

ISODateString | null

optional

Current install date when assigned.

ISODateString | null

optional

Uninstall date when no longer assigned.

LinxioDeviceInstallation | null

optional

Current installation object.

LatLng & { ts?: ISODateString } | null

optional

Last known device coordinates.

string | null

optional

Device serial number.

string | null

optional

Device status.

string | null

optional

Extended device status.

ISODateString | null

optional

Last active timestamp.

ISODateString | null

optional

Last tracker data timestamp.

LinxioRecord | null

optional

Last tracker payload when supplied.

string | null

optional

Usage label when supplied.

LinxioId | null

optional

Assigned vehicle identifier.

boolean

optional

Whether Linxio reports cameras on this device.

boolean

optional

Whether the device is deactivated.

boolean

optional

Whether the device is unavailable.

LinxioError | null

optional

Typed SDK error when the device 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 device

const device = await linxio.devices.get(deviceId);

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

Example response


{
  "data": {
    "id": 64553,
    "imei": "string",
    "vendor": {
      "id": 64553,
      "name": "Example",
      "models": [
        {}
      ]
    },
    "model": "Ford Ranger",
    "phone": "string",
    "imsi": "string",
    "iccid": "string",
    "installDate": "2026-06-08T12:00:00+08:00",
    "uninstallDate": "2026-06-08T12:00:00+08:00",
    "deviceInstallation": {
      "device": {},
      "deviceId": 124210,
      "files": [
        {}
      ],
      "id": 64553,
      "installDate": "2026-06-08T12:00:00+08:00",
      "odometer": 123456,
      "uninstallDate": "2026-06-08T12:00:00+08:00",
      "vehicle": {},
      "vehicleId": 64553
    },
    "lastCoordinates": {
      "lat": -31.9523,
      "lng": 115.8613,
      "ts": "2026-06-08T12:00:00+08:00"
    },
    "serial": "string",
    "status": "online",
    "statusExt": "active",
    "lastActiveTime": "2026-06-08T12:00:00+08:00",
    "lastDataReceivedAt": "2026-06-08T12:00:00+08:00",
    "trackerData": {},
    "usage": "string",
    "vehicleId": 64553,
    "hasCameras": true,
    "isDeactivated": true,
    "isUnavailable": true
  },
  "error": null
}

devices.create()

POST

Create a device

/deviceslinxio.devices.create(payload)

Creates a device record.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

string

optional

IMEI or unique hardware identifier.

string

optional

Device serial number.

LinxioId

optional

Device type identifier.

string

optional

Usage classification accepted by the tenant.

LinxioId

optional

Vendor identifier from devices.vendors().

Returns

LinxioDevice | null

optional

Created device.

Show child fields

LinxioId

required

Device identifier.

string | null

optional

Device IMEI when supplied.

LinxioDeviceVendor | string | null

optional

Device vendor object when expanded.

LinxioRecord | string | null

optional

Device model object when expanded.

string | null

optional

SIM phone number when supplied.

string | null

optional

SIM IMSI when supplied.

string | null

optional

SIM ICCID when supplied.

ISODateString | null

optional

Current install date when assigned.

ISODateString | null

optional

Uninstall date when no longer assigned.

LinxioDeviceInstallation | null

optional

Current installation object.

LatLng & { ts?: ISODateString } | null

optional

Last known device coordinates.

string | null

optional

Device serial number.

string | null

optional

Device status.

string | null

optional

Extended device status.

ISODateString | null

optional

Last active timestamp.

ISODateString | null

optional

Last tracker data timestamp.

LinxioRecord | null

optional

Last tracker payload when supplied.

string | null

optional

Usage label when supplied.

LinxioId | null

optional

Assigned vehicle identifier.

boolean

optional

Whether Linxio reports cameras on this device.

boolean

optional

Whether the device is deactivated.

boolean

optional

Whether the device is unavailable.

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 device

const created = await linxio.devices.create({
  imei: "123456789012345",
  serial: "SDK-TEST-001",
  vendorId,
});

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

Example response


{
  "data": {
    "id": 64553,
    "imei": "string",
    "vendor": {
      "id": 64553,
      "name": "Example",
      "models": [
        {}
      ]
    },
    "model": "Ford Ranger",
    "phone": "string",
    "imsi": "string",
    "iccid": "string",
    "installDate": "2026-06-08T12:00:00+08:00",
    "uninstallDate": "2026-06-08T12:00:00+08:00",
    "deviceInstallation": {
      "device": {},
      "deviceId": 124210,
      "files": [
        {}
      ],
      "id": 64553,
      "installDate": "2026-06-08T12:00:00+08:00",
      "odometer": 123456,
      "uninstallDate": "2026-06-08T12:00:00+08:00",
      "vehicle": {},
      "vehicleId": 64553
    },
    "lastCoordinates": {
      "lat": -31.9523,
      "lng": 115.8613,
      "ts": "2026-06-08T12:00:00+08:00"
    },
    "serial": "string",
    "status": "online",
    "statusExt": "active",
    "lastActiveTime": "2026-06-08T12:00:00+08:00",
    "lastDataReceivedAt": "2026-06-08T12:00:00+08:00",
    "trackerData": {},
    "usage": "string",
    "vehicleId": 64553,
    "hasCameras": true,
    "isDeactivated": true,
    "isUnavailable": true
  },
  "error": null
}

devices.update()

PATCH

Update a device

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

Updates a device record.

Input

LinxioId

required

Device identifier.

LinxioDevicePayload

required

Partial device payload containing fields to change.

Show child parameters

string

optional

Device IMEI.

string

optional

Device serial number.

LinxioId

optional

Device type identifier.

string

optional

Usage label.

LinxioId

optional

Vendor identifier.

Returns

LinxioDevice | null

optional

Updated device.

Show child fields

LinxioId

required

Device identifier.

string | null

optional

Device IMEI when supplied.

LinxioDeviceVendor | string | null

optional

Device vendor object when expanded.

LinxioRecord | string | null

optional

Device model object when expanded.

string | null

optional

SIM phone number when supplied.

string | null

optional

SIM IMSI when supplied.

string | null

optional

SIM ICCID when supplied.

ISODateString | null

optional

Current install date when assigned.

ISODateString | null

optional

Uninstall date when no longer assigned.

LinxioDeviceInstallation | null

optional

Current installation object.

LatLng & { ts?: ISODateString } | null

optional

Last known device coordinates.

string | null

optional

Device serial number.

string | null

optional

Device status.

string | null

optional

Extended device status.

ISODateString | null

optional

Last active timestamp.

ISODateString | null

optional

Last tracker data timestamp.

LinxioRecord | null

optional

Last tracker payload when supplied.

string | null

optional

Usage label when supplied.

LinxioId | null

optional

Assigned vehicle identifier.

boolean

optional

Whether Linxio reports cameras on this device.

boolean

optional

Whether the device is deactivated.

boolean

optional

Whether the device is unavailable.

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 device

const updated = await linxio.devices.update(deviceId, {
  serial: "SDK-TEST-001-UPDATED",
});

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

Example response


{
  "data": {
    "id": 64553,
    "imei": "string",
    "vendor": {
      "id": 64553,
      "name": "Example",
      "models": [
        {}
      ]
    },
    "model": "Ford Ranger",
    "phone": "string",
    "imsi": "string",
    "iccid": "string",
    "installDate": "2026-06-08T12:00:00+08:00",
    "uninstallDate": "2026-06-08T12:00:00+08:00",
    "deviceInstallation": {
      "device": {},
      "deviceId": 124210,
      "files": [
        {}
      ],
      "id": 64553,
      "installDate": "2026-06-08T12:00:00+08:00",
      "odometer": 123456,
      "uninstallDate": "2026-06-08T12:00:00+08:00",
      "vehicle": {},
      "vehicleId": 64553
    },
    "lastCoordinates": {
      "lat": -31.9523,
      "lng": 115.8613,
      "ts": "2026-06-08T12:00:00+08:00"
    },
    "serial": "string",
    "status": "online",
    "statusExt": "active",
    "lastActiveTime": "2026-06-08T12:00:00+08:00",
    "lastDataReceivedAt": "2026-06-08T12:00:00+08:00",
    "trackerData": {},
    "usage": "string",
    "vehicleId": 64553,
    "hasCameras": true,
    "isDeactivated": true,
    "isUnavailable": true
  },
  "error": null
}

devices.install()

POST

Install a device

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

Installs a device into a vehicle.

Input

LinxioId

required

Device identifier.

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

LinxioId

required

Vehicle receiving the device.

ISODateString

optional

Installation timestamp.

number

optional

Vehicle odometer at installation time.

Returns

LinxioDevice | null

optional

Updated device record.

Show child fields

LinxioId

required

Device identifier.

string | null

optional

Device IMEI when supplied.

LinxioDeviceVendor | string | null

optional

Device vendor object when expanded.

LinxioRecord | string | null

optional

Device model object when expanded.

string | null

optional

SIM phone number when supplied.

string | null

optional

SIM IMSI when supplied.

string | null

optional

SIM ICCID when supplied.

ISODateString | null

optional

Current install date when assigned.

ISODateString | null

optional

Uninstall date when no longer assigned.

LinxioDeviceInstallation | null

optional

Current installation object.

LatLng & { ts?: ISODateString } | null

optional

Last known device coordinates.

string | null

optional

Device serial number.

string | null

optional

Device status.

string | null

optional

Extended device status.

ISODateString | null

optional

Last active timestamp.

ISODateString | null

optional

Last tracker data timestamp.

LinxioRecord | null

optional

Last tracker payload when supplied.

string | null

optional

Usage label when supplied.

LinxioId | null

optional

Assigned vehicle identifier.

boolean

optional

Whether Linxio reports cameras on this device.

boolean

optional

Whether the device is deactivated.

boolean

optional

Whether the device is unavailable.

LinxioError | null

optional

Typed SDK error when install 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.

Install a device

const installed = await linxio.devices.install(deviceId, {
  vehicleId,
  installedAt: new Date().toISOString(),
  odometer: 123456,
});

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

Example response


{
  "data": {
    "id": 64553,
    "imei": "string",
    "vendor": {
      "id": 64553,
      "name": "Example",
      "models": [
        {}
      ]
    },
    "model": "Ford Ranger",
    "phone": "string",
    "imsi": "string",
    "iccid": "string",
    "installDate": "2026-06-08T12:00:00+08:00",
    "uninstallDate": "2026-06-08T12:00:00+08:00",
    "deviceInstallation": {
      "device": {},
      "deviceId": 124210,
      "files": [
        {}
      ],
      "id": 64553,
      "installDate": "2026-06-08T12:00:00+08:00",
      "odometer": 123456,
      "uninstallDate": "2026-06-08T12:00:00+08:00",
      "vehicle": {},
      "vehicleId": 64553
    },
    "lastCoordinates": {
      "lat": -31.9523,
      "lng": 115.8613,
      "ts": "2026-06-08T12:00:00+08:00"
    },
    "serial": "string",
    "status": "online",
    "statusExt": "active",
    "lastActiveTime": "2026-06-08T12:00:00+08:00",
    "lastDataReceivedAt": "2026-06-08T12:00:00+08:00",
    "trackerData": {},
    "usage": "string",
    "vehicleId": 64553,
    "hasCameras": true,
    "isDeactivated": true,
    "isUnavailable": true
  },
  "error": null
}

devices.uninstall()

POST

Uninstall a device

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

Removes a device from its currently installed vehicle.

Input

LinxioId

required

Device identifier.

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

ISODateString

optional

Uninstall timestamp.

number

optional

Vehicle odometer at uninstall time.

Returns

LinxioDevice | null

optional

Updated device record.

Show child fields

LinxioId

required

Device identifier.

string | null

optional

Device IMEI when supplied.

LinxioDeviceVendor | string | null

optional

Device vendor object when expanded.

LinxioRecord | string | null

optional

Device model object when expanded.

string | null

optional

SIM phone number when supplied.

string | null

optional

SIM IMSI when supplied.

string | null

optional

SIM ICCID when supplied.

ISODateString | null

optional

Current install date when assigned.

ISODateString | null

optional

Uninstall date when no longer assigned.

LinxioDeviceInstallation | null

optional

Current installation object.

LatLng & { ts?: ISODateString } | null

optional

Last known device coordinates.

string | null

optional

Device serial number.

string | null

optional

Device status.

string | null

optional

Extended device status.

ISODateString | null

optional

Last active timestamp.

ISODateString | null

optional

Last tracker data timestamp.

LinxioRecord | null

optional

Last tracker payload when supplied.

string | null

optional

Usage label when supplied.

LinxioId | null

optional

Assigned vehicle identifier.

boolean

optional

Whether Linxio reports cameras on this device.

boolean

optional

Whether the device is deactivated.

boolean

optional

Whether the device is unavailable.

LinxioError | null

optional

Typed SDK error when uninstall 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.

Uninstall a device

const uninstalled = await linxio.devices.uninstall(deviceId, {
  uninstalledAt: new Date().toISOString(),
});

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

Example response


{
  "data": {
    "id": 64553,
    "imei": "string",
    "vendor": {
      "id": 64553,
      "name": "Example",
      "models": [
        {}
      ]
    },
    "model": "Ford Ranger",
    "phone": "string",
    "imsi": "string",
    "iccid": "string",
    "installDate": "2026-06-08T12:00:00+08:00",
    "uninstallDate": "2026-06-08T12:00:00+08:00",
    "deviceInstallation": {
      "device": {},
      "deviceId": 124210,
      "files": [
        {}
      ],
      "id": 64553,
      "installDate": "2026-06-08T12:00:00+08:00",
      "odometer": 123456,
      "uninstallDate": "2026-06-08T12:00:00+08:00",
      "vehicle": {},
      "vehicleId": 64553
    },
    "lastCoordinates": {
      "lat": -31.9523,
      "lng": 115.8613,
      "ts": "2026-06-08T12:00:00+08:00"
    },
    "serial": "string",
    "status": "online",
    "statusExt": "active",
    "lastActiveTime": "2026-06-08T12:00:00+08:00",
    "lastDataReceivedAt": "2026-06-08T12:00:00+08:00",
    "trackerData": {},
    "usage": "string",
    "vehicleId": 64553,
    "hasCameras": true,
    "isDeactivated": true,
    "isUnavailable": true
  },
  "error": null
}

devices.archive()

PATCH

Archive a device

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

Soft-archives a device.

Input

LinxioId

required

Device 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.

devices.restore()

PATCH

Restore a device

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

Restores a previously archived device.

Input

LinxioId

required

Archived device 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.

devices.coordinates()

GET

List device coordinates

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

Fetches coordinates for a device. In the live tenant this endpoint expects a date range; call it with dateFrom and dateTo rather than relying on server defaults.

Input

LinxioId

required

Device identifier.

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

ISODateString

optional

Start of the coordinate window.

ISODateString

optional

End of the coordinate window.

string

optional

Optional dashboard-derived coordinate filter.

Returns

LinxioDeviceCoordinate[] | null

optional

Coordinate rows including lat, lng, and ts when supplied.

Show child fields

number

required

Latitude in decimal degrees.

number

required

Longitude in decimal degrees.

ISODateString

optional

Telemetry timestamp when supplied by Linxio.

LinxioId

optional

Device identifier.

LinxioId

optional

Coordinate record identifier.

LinxioError | null

optional

Typed SDK error when coordinates 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.

Device coordinates

const coordinates = await linxio.devices.coordinates(deviceId, {
  dateFrom: "2026-06-01T00:00:00+08:00",
  dateTo: "2026-06-02T00:00:00+08:00",
});

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

Example response


{
  "data": [
    {
      "lat": -31.9523,
      "lng": 115.8613,
      "ts": "2026-06-08T12:00:00+08:00",
      "deviceId": 124210,
      "id": 64553
    }
  ],
  "error": null
}

devices.sensors()

GET

List device sensors

/devices/{deviceId}/sensors/historylinxio.devices.sensors(deviceId, params)

Lists historical sensor rows associated with a device.

Input

LinxioId

required

Device identifier.

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

number

optional

Number of sensor rows to request.

number

optional

Page number to request.

Default: 1

SensorField[]

optional

Sensor fields to include in the response projection.

Possible enum values

id

Sensor identifier.

label

Sensor display label.

sensorId

Hardware sensor identifier.

systemStatus

Sensor system status.

team

Owning team summary.

type

Sensor type.

Returns

LinxioSensor[] | null

optional

Sensor rows associated with the device.

Show child fields

ISODateString | null

optional

Sensor creation timestamp.

LinxioId | null

optional

Device identifier.

LinxioId

required

Sensor identifier.

string | null

optional

Sensor display label.

string | null

optional

Hardware sensor identifier.

string | null

optional

Sensor system status.

LinxioRecord | null

optional

Owning team summary.

string | null

optional

Sensor type.

ISODateString | null

optional

Last update timestamp.

LinxioId | null

optional

Vehicle identifier.

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 sensors 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.

Device sensors

const sensors = await linxio.devices.sensors(deviceId, {
  limit: 25,
  page: 1,
});

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

Example response


{
  "data": [
    {
      "createdAt": "2026-01-15T04:07:48+00:00",
      "deviceId": 124210,
      "id": 64553,
      "label": "Example Label",
      "sensorId": "string",
      "systemStatus": "active",
      "team": {
        "id": 5932,
        "type": "client",
        "clientId": 5598,
        "resellerId": null,
        "resellerName": null,
        "clientName": "EXAMPLE CLIENT"
      },
      "type": "Truck",
      "updatedAt": "2026-05-30T00:35:15+00:00",
      "vehicleId": 64553
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

devices.history()

GET

List device history

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

Fetches dashboard-derived device history entries.

Input

LinxioId

required

Device identifier.

Returns

LinxioRecord[] | null

optional

History entries. The exact shape can vary by tenant and device type.

LinxioError | null

optional

Typed SDK error when history 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.

devices.vendors()

GET

List device vendors

/devices/vendors/linxio.devices.vendors()

Lists device vendors available to the authenticated account.

Input

void

optional

vendors() does not take parameters.

Returns

LinxioDeviceVendor[] | null

optional

Vendor records, usually including id, name, and supported models.

Show child fields

LinxioId

optional

Vendor identifier.

string

optional

Vendor display name.

LinxioRecord[]

optional

Device models returned under this vendor.

LinxioError | null

optional

Typed SDK error when vendors 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.

Device vendors

const vendors = await linxio.devices.vendors();

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

Example response


{
  "data": [
    {
      "id": 64553,
      "name": "Example",
      "models": [
        {}
      ]
    }
  ],
  "error": null
}

devices.installation()

GET

Lookup device installation

/devices/installation/linxio.devices.installation(params)

Looks up the current device installation by device IMEI or vehicle registration number. devices.installations(params) remains available as a backwards-compatible alias for this lookup.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

string

optional

Device IMEI to look up.

string

optional

Vehicle registration number to look up.

Returns

LinxioDeviceInstallation | null

optional

Matched installation record, or null when Linxio returns an empty object.

Show child fields

LinxioRecord | null

optional

Device object when supplied.

LinxioId

optional

Device identifier.

LinxioRecord[]

optional

Installation files when supplied.

LinxioId

optional

Installation record identifier.

ISODateString | null

optional

Install timestamp.

number | null

optional

Odometer captured at installation.

ISODateString | null

optional

Uninstall timestamp when supplied.

LinxioRecord | null

optional

Vehicle object when supplied.

LinxioId

optional

Vehicle identifier.

LinxioError | null

optional

Typed SDK error when the lookup 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.

Installation lookup

const installation = await linxio.devices.installation({
  vehicleRegNo: "1ABC234",
});

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

Example response


{
  "data": {
    "device": {},
    "deviceId": 124210,
    "files": [
      {}
    ],
    "id": 64553,
    "installDate": "2026-06-08T12:00:00+08:00",
    "odometer": 123456,
    "uninstallDate": "2026-06-08T12:00:00+08:00",
    "vehicle": {},
    "vehicleId": 64553
  },
  "error": null
}

devices.cameras()

GET

List device cameras

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

Lists cameras attached to a device.

Input

LinxioId

required

Device identifier.

Returns

LinxioDeviceCamera[] | null

optional

Camera records with id, deviceId, name, and status when supplied.

Show child fields

LinxioId

optional

Device identifier.

LinxioId

optional

Camera identifier.

string

optional

Camera display name.

string

optional

Camera status.

LinxioError | null

optional

Typed SDK error when cameras 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.

Device cameras

const cameras = await linxio.devices.cameras(deviceId);

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

Example response


{
  "data": [
    {
      "deviceId": 124210,
      "id": 64553,
      "name": "Example",
      "status": "online"
    }
  ],
  "error": null
}

Devices

List devices

Input

Returns

Load all devices

Input

Returns

Stream devices

Input

Returns

Get a device

Input

Returns

Create a device

Input

Returns

Update a device

Input

Returns

Install a device

Input

Returns

Uninstall a device

Input

Returns

Archive a device

Input

Returns

Restore a device

Input

Returns

List device coordinates

Input

Returns

List device sensors

Input

Returns

List device history

Input

Returns

List device vendors

Input

Returns

Lookup device installation

Input

Returns

List device cameras

Input

Returns

On this page