← Device Group API

Business clients only

GET/v1/device-groups/{id}Get a specific device group

Get a specific device group
parameterincludeDevicesThe connected devices will be returned directly: Boolean
headerAuthorizationAuthentication token (bearer token or API key).

Response

status200All ok
status401Invalid authentication token
status403Insufficient rights
status404Device group not found
{
"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: Returns a device group with a specific id without devices

GET/v1/device-groups/10

headerAuthorizationBearer b0f3723e-d5ed-4c8f-82a7-4963a4846ffc

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": 10,
"organizationId": 35,
"name": "Office 1",
"dateCreated": "2026-03-10T09:32:34.623889Z",
"deviceList": []
}

Example: Returns a device group with a specific id with devices

GET/v1/device-groups/13

parameterincludeDevicestrue
headerAuthorizationBearer ea27dd03-ace1-4bb8-a09e-e0fe4f0ad22c

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": 13,
"organizationId": 37,
"name": "Office 1",
"dateCreated": "2026-03-10T09:32:35.327423Z",
"deviceList": []
}