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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

number

optional

Number of records per page.

number

optional

Page number to read.

Default: 1

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.

Response body fields

LinxioDevice[]

optional

Device rows for the current page.

Show child parameters

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.

number

optional

Current page number.

number

optional

Page size.

number

optional

Total matching device count.

Request

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

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

GET `/devices/{deviceId}`

GET

Get a device

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

Returns one device by ID.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Device identifier.

Response body fields

LinxioId

optional

Device identifier.

string

optional

IMEI when supplied.

string

optional

Serial number when supplied.

LinxioId

optional

Installed vehicle ID when supplied.

POST /devices

POST

Create a device

/deviceslinxio.devices.create(payload)

Creates a device record.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request body parameters

string

optional

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.

Response body fields

LinxioId

optional

Created device ID.

Request

curl -X POST https://api.linxio.com/api/devices \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "imei": "123456789012345",
    "serial": "SDK-TEST-001"
  }'

Example response


{
  "id": 64553
}

PATCH `/devices/{deviceId}`

PATCH

Update a device

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

Updates a device record.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

Device identifier.

LinxioDevicePayload

required

Fields to update.

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.

Response body fields

LinxioId

optional

Updated device ID.

Request

curl -X PATCH https://api.linxio.com/api/devices/545 \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "serial": "SDK-TEST-001-UPDATED"
  }'

Example response


{
  "id": 64553
}

POST `/devices/{deviceId}/install`

POST

Install a device

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

Installs a device into a vehicle.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

Device identifier.

LinxioId

required

Vehicle receiving the device.

ISODateString

optional

Installation timestamp.

number

optional

Vehicle odometer at installation time.

Response body fields

LinxioId

optional

Updated device ID.

Request

curl -X POST https://api.linxio.com/api/devices/545/install \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "vehicleId": 304,
    "installedAt": "2026-06-08T12:00:00+08:00",
    "odometer": 123456
  }'

Example response


{
  "id": 64553
}

POST `/devices/{deviceId}/uninstall`

POST

Uninstall a device

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

Removes a device from its current vehicle.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

Device identifier.

ISODateString

optional

Uninstall timestamp.

number

optional

Vehicle odometer at uninstall time.

Response body fields

LinxioId

optional

Updated device ID.

Request

curl -X POST https://api.linxio.com/api/devices/545/uninstall \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "uninstalledAt": "2026-06-08T12:00:00+08:00"
  }'

Example response


{
  "id": 64553
}

PATCH `/devices/{deviceId}/archive`

PATCH

Archive a device

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

Soft-archives a device.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Device identifier.

Response headers

204 or JSON

optional

Successful archive response.

Request

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

Example response


{
  "status": "online"
}

PATCH `/devices/{deviceId}/restore`

PATCH

Restore a device

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

Restores a previously archived device.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Archived device identifier.

Response headers

204 or JSON

optional

Successful restore response.

Request

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

Example response


{
  "status": "online"
}

GET `/devices/{deviceId}/coordinates`

GET

List device coordinates

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

Returns coordinates for a device. The live tenant expects a date range.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Path and query parameters

LinxioId

required

Device identifier.

ISODateString

optional

Start of the coordinate window.

ISODateString

optional

End of the coordinate window.

string

optional

Optional dashboard-derived coordinate filter.

Response body fields

number

optional

Latitude.

number

optional

Longitude.

ISODateString

optional

Timestamp when supplied.

Request

curl "https://api.linxio.com/api/devices/545/coordinates?dateFrom=2026-06-01T00:00:00%2B08:00&dateTo=2026-06-02T00:00:00%2B08:00" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "lat": -31.9523,
  "lng": 115.8613,
  "ts": "2026-06-08T12:00:00+08:00"
}

GET `/devices/{deviceId}/sensors/history`

GET

List device sensors

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

Lists historical sensor rows associated with a device.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Path and query parameters

LinxioId

required

Device identifier.

number

optional

Number of records per page.

number

optional

Page number to read.

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.

Response body fields

LinxioSensor[]

optional

Sensor rows for the current page.

Show child parameters

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.

number

optional

Pagination metadata.

object

optional

Aggregation data when Linxio supplies it.

Request

curl "https://api.linxio.com/api/devices/545/sensors/history?limit=25&page=1" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

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
    }
  ],
  "page": 1,
  "limit": 100,
  "total": 2,
  "aggregations": "string"
}

GET `/devices/{deviceId}/history`

GET

List device history

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

Lists dashboard-derived history entries for a device.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Device identifier.

Response

LinxioRecord[]

optional

History records. Shape can vary by device type.

GET /devices/vendors/

GET

List device vendors

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

Lists device vendors.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

void

optional

No query parameters are required.

Response body fields

LinxioId

optional

Vendor identifier when supplied.

string

optional

Vendor display name.

LinxioDeviceModel[]

optional

Supported vendor models when supplied.

GET /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. The SDK also exposes devices.installations(params) as a backwards-compatible alias for this lookup.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

string

optional

Device IMEI to look up.

string

optional

Vehicle registration number to look up.

Response body fields

LinxioId

optional

Device identifier.

LinxioDevice

optional

Device summary when supplied.

Show child parameters

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.

LinxioId

optional

Vehicle identifier when supplied.

LinxioVehicle

optional

Vehicle summary when supplied.

Show child parameters

LinxioId

required

Vehicle identifier.

LinxioId | null

optional

Owning team identifier.

LinxioRecord | null

optional

Owning team object.

LinxioRecord | null

optional

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

string | null

optional

Vehicle type key.

LinxioId | null

optional

Vehicle type identifier.

string | null

optional

Vehicle type display name.

string | null

optional

Vehicle manufacturer.

string | null

optional

Manufacturer model label returned by Linxio.

string | null

optional

Vehicle model text.

string | null

optional

Registration number or fleet identifier.

string | null

optional

Default display label.

string | null

optional

Vehicle identification number.

ISODateString | null

optional

Vehicle registration date when supplied.

string | null

optional

Registration certificate number when supplied.

number | null

optional

Vehicle model year when supplied.

number | null

optional

Engine power rating when supplied.

number | null

optional

Engine capacity when supplied.

number | null

optional

Accumulated engine-on time.

LinxioId | null

optional

Fuel type identifier.

number | null

optional

Fuel tank capacity.

number | null

optional

Average fuel value returned by Linxio.

string | null

optional

Emission class when supplied.

number | null

optional

CO2 emissions value when supplied.

number | null

optional

Gross vehicle weight when supplied.

LinxioRecord[]

optional

Vehicle group objects with id, name, and color.

LinxioRecord[]

optional

Current area assignments with arrival/departure timestamps.

string | null

optional

Vehicle status, such as online or offline.

LinxioRecord | null

optional

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

LatLng & { ts?: ISODateString } | null

optional

Last known vehicle coordinates.

ISODateString | null

optional

Last telemetry timestamp.

LinxioId | null

optional

Installed device identifier.

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

optional

Current-day telemetry summary when selected.

number | null

optional

Tenant-configured economical speed threshold when supplied.

number | null

optional

Tenant-configured excessive idling threshold when supplied.

number | null

optional

Average daily mileage value returned by Linxio.

ISODateString | null

optional

Vehicle creation timestamp.

LinxioRecord | null

optional

User object for the creator when supplied.

ISODateString | null

optional

Vehicle update timestamp.

LinxioRecord | null

optional

User object for the last updater when supplied.

string | null

optional

Vehicle picture URL when supplied.

string | null

optional

Unavailable reason when supplied.

ISODateString

optional

Installation timestamp when supplied.

ISODateString

optional

Uninstall timestamp when supplied.

number

optional

Vehicle odometer at installation time when supplied.

LinxioFile[]

optional

Installation files when supplied.

Request

curl "https://api.linxio.com/api/devices/installation/?vehicleRegNo=1ABC234" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "deviceId": 124210,
  "device": {
    "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
  },
  "vehicleId": 64553,
  "vehicle": {
    "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
  },
  "installDate": "2026-06-08T12:00:00+08:00",
  "uninstallDate": "2026-06-08T12:00:00+08:00",
  "odometer": 123456,
  "files": [
    "string"
  ]
}

GET `/devices/{deviceId}/cameras`

GET

List device cameras

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

Lists cameras attached to a device.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Device identifier.

Response body fields

LinxioId

optional

Camera identifier when supplied.

LinxioId

optional

Device identifier.

string

optional

Camera display name when supplied.

string

optional

Camera status when supplied.

Request

curl "https://api.linxio.com/api/devices/545/cameras" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "id": 64553,
  "deviceId": 124210,
  "name": "Example",
  "status": "online"
}

GET /sensors

GET

List sensors

/sensorslinxio.sensors.list(params)

Lists sensors visible to the authenticated account.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

number

optional

Number of records per page.

number

optional

Page number to read.

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.

Response body fields

LinxioSensor[]

optional

Sensor rows for the current page.

Show child parameters

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.

number

optional

Pagination metadata.

object

optional

Aggregation data when Linxio supplies it.

Request

curl "https://api.linxio.com/api/sensors?limit=25&page=1" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

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
    }
  ],
  "page": 1,
  "limit": 100,
  "total": 2,
  "aggregations": "string"
}

GET `/sensors/{sensorId}`

GET

Get a sensor

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

Returns one sensor by ID.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Sensor identifier.

Response body fields

LinxioId

optional

Sensor identifier.

LinxioId

optional

Paired device ID when supplied.

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

Sensor identifier.

LinxioId

required

Device identifier sent in the JSON body.

Response body fields

LinxioId

optional

Updated sensor ID.

Request

curl -X POST https://api.linxio.com/api/sensors/123/install \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "deviceId": 545
  }'

Example response


{
  "id": 64553
}

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

ISODateString

optional

Report date range.

ISODateString

optional

Alternative date range names used by some Linxio report flows.

LinxioId

optional

Optional sensor filter.

LinxioId

optional

Optional vehicle filter.

number

optional

Number of records per page.

number

optional

Page number to read.

Response body fields

number

optional

Temperature reading when supplied.

number

optional

Humidity reading when supplied.

ISODateString

optional

Reading timestamp when supplied.

Request

curl "https://api.linxio.com/api/devices/sensors/report/temp-and-humidity?startDate=2026-06-01T00:00:00%2B08:00&endDate=2026-06-08T00:00:00%2B08:00&limit=100" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "temperature": 123,
  "humidity": 123,
  "occurredAt": "2026-06-08T12:00:00+08:00"
}

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

ISODateString

optional

Report date range.

LinxioId

optional

Optional sensor filter.

LinxioId

optional

Optional vehicle filter.

number

optional

Number of records per page.

number

optional

Page number to read.

Response body fields

LinxioId

optional

Vehicle identifier when supplied.

number

optional

Temperature reading when supplied.

number

optional

Humidity reading when supplied.

ISODateString

optional

Reading timestamp when supplied.

Request

curl "https://api.linxio.com/api/vehicles/report/sensors/temp-and-humidity?vehicleId=304&limit=100" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "vehicleId": 64553,
  "temperature": 123,
  "humidity": 123,
  "occurredAt": "2026-06-08T12:00:00+08:00"
}

GET /devices/cameras/events

GET

List camera events

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

Returns a paginated list of camera events.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

number

optional

Number of records per page.

number

optional

Page number to read.

string[]

optional

Optional field projection.

QueryValue

optional

Camera-event filters accepted by Linxio.

Response

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

void

optional

No query parameters are required.

Response

LinxioRecord[]

optional

Camera event type records.