← Device Group API

Business clients only

GET/v1/device-groupsGet all device groups

Get all device groups
parameterincludeDevicesThe connected devices will be returned directly: Boolean
parameterorganizationIdThe organization from where the groups will be taken: Number
parametersearchWildcard searching device groups by name, remarks, location, id: String
parametersortBySort by: 'name', 'remarks', 'location', 'id', 'dateCreated', 'dateModified': String
parametersortDirectionSort direction: asc, desc: "Asc" / "Desc"
parameteroffsetPage offset (default: 0): Number
parametersizeNumber of items on Page (default: 50, max: 100): Number
headerAuthorizationAuthentication token (bearer token or API key).

Response

status200All ok
status401Invalid authentication token
status403Insufficient rights
[{
"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"),
"deviceList" : [{
"id" : Number,
"name" : String,
"organizationId" : Number,
"organizationName" : String,
"deviceModel" : {
"id" : Number,
"name" : String,
"type" : {
"id" : Number,
"name" : String,
"description" : String
},
"features" : {
"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
},
"description" : String
},
"firmwareConfiguration" : {
"id" : Number,
"description" : 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,
"locked" : "LOCKED" / "UNLOCKED" / "UNKNOWN",
"lastLocked" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"),
"matter" : {
"provisioningQrCode" : String,
"manuallyProvisioned" : Boolean,
"factoryProvisioned" : Boolean
},
"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 device groups without devices, searching

GET/v1/device-groups

parametersearchoffice
headerAuthorizationBearer f2f4dfc3-6f37-4e27-82da-ed42fb32d608

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,
"organizationId": 29,
"name": "Office 1",
"dateCreated": "2026-03-10T09:32:32.431339Z",
"deviceList": []
}, {
"id": 2,
"organizationId": 29,
"name": "Office 2",
"dateCreated": "2026-03-10T09:32:32.432527Z",
"deviceList": []
}, {
"id": 3,
"organizationId": 29,
"name": "Office 3",
"dateCreated": "2026-03-10T09:32:32.43303Z",
"deviceList": []
}]

Example: Get all device groups without devices

GET/v1/device-groups

parameteroffset0
parametersize4
headerAuthorizationBearer 16fc8381-e886-4096-a99c-e9165c0fa685

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": 4,
"organizationId": 31,
"name": "Office 1",
"dateCreated": "2026-03-10T09:32:33.122796Z",
"deviceList": []
}, {
"id": 5,
"organizationId": 31,
"name": "Office 2",
"dateCreated": "2026-03-10T09:32:33.123389Z",
"deviceList": []
}, {
"id": 6,
"organizationId": 31,
"name": "Office 3",
"dateCreated": "2026-03-10T09:32:33.123864Z",
"deviceList": []
}]

Example: Get all device groups with devices

GET/v1/device-groups

parameteroffset0
parametersize4
parameterincludeDevicestrue
headerAuthorizationBearer fb52ef00-c7ef-4e2f-827d-915c72ec4944

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": 7,
"organizationId": 33,
"name": "Office 1",
"dateCreated": "2026-03-10T09:32:33.858235Z",
"deviceList": []
}, {
"id": 8,
"organizationId": 33,
"name": "Office 2",
"dateCreated": "2026-03-10T09:32:33.858817Z",
"deviceList": [{
"id": 5,
"name": "Front Desk",
"organizationId": 33,
"deviceModel": {
"id": 1,
"name": "SX33",
"type": {
"id": 1,
"name": "Lock",
"description": "Lock"
},
"features": {
"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
},
"description": "Smart Cylinder SX"
},
"firmwareConfiguration": {
"id": 1,
"description": "pcba-sx-rena-1.0"
},
"actualFirmwareVersion": 0,
"requiredFirmwareVersion": 0,
"timeZone": "UTC",
"dateCreated": "2026-03-10T09:32:33.862431Z",
"messageQueueCount": 0,
"decommissioned": false,
"restricted": false,
"locked": "UNKNOWN",
"matter": {
"manuallyProvisioned": false,
"factoryProvisioned": false
},
"relatedDeviceGroups": [],
"reachableGateways": [],
"reachableDevices": []
}]
}, {
"id": 9,
"organizationId": 33,
"name": "Office 3",
"dateCreated": "2026-03-10T09:32:33.859367Z",
"deviceList": [{
"id": 5,
"name": "Front Desk",
"organizationId": 33,
"deviceModel": {
"id": 1,
"name": "SX33",
"type": {
"id": 1,
"name": "Lock",
"description": "Lock"
},
"features": {
"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
},
"description": "Smart Cylinder SX"
},
"firmwareConfiguration": {
"id": 1,
"description": "pcba-sx-rena-1.0"
},
"actualFirmwareVersion": 0,
"requiredFirmwareVersion": 0,
"timeZone": "UTC",
"dateCreated": "2026-03-10T09:32:33.862431Z",
"messageQueueCount": 0,
"decommissioned": false,
"restricted": false,
"locked": "UNKNOWN",
"matter": {
"manuallyProvisioned": false,
"factoryProvisioned": false
},
"relatedDeviceGroups": [],
"reachableGateways": [],
"reachableDevices": []
}]
}]