Skip to main content
GET
Get device

Authorizations

x-api-key
string
header
required

Path Parameters

sn
string
required

Device serial number

Response

Successful response

Device record

deviceKind
required

Physical hardware device

Allowed value: "physical"
serialNumber
string
required
alias
string | null
required

Server-set alias, primary display for UI purposes

description
string | null
required

Optional description

name
string | null
required

Name synchronised with device. Displayed as fallback if alias is not set

orgUuid
string<uuid>
required

Organisation the device belongs to

legacyDeviceId
integer | null
required

Legacy device id for backwards compatibility

Required range: -9007199254740991 <= x <= 9007199254740991
location
object | null
required

Device location in WGS84 coordinates

samplingPeriodSeconds
number | null
required

Current sampling period in seconds

txPeriodSeconds
number | null
required

Current transmission period in seconds

state
required

Device is undergoing internal hardware testing and validation

Allowed value: "testing"
health
object
required

Health of the device

lastTxTimestamp
string<date-time> | null
required

Last received transmission timestamp

product
string | null
required

Product name for physical devices

hardware
object | null
required

Hardware details for physical devices

modems
object[]
required

Modems attached to the device. Some device models may support two modems (LTE + satellite)

firmware
object | null
required

Firmware information

tags
object[]
required

Tags associated with the device

site
object | null

Site the device is assigned to, if any

sensors
SensorItem · object[]

If requested via includeSensors, the sensors attached to the device

queuedCommand
object | null

If a command is currently queued or processing for this device, a summary of the command

gnss
object | null

For devices with GNSS support, the GNSS processing configuration

sharedBy
SharedBy · object | null

Present when this device is shared from another organisation