API Reference

Device Information

Fetches information about the current device connection. Can be used to verify authorization token and returns information useful to present useful information in your user interface.

Headers

x-client-versionstringOptionalDefaults to 0.0.0
Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/

Response

Device information response
_typestring or nullDefaults to project_device
Resource type identifier
idstring or nullformat: "uuid"
asset_typestring or null
The type of asset that this device will be producing
creator_idstring or nullformat: "uuid"
deleted_atstring or nullformat: "date-time"
device_idstring or nullformat: "uuid"
inserted_atstring or nullformat: "date-time"
last_seen_atstring or nullformat: "date-time"
last_known_firmware_versionstring or null
The last known firmware version reported by the device
namestring or null<=255 characters
Name of this device as shown in the iOS app and web app
project_idstring or nullformat: "uuid"
The Project ID that this device is linked to
updated_atstring or null
statusenum or null
Allowed values:
timezonestring or null
authorizationobject or null
Authorization details for a project device
projectobject or null
channelslist of objects or null
channel_countinteger or null<=100
path_asset_typestring or null<=50 characters
path_namestring or null<=50 characters
required_metadata_attributeslist of strings or null

Errors