← Device API

GET/v1/devices/{device-id}Get specific device

Get specific device
parameterincludeReachableGatewaysThe gateways which are in range of the device: Boolean
parameterincludeReachableDevicesThe devices which are in range of the gateway: Boolean
headerAuthorizationAuthentication token (bearer token or API key).

Response

status200All ok
status401Invalid authentication token
status403Insufficient rights
status404Device not found
{
"id" : Number,
"name" : String,
"organizationId" : Number,
"organizationName" : String,
"deviceModel" : {
"id" : Number,
"deviceType" : {
"id" : Number,
"name" : String,
"description" : String
},
"model" : String,
"name" : String
},
"actualFirmwareVersion" : Number,
"requiredFirmwareVersion" : Number,
"timeZone" : Timezone (TZDB 2005r, e.g. "UTC"),
"batchKey" : String, UUID 4 formatted (e.g. "a426e157-8a5c-456a-8865-bec6394867ab"),
"batteryLevel" : String,
"batteryLevelReminder" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"batteryLastMeasurement" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"remarks" : String,
"location" : String,
"dateCreated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateModified" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateAssigned" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"gatewayId" : Number,
"gatewayRssi" : Number,
"gatewayRssiLevel" : "Excellent" / "High" / "Medium" / "Low" / "Critical",
"gatewayLastSeen" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"gatewayLastSeenMessage" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"messageQueueCount" : Number,
"sequenceNumberDeviceEvents" : Number,
"decommissioned" : Boolean,
"restricted" : Boolean,
"restrictedReminder" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"minCommandStart" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateLastExternalSync" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"isActiveUntil" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"carouselImageUrl" : String,
"dateLastKeyExchange" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateLastKnownActivation" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"lastTimeSyncDate" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"lastTimeSyncDrift" : Number,
"relatedDeviceGroups" : [{
"id" : Number,
"organizationId" : Number,
"name" : String,
"remarks" : String,
"location" : String,
"dateCreated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateModified" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00")
}],
"reachableGateways" : [{
"id" : Number,
"deviceId" : Number,
"gatewayId" : Number,
"rssi" : Number,
"rssiLevel" : "Excellent" / "High" / "Medium" / "Low" / "Critical",
"lastSeen" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"flags" : {
"timeSyncNeeded" : Boolean,
"installationMode" : Boolean,
"eventsAvailable" : Boolean
},
"dateCreated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateModified" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"deviceName" : String,
"deviceOrganizationId" : Number,
"deviceModel" : {
"id" : Number,
"deviceType" : {
"id" : Number,
"name" : String,
"description" : String
},
"model" : String,
"name" : String
}
}],
"reachableDevices" : [{
"id" : Number,
"deviceId" : Number,
"gatewayId" : Number,
"rssi" : Number,
"rssiLevel" : "Excellent" / "High" / "Medium" / "Low" / "Critical",
"lastSeen" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"flags" : {
"timeSyncNeeded" : Boolean,
"installationMode" : Boolean,
"eventsAvailable" : Boolean
},
"dateCreated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"dateModified" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"deviceName" : String,
"deviceOrganizationId" : Number,
"deviceModel" : {
"id" : Number,
"deviceType" : {
"id" : Number,
"name" : String,
"description" : String
},
"model" : String,
"name" : String
}
}]
}

Example: Get a personal device as an Account

GET/v1/devices/1

headerAuthorizationBearer fc4696d4-4ad2-4efb-b154-a98904a93128

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"id": 1,
"name": "Lock1",
"organizationId": 1,
"organizationName": "",
"deviceModel": {
"id": 1,
"deviceType": {
"id": 1,
"name": "Lock",
"description": "Lock"
},
"model": "Smart Cylinder SX",
"name": "Smart Cylinder SX"
},
"actualFirmwareVersion": 0,
"requiredFirmwareVersion": 95,
"timeZone": "UTC",
"dateCreated": "2026-08-21T15:10:19.416245Z",
"dateModified": "2026-08-21T15:10:19.423315Z",
"messageQueueCount": 0,
"decommissioned": false,
"restricted": false,
"relatedDeviceGroups": [],
"reachableGateways": [],
"reachableDevices": []
}

Example: Fail to get a business device as an Account

GET/v1/devices/3

headerAuthorizationBearer aedcd26b-31dc-46c2-a487-1bf85bb049c6

Response

status404
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"message": "Device 3 not found",
"errorMessage": "Device 3 not found"
}

Example: Get a personal device as a System Admin

GET/v1/devices/1

headerAuthorizationBearer 150d731e-f024-405d-b1ad-ed9ac1433082

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"id": 1,
"name": "Lock1",
"organizationId": 1,
"organizationName": "",
"deviceModel": {
"id": 1,
"deviceType": {
"id": 1,
"name": "Lock",
"description": "Lock"
},
"model": "Smart Cylinder SX",
"name": "Smart Cylinder SX"
},
"actualFirmwareVersion": 0,
"requiredFirmwareVersion": 95,
"timeZone": "UTC",
"dateCreated": "2026-08-21T15:10:22.23167Z",
"dateModified": "2026-08-21T15:10:22.23714Z",
"messageQueueCount": 0,
"decommissioned": false,
"restricted": false,
"relatedDeviceGroups": [],
"reachableGateways": [],
"reachableDevices": []
}

Example: Get a business device as a System Admin

GET/v1/devices/3

headerAuthorizationBearer db561b50-d302-4297-9db7-de6ea1931593

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"id": 3,
"name": "Lock1",
"organizationId": 2,
"organizationName": "",
"deviceModel": {
"id": 1,
"deviceType": {
"id": 1,
"name": "Lock",
"description": "Lock"
},
"model": "Smart Cylinder SX",
"name": "Smart Cylinder SX"
},
"actualFirmwareVersion": 95,
"requiredFirmwareVersion": 0,
"timeZone": "UTC",
"dateCreated": "2026-08-21T15:10:23.658176Z",
"dateModified": "2026-08-21T15:10:23.663615Z",
"messageQueueCount": 0,
"decommissioned": false,
"restricted": false,
"relatedDeviceGroups": [],
"reachableGateways": [],
"reachableDevices": []
}