← Device API

GET/v2/devices/{device-id}Get specific device (v2)

Get specific device in EffectiveDevice format
headerAuthorizationAuthentication token (bearer token or API key).

Response

status200All ok
status401Invalid authentication token
status403Insufficient rights
status404Device not found
{
"id" : Number,
"name" : String,
"owner" : {
"organizationId" : Number,
"accountId" : Number,
"name" : String,
"firstName" : String,
"lastName" : String
},
"model" : {
"id" : Number,
"name" : String,
"type" : {
"id" : Number,
"name" : String,
"description" : String
},
"description" : String
},
"settings" : {
"activationTime" : Number,
"soundVolume" : Number,
"pressButtonActivation" : Boolean,
"controllerFunctionality" : Boolean,
"backupPinsConfigured" : Boolean,
"acknowledged" : 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"),
"backupPin1Name" : String,
"backupPin2Name" : String,
"backupPin3Name" : String,
"dateLastExternalSync" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"relayNormallyOpen" : Boolean,
"vibrationTamperDetection" : Boolean,
"vibrationTamperSensitivity" : Number,
"rotationsTamperDetection" : Boolean,
"buttonActivationTime" : Number,
"pressButtonDeactivation" : Boolean,
"rangeBoost" : Number,
"powerSaveMode" : Boolean,
"turnToBoost" : Boolean,
"lockedStatus" : Boolean,
"turnToActivate" : Boolean,
"tailgaterProtection" : Boolean,
"buttonAutoDisable" : Boolean,
"suppressDeviceEvents" : Boolean,
"unlockDirection" : "AUTO" / "CLOCKWISE" / "COUNTER_CLOCKWISE",
"boldProtocol" : Boolean,
"matterProtocol" : Boolean,
"faultyPinTamperDetection" : Number,
"walkInMode" : Number
},
"features" : {
"activatable" : Boolean,
"rangeBoostMode" : Boolean,
"remoteAccess" : Boolean,
"backupPins" : Boolean,
"shareAccess" : Boolean,
"eventLog" : Boolean,
"turnToActivate" : Boolean,
"tailgaterProtection" : Boolean,
"matter" : Boolean,
"turnToBoost" : Boolean,
"lockedStatus" : Boolean,
"buttonAutoDisable" : Boolean,
"powerSaveMode" : Boolean,
"nightLock" : Boolean,
"leaveAlert" : Boolean,
"tamperDetection" : Boolean,
"webKeys" : Boolean,
"dynamicPins" : Boolean,
"extendedEventLog" : Boolean,
"keepActiveMode" : Boolean,
"showRealUser" : Boolean,
"walkInMode" : Boolean,
"controller" : Boolean
},
"gateway" : {
"id" : 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"),
"name" : String
},
"entryTags" : [String],
"actualFirmwareVersion" : Number,
"requiredFirmwareVersion" : Number,
"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"),
"timeZone" : Timezone (TZDB 2005r, e.g. "UTC"),
"batteryLevel" : String,
"batteryLastMeasurement" : 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,
"remarks" : String,
"location" : String,
"locked" : "LOCKED" / "UNLOCKED" / "UNKNOWN",
"lastLocked" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"matter" : {
"manuallyProvisioned" : Boolean,
"factoryProvisioned" : Boolean
}
}

Example: Get a personal device as an Account

GET/v2/devices/200

headerAuthorizationBearer f60e1bae-f998-45b9-a489-429e51727880

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": 200,
"name": "Lock1",
"owner": {
"organizationId": 99,
"accountId": 136,
"name": ""
},
"model": {
"id": 1,
"name": "SX33",
"type": {
"id": 1,
"name": "Lock",
"description": "Lock"
},
"description": "Smart Cylinder SX"
},
"settings": {
"activationTime": 5,
"soundVolume": 10,
"pressButtonActivation": true,
"controllerFunctionality": false,
"backupPinsConfigured": false,
"acknowledged": true,
"relayNormallyOpen": true,
"vibrationTamperDetection": false,
"vibrationTamperSensitivity": 50,
"rotationsTamperDetection": false,
"buttonActivationTime": 0,
"pressButtonDeactivation": false,
"rangeBoost": 0,
"powerSaveMode": false,
"turnToBoost": false,
"lockedStatus": false,
"turnToActivate": false,
"tailgaterProtection": false,
"buttonAutoDisable": false,
"suppressDeviceEvents": false,
"unlockDirection": "AUTO",
"boldProtocol": true,
"matterProtocol": false,
"faultyPinTamperDetection": 0,
"walkInMode": 0
},
"features": {
"activatable": true,
"rangeBoostMode": false,
"remoteAccess": false,
"backupPins": false,
"shareAccess": false,
"eventLog": false,
"turnToActivate": false,
"tailgaterProtection": false,
"matter": false,
"turnToBoost": false,
"lockedStatus": false,
"buttonAutoDisable": false,
"powerSaveMode": false,
"nightLock": false,
"leaveAlert": false,
"tamperDetection": false,
"webKeys": false,
"dynamicPins": false,
"extendedEventLog": false,
"keepActiveMode": false,
"showRealUser": false,
"walkInMode": false,
"controller": false
},
"entryTags": [],
"actualFirmwareVersion": 0,
"requiredFirmwareVersion": 95,
"dateCreated": "2026-03-10T09:42:54.928415Z",
"dateModified": "2026-03-10T09:42:54.929543Z",
"timeZone": "UTC",
"locked": "UNKNOWN",
"matter": {
"manuallyProvisioned": false,
"factoryProvisioned": false
}
}

Example: Fail to get a business device as an Account

GET/v2/devices/206

headerAuthorizationBearer 0648035b-b903-4362-a757-13422e5bab64

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 206 not found",
"errorMessage": "Device 206 not found"
}

Example: Get a personal device as a System Admin

GET/v2/devices/208

headerAuthorizationBearer 3c145ee8-df80-4ef4-ae5c-595088ee336d

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": 208,
"name": "Lock1",
"owner": {
"organizationId": 103,
"accountId": 142,
"name": ""
},
"model": {
"id": 1,
"name": "SX33",
"type": {
"id": 1,
"name": "Lock",
"description": "Lock"
},
"description": "Smart Cylinder SX"
},
"settings": {
"activationTime": 5,
"soundVolume": 10,
"pressButtonActivation": true,
"controllerFunctionality": false,
"backupPinsConfigured": false,
"acknowledged": true,
"relayNormallyOpen": true,
"vibrationTamperDetection": false,
"vibrationTamperSensitivity": 50,
"rotationsTamperDetection": false,
"buttonActivationTime": 0,
"pressButtonDeactivation": false,
"rangeBoost": 0,
"powerSaveMode": false,
"turnToBoost": false,
"lockedStatus": false,
"turnToActivate": false,
"tailgaterProtection": false,
"buttonAutoDisable": false,
"suppressDeviceEvents": false,
"unlockDirection": "AUTO",
"boldProtocol": true,
"matterProtocol": false,
"faultyPinTamperDetection": 0,
"walkInMode": 0
},
"features": {
"activatable": true,
"rangeBoostMode": false,
"remoteAccess": false,
"backupPins": false,
"shareAccess": false,
"eventLog": false,
"turnToActivate": false,
"tailgaterProtection": false,
"matter": false,
"turnToBoost": false,
"lockedStatus": false,
"buttonAutoDisable": false,
"powerSaveMode": false,
"nightLock": false,
"leaveAlert": false,
"tamperDetection": false,
"webKeys": false,
"dynamicPins": false,
"extendedEventLog": false,
"keepActiveMode": false,
"showRealUser": false,
"walkInMode": false,
"controller": false
},
"entryTags": [],
"actualFirmwareVersion": 0,
"requiredFirmwareVersion": 95,
"dateCreated": "2026-03-10T09:42:56.81166Z",
"dateModified": "2026-03-10T09:42:56.812828Z",
"timeZone": "UTC",
"locked": "UNKNOWN",
"matter": {
"manuallyProvisioned": false,
"factoryProvisioned": false
}
}

Example: Get a business device as a System Admin

GET/v2/devices/214

headerAuthorizationBearer 8a6d7c34-b120-4815-ae4e-f83b5d21a5a3

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": 214,
"name": "Lock1",
"owner": {
"organizationId": 106,
"name": ""
},
"model": {
"id": 1,
"name": "SX33",
"type": {
"id": 1,
"name": "Lock",
"description": "Lock"
},
"description": "Smart Cylinder SX"
},
"settings": {
"activationTime": 5,
"soundVolume": 10,
"pressButtonActivation": true,
"controllerFunctionality": false,
"backupPinsConfigured": false,
"acknowledged": true,
"relayNormallyOpen": true,
"vibrationTamperDetection": false,
"vibrationTamperSensitivity": 50,
"rotationsTamperDetection": false,
"buttonActivationTime": 0,
"pressButtonDeactivation": false,
"rangeBoost": 0,
"powerSaveMode": false,
"turnToBoost": false,
"lockedStatus": false,
"turnToActivate": false,
"tailgaterProtection": false,
"buttonAutoDisable": false,
"suppressDeviceEvents": false,
"unlockDirection": "AUTO",
"boldProtocol": true,
"matterProtocol": false,
"faultyPinTamperDetection": 0,
"walkInMode": 0
},
"features": {
"activatable": true,
"rangeBoostMode": false,
"remoteAccess": false,
"backupPins": false,
"shareAccess": false,
"eventLog": false,
"turnToActivate": false,
"tailgaterProtection": false,
"matter": false,
"turnToBoost": false,
"lockedStatus": false,
"buttonAutoDisable": false,
"powerSaveMode": false,
"nightLock": false,
"leaveAlert": false,
"tamperDetection": false,
"webKeys": false,
"dynamicPins": false,
"extendedEventLog": false,
"keepActiveMode": false,
"showRealUser": false,
"walkInMode": false,
"controller": false
},
"entryTags": [],
"actualFirmwareVersion": 95,
"requiredFirmwareVersion": 0,
"dateCreated": "2026-03-10T09:42:57.762432Z",
"dateModified": "2026-03-10T09:42:57.763669Z",
"timeZone": "UTC",
"locked": "UNKNOWN",
"matter": {
"manuallyProvisioned": false,
"factoryProvisioned": false
}
}