NMnmi
Devices

Get Cloud Device

Retrieve a specific cloud device by its ID.

get/v5/devices/{device_id}

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v5/devices/{device_id}
  • Auth
    API key in header Authorization

Path parameters

device_idstring required

The device ID to retrieve.

Query parameters

include_status'true' | 'false'

If true, include battery and wifi info in the response (default: false)

Response

Success

object'device' required

String representing the object's type. Always 'device' for device objects.

idstring required

Unique identifier for the device

device_nicknamestring nullable

Nickname assigned to the device

makestring nullable

Device manufacturer

modelstring nullable

Device model

serial_numberstring nullable

Device serial number

registration_status'registered' | 'deregistered' required

Current registration status of the device

last_transaction_datestring date-time nullable

Date and time of the last transaction processed on this device

date_registeredstring date-time nullable

Date and time when the device was registered

date_deregisteredstring date-time nullable

Date and time when the device was deregistered

connection_statusboolean nullable

Whether the device is currently connected

last_connected_datestring date-time nullable

Date and time when the device was last connected

last_disconnected_datestring date-time nullable

Date and time when the device was last disconnected

battery_infoobject nullable

Battery information (only included when current_status=true)

wifi_infoobject nullable

WiFi information (only included when current_status=true)

Changes

No recorded changes to this operation across all 1 revision of this API.