GET/v1/devicesFind devices

Find devices
parameteroffsetPage offset (default: 0): Number
parametersizeNumber of items on Page (default: 50, max: 100): Number
parameterdeviceIdDevice id search for a specific device: Number
parameterorganizationIdThe organization from which the devices will be taken: Number
parameterorganizationNameThe organization from which the devices will be taken: String
parameterdeviceGroupIdThe group from which the devices will be taken: Number
parametersearchWildcard searching for name, location and remarks and Id: String
parameternameGet a device using a search for name.: String
parameterlocationGet a device using a search for location.: String
parameterremarksGet a device using a search for remarks.: String
parameterdeviceTypeGet a device matching one of the following types: Lock, Keyfob, Gateway: String
parameterincludeGroupsThe connected groups will be returned directly: Boolean
parameterincludeReachableGatewaysThe gateways which are in range of the devices: Boolean
parameterincludeReachableDevicesThe devices which are in range of the gateways: Boolean
parameterincludeDecommissionedDevices who are not available: Boolean
parameterincludeUninstalledDevices who are not installed: Boolean
parametersortBySort by: name, batteryLevel: String
parametersortDirectionSort direction: asc, desc: "Asc" / "Desc"
parameterfilterInstalled,Uninstalled,Decommissioned,Commissioned: [String]
headerAuthorizationAuthentication token (bearer token or API key).

Response

status200All ok
status401Invalid authentication token
status403Insufficient rights
[{
"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 all devices as an Account

GET/v1/devices

headerAuthorizationBearer e5003c62-561b-4e03-a41b-6b6302524550

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": 49,
"name": "Lock1",
"organizationId": 25,
"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-03-10T09:42:20.051466Z",
"dateModified": "2026-03-10T09:42:20.052936Z",
"messageQueueCount": 0,
"decommissioned": false,
"restricted": false,
"relatedDeviceGroups": [],
"reachableGateways": [],
"reachableDevices": []
}
, {
"id": 50,
"name": "Lock2",
"organizationId": 25,
"organizationName": "",
"deviceModel": {
"id": 1,
"deviceType": {
"id": 1,
"name": "Lock",
"description": "Lock"
}
,
"model": "Smart Cylinder SX",
"name": "Smart Cylinder SX"
}
,
"actualFirmwareVersion": 0,
"requiredFirmwareVersion": 0,
"timeZone": "UTC",
"dateCreated": "2026-03-10T09:42:20.052284Z",
"messageQueueCount": 0,
"decommissioned": false,
"restricted": false,
"relatedDeviceGroups": [],
"reachableGateways": [],
"reachableDevices": []
}
]

Example: Get all devices as a System Admin

GET/v1/devices

headerAuthorizationBearer fdd0d95b-f0aa-4c0f-a486-fcb7ee1eb938

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": 53,
"name": "Lock1",
"organizationId": 27,
"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-03-10T09:42:21.033716Z",
"dateModified": "2026-03-10T09:42:21.035111Z",
"messageQueueCount": 0,
"decommissioned": false,
"restricted": false,
"relatedDeviceGroups": [],
"reachableGateways": [],
"reachableDevices": []
}
, {
"id": 55,
"name": "Lock1",
"organizationId": 28,
"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-03-10T09:42:21.041026Z",
"dateModified": "2026-03-10T09:42:21.042259Z",
"messageQueueCount": 0,
"decommissioned": false,
"restricted": false,
"relatedDeviceGroups": [],
"reachableGateways": [],
"reachableDevices": []
}
, {
"id": 54,
"name": "Lock2",
"organizationId": 27,
"organizationName": "",
"deviceModel": {
"id": 1,
"deviceType": {
"id": 1,
"name": "Lock",
"description": "Lock"
}
,
"model": "Smart Cylinder SX",
"name": "Smart Cylinder SX"
}
,
"actualFirmwareVersion": 0,
"requiredFirmwareVersion": 0,
"timeZone": "UTC",
"dateCreated": "2026-03-10T09:42:21.034444Z",
"messageQueueCount": 0,
"decommissioned": false,
"restricted": false,
"relatedDeviceGroups": [],
"reachableGateways": [],
"reachableDevices": []
}
, {
"id": 56,
"name": "Lock2",
"organizationId": 28,
"organizationName": "",
"deviceModel": {
"id": 1,
"deviceType": {
"id": 1,
"name": "Lock",
"description": "Lock"
}
,
"model": "Smart Cylinder SX",
"name": "Smart Cylinder SX"
}
,
"actualFirmwareVersion": 0,
"requiredFirmwareVersion": 0,
"timeZone": "UTC",
"dateCreated": "2026-03-10T09:42:21.041655Z",
"messageQueueCount": 0,
"decommissioned": false,
"restricted": false,
"relatedDeviceGroups": [],
"reachableGateways": [],
"reachableDevices": []
}
]