| parameter | offset | Page offset (default: 0): Number |
| parameter | size | Number of items on Page (default: 50, max: 100): Number |
| parameter | deviceId | Device id search for a specific device: Number |
| parameter | organizationId | The organization from which the devices will be taken: Number |
| parameter | organizationName | The organization from which the devices will be taken: String |
| parameter | deviceGroupId | The group from which the devices will be taken: Number |
| parameter | search | Wildcard searching for name, location and remarks and Id: String |
| parameter | name | Get a device using a search for name.: String |
| parameter | location | Get a device using a search for location.: String |
| parameter | remarks | Get a device using a search for remarks.: String |
| parameter | deviceType | Get a device matching one of the following types: Lock, Keyfob, Gateway: String |
| parameter | includeGroups | The connected groups will be returned directly: Boolean |
| parameter | includeReachableGateways | The gateways which are in range of the devices: Boolean |
| parameter | includeReachableDevices | The devices which are in range of the gateways: Boolean |
| parameter | commissioned | Filter by commission status. true = commissioned only, false = decommissioned only, omit = no filter: Boolean |
| parameter | installed | Filter by install status. true = installed only, false = uninstalled only, omit = no filter: Boolean |
| parameter | includeSync | Include sync status (Recommended or Required) based on pending messages: Boolean |
| parameter | sortBy | Sort by: name, batteryLevel: String |
| parameter | sortDirection | Sort direction: asc, desc: "Asc" / "Desc" |
| header | Authorization | Authentication token (bearer token or API key). |
| status | 200 | All ok |
| status | 401 | Invalid authentication token |
| status | 403 | Insufficient rights |
| [{ "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"), "dateAssigned" : 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 }, "sync" : "Recommended" / "Required", "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 } "assignedLockId" : Number, "assignedKeypadId" : Number }] | ||
| header | Authorization | Bearer a0af2439-08af-4bcc-82ce-ea6a6df0174b |
| status | 200 | |
| header | Access-Control-Expose-Headers | authorization, content-type |
| header | Access-Control-Allow-Headers | authorization, content-type |
| header | Access-Control-Allow-Methods | GET, POST, DELETE, OPTIONS, PUT |
| header | Access-Control-Allow-Origin | * |
| header | Strict-Transport-Security | max-age=31536000; includeSubDomains |
| header | X-Frame-Options | SAMEORIGIN |
| header | X-Content-Type-Options | nosniff |
| header | X-XSS-Protection | 1; mode=block |
| header | Content-Security-Policy | default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none' |
| header | Referrer-Policy | no-referrer |
| header | Feature-Policy | self |
| header | Permissions-policy | interest-cohort=() |
[{ "id": 1, "name": "Lock1", "owner": { "organizationId": 1, "accountId": 1, "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": true, "backupPins": true, "shareAccess": true, "eventLog": true, "turnToActivate": true, "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": true, "showRealUser": false, "walkInMode": false, "controller": false }, "entryTags": [], "actualFirmwareVersion": 0, "requiredFirmwareVersion": 95, "dateCreated": "2026-08-21T15:11:01.987797Z", "dateModified": "2026-08-21T15:11:01.991916Z", "timeZone": "UTC", "locked": "UNKNOWN", "matter": { "manuallyProvisioned": false, "factoryProvisioned": false }, "relatedDeviceGroups": [], "reachableGateways": [], "reachableDevices": [] }, {"id": 2, "name": "Lock2", "owner": { "organizationId": 1, "accountId": 1, "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": true, "backupPins": true, "shareAccess": true, "eventLog": true, "turnToActivate": true, "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": true, "showRealUser": false, "walkInMode": false, "controller": false }, "entryTags": [], "actualFirmwareVersion": 0, "requiredFirmwareVersion": 0, "dateCreated": "2026-08-21T15:11:01.989977Z", "timeZone": "UTC", "locked": "UNKNOWN", "matter": { "manuallyProvisioned": false, "factoryProvisioned": false }, "relatedDeviceGroups": [], "reachableGateways": [], "reachableDevices": [] }] | ||
| header | Authorization | Bearer 99444284-ed32-444f-948e-97b0cc393088 |
| status | 200 | |
| header | Access-Control-Expose-Headers | authorization, content-type |
| header | Access-Control-Allow-Headers | authorization, content-type |
| header | Access-Control-Allow-Methods | GET, POST, DELETE, OPTIONS, PUT |
| header | Access-Control-Allow-Origin | * |
| header | Strict-Transport-Security | max-age=31536000; includeSubDomains |
| header | X-Frame-Options | SAMEORIGIN |
| header | X-Content-Type-Options | nosniff |
| header | X-XSS-Protection | 1; mode=block |
| header | Content-Security-Policy | default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none' |
| header | Referrer-Policy | no-referrer |
| header | Feature-Policy | self |
| header | Permissions-policy | interest-cohort=() |
[{ "id": 1, "name": "Lock1", "owner": { "organizationId": 1, "accountId": 1, "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": true, "backupPins": true, "shareAccess": true, "eventLog": true, "turnToActivate": true, "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": true, "showRealUser": false, "walkInMode": false, "controller": false }, "entryTags": [], "actualFirmwareVersion": 0, "requiredFirmwareVersion": 95, "dateCreated": "2026-08-21T15:11:03.414592Z", "dateModified": "2026-08-21T15:11:03.419078Z", "timeZone": "UTC", "locked": "UNKNOWN", "matter": { "manuallyProvisioned": false, "factoryProvisioned": false }, "relatedDeviceGroups": [], "reachableGateways": [], "reachableDevices": [] }, {"id": 3, "name": "Lock1", "owner": { "organizationId": 2, "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": true, "backupPins": true, "shareAccess": true, "eventLog": true, "turnToActivate": true, "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": true, "showRealUser": false, "walkInMode": false, "controller": false }, "entryTags": [], "actualFirmwareVersion": 95, "requiredFirmwareVersion": 0, "dateCreated": "2026-08-21T15:11:03.461065Z", "dateModified": "2026-08-21T15:11:03.465247Z", "timeZone": "UTC", "locked": "UNKNOWN", "matter": { "manuallyProvisioned": false, "factoryProvisioned": false }, "relatedDeviceGroups": [], "reachableGateways": [], "reachableDevices": [] }, {"id": 2, "name": "Lock2", "owner": { "organizationId": 1, "accountId": 1, "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": true, "backupPins": true, "shareAccess": true, "eventLog": true, "turnToActivate": true, "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": true, "showRealUser": false, "walkInMode": false, "controller": false }, "entryTags": [], "actualFirmwareVersion": 0, "requiredFirmwareVersion": 0, "dateCreated": "2026-08-21T15:11:03.416859Z", "timeZone": "UTC", "locked": "UNKNOWN", "matter": { "manuallyProvisioned": false, "factoryProvisioned": false }, "relatedDeviceGroups": [], "reachableGateways": [], "reachableDevices": [] }, {"id": 4, "name": "Lock2", "owner": { "organizationId": 2, "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": true, "backupPins": true, "shareAccess": true, "eventLog": true, "turnToActivate": true, "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": true, "showRealUser": false, "walkInMode": false, "controller": false }, "entryTags": [], "actualFirmwareVersion": 0, "requiredFirmwareVersion": 0, "dateCreated": "2026-08-21T15:11:03.463275Z", "timeZone": "UTC", "locked": "UNKNOWN", "matter": { "manuallyProvisioned": false, "factoryProvisioned": false }, "relatedDeviceGroups": [], "reachableGateways": [], "reachableDevices": [] }] | ||
| parameter | deviceId | 1 |
| header | Authorization | Bearer 01478d2e-ca10-40f2-a9f4-87bafd67061a |
| status | 200 | |
| header | Access-Control-Expose-Headers | authorization, content-type |
| header | Access-Control-Allow-Headers | authorization, content-type |
| header | Access-Control-Allow-Methods | GET, POST, DELETE, OPTIONS, PUT |
| header | Access-Control-Allow-Origin | * |
| header | Strict-Transport-Security | max-age=31536000; includeSubDomains |
| header | X-Frame-Options | SAMEORIGIN |
| header | X-Content-Type-Options | nosniff |
| header | X-XSS-Protection | 1; mode=block |
| header | Content-Security-Policy | default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none' |
| header | Referrer-Policy | no-referrer |
| header | Feature-Policy | self |
| header | Permissions-policy | interest-cohort=() |
[{ "id": 1, "name": "Lock1", "owner": { "organizationId": 1, "accountId": 1, "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": true, "backupPins": true, "shareAccess": true, "eventLog": true, "turnToActivate": true, "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": true, "showRealUser": false, "walkInMode": false, "controller": false }, "entryTags": [], "actualFirmwareVersion": 0, "requiredFirmwareVersion": 95, "dateCreated": "2026-08-21T15:11:04.839086Z", "dateModified": "2026-08-21T15:11:04.84374Z", "timeZone": "UTC", "locked": "UNKNOWN", "matter": { "manuallyProvisioned": false, "factoryProvisioned": false }, "relatedDeviceGroups": [], "reachableGateways": [], "reachableDevices": [] }] | ||