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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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
_typestringOptionalDefaults to project_device
Resource type identifier
idstringOptionalformat: "uuid"
asset_typestringOptional
The type of asset that this device will be producing
creator_idstringOptionalformat: "uuid"
deleted_atstringOptionalformat: "date-time"
device_idstringOptionalformat: "uuid"
inserted_atstringOptionalformat: "date-time"
last_seen_atstringOptionalformat: "date-time"
last_known_firmware_versionstringOptional
The last known firmware version reported by the device
namestringOptional<=255 characters
Name of this device as shown in the iOS app and web app
project_idstringOptionalformat: "uuid"
The Project ID that this device is linked to
updated_atstringOptional
statusenumOptional
timezonestringOptional
authorizationobjectOptional
Authorization details for a project device
projectobjectOptional
channelslist of objectsOptional
channel_countintegerOptional<=100
path_asset_typestringOptional<=50 characters
path_namestringOptional<=50 characters
required_metadata_attributeslist of stringsOptional

Errors

401
Unauthorized Error