Getalldevicesforalocation

GET

Get all devices for a location

Return all devices in a particular locationID.

{
    "displayedOutdoorHumidity": 67,
    "vacationHold": {
        "enabled": false
    },
    "currentSchedulePeriod": {
        "day": "Thursday",
        "period": "Away"
    },
    "scheduleCapabilities": {
        "availableScheduleTypes": [
            "None",
            "Geofenced",
            "TimedNorthAmerica"
        ],
        "schedulableFan": false
    },
    "scheduleType": {
        "scheduleType": "Timed",
        "scheduleSubType": "NA"
    },
    "scheduleStatus": "Resume",
    "allowedTimeIncrements": 15,
    "settings": {
        "hardwareSettings": {
            "brightness": 0,
            "maxBrightness": 5
        },
        "fan": {
            "allowedModes": [
                "On",
                "Auto",
                "Circulate"
            ],
            "changeableValues": {
                "mode": "On"
            }
        },
        "temperatureMode": {
            "air": true
        },
        "specialMode": {
            "autoChangeoverActive": false,
            "emergencyHeatActive": false
        }
    },
    "deviceClass": "Thermostat",
    "deviceType": "Thermostat",
    "deviceID": "LCC-00D02DAB5CBE",
    "userDefinedDeviceName": "TSeries",
    "name": "TSeries",
    "isAlive": true,
    "isUpgrading": false,
    "isProvisioned": true,
    "macID": "00D02DAB5CBE",
    "deviceSettings": {},
    "units": "Fahrenheit",
    "indoorTemperature": 73,
    "outdoorTemperature": 46,
    "allowedModes": [
        "EmergencyHeat",
        "Heat",
        "Off",
        "Cool",
        "Auto"
    ],
    "deadband": 0,
    "hasDualSetpointStatus": false,
    "minHeatSetpoint": 50,
    "maxHeatSetpoint": 90,
    "minCoolSetpoint": 50,
    "maxCoolSetpoint": 90,
    "changeableValues": {
        "mode": "Heat",
        "autoChangeoverActive": false,
        "emergencyHeatActive": false,
        "heatSetpoint": 62,
        "coolSetpoint": 85,
        "thermostatSetpointStatus": "NoHold",
        "nextPeriodTime": "18:00:00",
        "endHeatSetpoint": 62,
        "endCoolSetpoint": 85,
        "heatCoolMode": "Heat"
    },
    "operationStatus": {
        "mode": "EquipmentOff",
        "fanRequest": false,
        "circulationFanRequest": false
    }
}
Field Name/Location Data Type Definition
displayedOutdoorHumidity Integer Outdoor humidity reading (from weather data), should be treated as percentage
vacationHold Object
vacationHold.enabled Boolean Is vacation hold enabled?
scheduleCapabilities Object
scheduleCapabilities.availableScheduleTypes Array List of available schedule types
scheduleCapabilities.schedulableFan Boolean Is the fan mode scheduleable?
scheduleType Object
scheduleType.scheduleType String Current schedule type
scheduleType.scheduleSubType String Current schedule sub-type
scheduleStatus String Current status of schedule
allowedTimeIncrements Integer Allowed time increments of the timed schedule (in minutes)
settings Object
settings.hardwareSettings Object
settings.hardwareSettings.brightness Integer Current brightness setting
settings.hardwareSettings.maxBrightness Integer Maximum brightness setting
settings.fan Object
settings.fan.allowedModes Array Array of allowed fan modes
settings.fan.changeableValues Object List of writeable fan settings
settings.temperatureMode Object
settings.temperatureMode.air Boolean
settings.specialMode Object
settings.specialMode.autoChangeoverActive Boolean Will exist if device has this mode enabled, true or false based on running in that mode
settings.specialMode.emergencyHeatActive Boolean Will exist if device has this mode enabled, true or false based on running in that mode
deviceClass String Class of device
deviceType String Type of device
deviceID String Unique ID of device. "LCC-" == T-Series, "TCC-" == Lyric Round
userDefinedDeviceName String User defined name of the device. Shown in the mobile app.
name String Device name
isAlive Boolean true == device online. false == device offline
isProvisioned Boolean Is the device provisioned correctly or not
macID String Unique MACID of the device
deviceSettings Object
units String Units used on device (Celsius or Fahrenheit)
indoorTemperature Integer or Float Current display temperature on device. Whole numbers for F units or .5 increments for C units.
outdoorTemperature Integer or Float Current outdoor temperature based on location data.
allowedModes Array List of allowed modes for the device, also be sure to doublecheck settings.specialMode for Lyric Round.
deadband Integer Required separation between high and low setpoints. Default for Lyric Thermostats is 0.
hasDualSetpointStatus Boolean Indicates whether the thermostat maintains separate heat and cool setpoint status value.
minHeatSetpoint Integer or Float The lower limit for the heating setpoint.
maxHeatSetpoint Integer or Float The upper limit for the heating setpoint.
minCoolSetpoint Integer or Float The lower limit for the heating setpoint.
maxCoolSetpoint Integer or Float The upper limit for the heating setpoint.
changeableValues.mode String Current mode of the thermostat.
changeableValues.autoChangeoverActive Boolean If field is set in the response then the thermostat supports autochangeover to be controlled independent of mode. If field is not set in the response then the thermostat does not support autochangeover.
changeableValues.emergencyHeatActive Boolean Indicates if emergency heating is active. When this field is returned (it is nullable and does not have to be in the response) - it means that the device handles emergency heating independently of the mode. When this field is returned (it is nullable and does not have to be in the response) - device will not accept EmergencyHeat as an allowed value. When emergency heating is active you cannot set thermostat's mode to other value than Off and you cannot change autochangeover.
changeableValues.heatSetpoint Decimal Current heating setpoint.
changeableValues.coolSetpoint Decimal Current cooling setpoint.
changeableValues.thermostatSetpointStatus String Signifies current setpoint state. TemporaryHold, HoldUntil, PermanentHold, VacationHold, NoHold
changeableValues.holdUntil timeSpan Time in 15 minutes intervals (the maximum value is 92 = 11:45 PM), meaning depends on other properties.
changeableValues.nextPeriodTime timeSpan Indicates when next schedule period starts
changeableValues.endHeatSetpoint Decimal The heating setpoint that would occur if the current hold ended now. If there is no hold, or if the thermostat cannot control heating, then this value is not present.
changeableValues.endCoolSetpoint Decimal The cooling setpoint that would occur if the current hold ended now. If there is no hold, or if the thermostat cannot control cooling, then this value is not present.
changeableValues.heatCoolMode String Heat cool mode when system switch is in Auto mode.
operationStatus Object Details around operation status of the equipment.
operationStatus.mode String Current running (relay status) of the equipment.
operationStatus.fanRequest Boolean Current running (relay status) of the fan.
operationStatus.circulationFanRequest Boolean Current running (relay status) of the fan circulate mode.
smartAway Object Settings that will take effect when nobody is home (via Geofencing). Null when reported means smart away is not available.
indoorHumidity Decimal Indoor humidity rating as a percentage, currently only on Lyric Round thermostats
indoorHumidityStatus String Status of humidity sensor. Measured, NotAvailable, or SensorFault.
{
    "firmwareVer": "0.5.16A4",
    "waterPresent": false,
    "currentSensorReadings": {
        "time": "2017-10-19T08:27:42",
        "temperature": 20.39,
        "humidity": 44.8
    },
    "currentAlarms": [],
    "lastCheckin": "2017-10-19T08:27:44",
    "lastDeviceSettingUpdatedOn": "0001-01-01T00:00:00",
    "batteryRemaining": 43,
    "isRegistered": true,
    "hasDeviceCheckedIn": true,
    "isDeviceOffline": false,
    "firstFailedAttemptTime": "0001-01-01T00:00:00",
    "failedConnectionAttempts": 0,
    "wifiSignalStrength": -46,
    "isFirmwareUpdateRequired": false,
    "time": "2017-10-19T08:27:42",
    "deviceClass": "LeakDetector",
    "deviceType": "Water Leak Detector",
    "deviceID": "31aae686-6b4a-476e-8cbc-da4a1cab2cd5",
    "userDefinedDeviceName": "Basement",
    "backend": {
        "id": "31aae686-6b4a-476e-8cbc-da4a1cab2cd5"
    },
    "isAlive": true,
    "isUpgrading": false,
    "isProvisioned": true,
    "deviceSettings": {
        "temp": {
            "high": {
                "limit": 36.5
            },
            "low": {
                "limit": 6.5
            }
        },
        "humidity": {
            "high": {
                "limit": 70
            },
            "low": {
                "limit": 20
            }
        },
        "userDefinedName": "Basement",
        "buzzerMuted": false,
        "checkinPeriod": 8,
        "currentSensorReadPeriod": 60
    }
}
Field Name/Location Data Type Definition
firmwareVer String Current firmware version
waterPresent Boolean True if water has been detected
currentSensorReadings Object
currentSensorReadings.time DateTime Timestamp of last reading
currentSensorReadings.temperature Decimal Last read temperature, always in C units
currentSensorReadings.humidity Percentage Last read humidity, always a percentage
currentAlarms Object Array Array of objects for current alerts
lastCheckin DateTime Timestamp of last check-in
lastDeviceSettingUpdatedOn DateTime Date and time stamp of the last device setting change request
batteryRemaining Integer Battery life remaining as a percentage
isRegistered Boolean True/false if the device is registered
hasDeviceCheckedIn Boolean True/false if the device has checked-in to Honeywell servers.
isDeviceOffline Boolean True/false if the device is offline.
firstFailedAttemptTime DateTime
failedConnectionAttempts Integer
wifiSignalStrength Integer WiFi signal strength in db
isFirmwareUpdateRequired Boolean Does the device require a firmware update
time DateTime
deviceClass String Class of the device. "LeakDetector" for Water Leak Detector.
deviceType String Type of the device. "Water Leak Detector" for Water Leak Detector devices.
deviceID String Unique device ID
userDefinedDeviceName String User defined device name, what is shown in the Lyric App
backend Object
backend.id String Backend device ID
isAlive Boolean Is the device online or not.
isUpgrading Boolean Is the device currently running a firmware update?
isProvisioned Boolean Is the device provisioned correctly?
deviceSettings.temp Object Temperature limit settings for alerts
deviceSettings.temp.high Object
deviceSettings.temp.high.limit Decimal The device reading this temp will cause a high temperature alert. Always in C units.
deviceSettings.temp.low Object
deviceSettings.temp.low.limit Decimal The device reading this temp will cause a low temperature alert. Always in C units.
deviceSettings.humidity Object Temperature limit settings for alerts
deviceSettings.humidity.high Object
deviceSettings.humidity.high.limit Percentage The device reading this humidity will cause a high humidity alert.
deviceSettings.humidity.low Object
deviceSettings.humidity.low.limit Percentage The device reading this humidity will cause a low humidity alert.
deviceSettings.humidity Object Humidity limit settings for alerts
deviceSettings.userDefinedName String User defined device name
deviceSettings.buzzerMuted Boolean Buzzer muted true/false
deviceSettings.checkinPeriod Integer User set device check-in/reporting period for periodic readings
deviceSettings.currentSensorReadPeriod Integer Sensor reading period
{
    "model": "C2",
    "manufacturer": "Edimax",
    "serial": "1726ZA300023",
    "maxResolution": "1920x1080",
    "firmwareVer": "v1.26_20171017",
    "wifiStrength": "54",
    "deviceClass": "Camera",
    "deviceType": "C2",
    "deviceID": "c7a4c930-ef20-48ee-b8a4-74e4b4152ef8",
    "userDefinedDeviceName": "Camera",
    "isAlive": true,
    "isUpgrading": false,
    "isProvisioned": true,
    "macID": "74DA38D20850"
}
Field Name/Location Data Type Definition
model String Camera model
manufacturer String Camera manufacturer
serial String Camera serial number
maxResolution String Max display resoultion of the camera (WxH)
firmwareVer String Current firmware version
wifiStrength Integer Wifi signal strength
deviceClass String Class of device. "Camera" for cameras
deviceType String Type of camera (C1, C2, etc)
deviceID String Unique Device ID
userDefinedDeviceName String User defined device name. Shown in the Lyric App.
isAlive Boolean Is the device online or not?
isUpgrading Boolean Is the device currently performing a firmware update?
isProvisioned Boolean Is the device provisioned correctly?
macID Unique MACID of the device
        {
            "deviceDetails": {
                "configurations": {
                    "model": "DAS",
                    "firmwareVersion": "HDAS_GL.1.2.006.0091",
                    "commApiVersion": "1.0.0.1",
                    "mac": "B82CA0032222",
                    "serialNumber": "0x956D1AC8\n",
                    "wifiInfo": {
                        "name": "HCH_A1"
                    },
                    "firmwareUpgradeInfo": {
                        "lastSuccessfulUpgradeTime": "2018-10-03T12:29:26.3828809Z",
                        "lastUpgradeStartTime": "2018-10-03T12:25:15.3624593Z",
                        "expectedUpgradeCompletionTime": "2018-10-03T12:33:15.3624593Z"
                    },
                    "primaryZWaveController": {
                        "id": "1",
                        "name": "SUC/SIS Controller",
                        "configurations": {
                            "version": "C07,0500 (4.61)",
                            "homeId": "c533d2be",
                            "type": "SucSis",
                            "nodeId": "1",
                            "nodeDescription": "SUC/SIS Controller",
                            "automationDeviceType": "Output",
                            "automationDeviceSubType": "Controller",
                            "manufacturerName": "Honeywell ",
                            "manufacturerId": "Controller",
                            "productId": "1",
                            "productType": "8",
                            "routerCapability": false,
                            "associationState": false,
                            "deviceSecurity": true,
                            "specificType": 10,
                            "securityMode": "Wep"
                        },
                        "state": {
                            "value": 0,
                            "isConnected": true,
                            "inReplaceMode": false
                        }
                    },
                    "voiceCommands": [
                        {
                            "voiceEngine": "Alexa",
                            "enabled": true
                        }
                    ]
                },
                "state": {
                    "isACLoss": false,
                    "batteryState": {
                        "isLow": false,
                        "level": 100
                    },
                    "isTampered": false,
                    "isOnline": true,
                    "discoveryMode": "Disable",
                    "lastCommunicationStatusChange": "2019-04-03T20:15:55.3498069Z",
                    "isSyncInProgress": false,
                    "isUpgradeInProgress": false,
                    "alexaConnectionState": "Disconnect",
                    "isMandatoryFirmwareUpgradeRequired": false
                },
                "partitions": [
                    {
                        "id": "1",
                        "name": "Lyric Home",
                        "configurations": {
                            "canRestartTimer": false,
                            "entryDelay": 15,
                            "exitDelay": 15,
                            "enableDeterrence": false,
                            "setStateConfigs": [
                                {
                                    "setState": "Disarm",
                                    "enableAlarm": false,
                                    "enableCamera": false,
                                    "chimeVolume": 22,
                                    "enableDeterrence": false,
                                    "enableOsmv": false
                                },
                                {
                                    "setState": "ArmAway",
                                    "enableAlarm": true,
                                    "enableCamera": true,
                                    "chimeVolume": 22,
                                    "enableDeterrence": false,
                                    "enableOsmv": true
                                },
                                {
                                    "setState": "ArmStay",
                                    "enableAlarm": true,
                                    "enableCamera": false,
                                    "chimeVolume": 22,
                                    "enableDeterrence": false,
                                    "enableOsmv": true
                                }
                            ],
                            "deterrenceActions": {
                                "chimes": [
                                    "DogBark"
                                ]
                            }
                        },
                        "state": {
                            "setState": "Disarm",
                            "inEntryDelay": false,
                            "inExitDelay": false,
                            "alarmState": "None",
                            "isTrouble": false,
                            "isFault": true,
                            "isBypassed": false,
                            "lastUpdatedTime": "2019-04-17T17:40:26.8661883Z",
                            "silentModeEnabled": true,
                            "lastSetStateUpdatedTime": "2019-04-17T17:40:26.8661883Z"
                        }
                    }
                ],
                "sensors": [
                    {
                        "id": "3",
                        "name": "Living Room Window",
                        "configurations": {
                            "firmwareVersion": "06155A35",
                            "serialNumber": "306184470:1",
                            "bridgeId": "3",
                            "sensitivity": 0,
                            "chime": "Standard",
                            "isEnabled": true,
                            "sensorCommType": "Unknown",
                            "responseType": "Perimeter",
                            "sensorType": "Input",
                            "sensorSubType": "Contact"
                        },
                        "state": {
                            "isAlarm": false,
                            "isBypassed": false,
                            "isFault": true,
                            "isTrouble": false,
                            "isTampered": false,
                            "supervisionFailed": false,
                            "isEnrolled": true,
                            "isConnected": true,
                            "signalStrength": 0,
                            "batteryState": {
                                "isLow": false,
                                "level": 0
                            },
                            "activeTests": [],
                            "isVerified": false
                        }
                    },
                    {
                        "id": "2",
                        "name": "Front Door",
                        "configurations": {
                            "firmwareVersion": "06155A35",
                            "serialNumber": "306184545:1",
                            "bridgeId": "2",
                            "sensitivity": 0,
                            "chime": "Standard",
                            "isEnabled": true,
                            "sensorCommType": "Unknown",
                            "responseType": "EntryExit",
                            "sensorType": "Input",
                            "sensorSubType": "Contact"
                        },
                        "state": {
                            "isAlarm": false,
                            "isBypassed": false,
                            "isFault": true,
                            "isTrouble": false,
                            "isTampered": false,
                            "supervisionFailed": false,
                            "isEnrolled": true,
                            "isConnected": true,
                            "signalStrength": 0,
                            "batteryState": {
                                "isLow": false,
                                "level": 0
                            },
                            "activeTests": [],
                            "isVerified": false
                        }
                    },
                    {
                        "id": "4",
                        "name": "Front Porch",
                        "configurations": {
                            "firmwareVersion": "09215B13",
                            "serialNumber": "1128923551:1",
                            "bridgeId": "4",
                            "sensitivity": 0,
                            "chime": "Standard",
                            "isEnabled": true,
                            "sensorCommType": "Unknown",
                            "responseType": "NoResponse",
                            "sensorType": "Pir",
                            "sensorSubType": "Osmv"
                        },
                        "state": {
                            "isAlarm": false,
                            "isBypassed": false,
                            "isFault": false,
                            "isTrouble": false,
                            "isTampered": false,
                            "supervisionFailed": false,
                            "isEnrolled": true,
                            "isConnected": true,
                            "signalStrength": 0,
                            "batteryState": {
                                "isLow": false,
                                "level": 0
                            },
                            "activeTests": [],
                            "isVerified": false
                        }
                    }
                ],
                "keyFobs": [
                    {
                        "id": "131",
                        "name": "Fob1",
                        "partitionId": "1",
                        "configurations": {
                            "serialNumber": "306708788:0",
                            "size": 0,
                            "firmwareVersion": "07155A4B"
                        },
                        "state": {
                            "keyCommandMapping": [
                                {
                                    "keyIndex": 131,
                                    "commandIndex": 21
                                },
                                {
                                    "keyIndex": 132,
                                    "commandIndex": 22
                                },
                                {
                                    "keyIndex": 133,
                                    "commandIndex": 20
                                },
                                {
                                    "keyIndex": 134,
                                    "commandIndex": 7
                                }
                            ],
                            "isEnrolled": true,
                            "batteryState": {
                                "isLow": false,
                                "level": 60
                            },
                            "signalStrength": 0
                        }
                    }
                ],
                "automationDevices": {
                    "switches": [
                        {
                            "configurations": {
                                "switchType": "Dimmer",
                                "switchSubType": "Default",
                                "nodeId": "2",
                                "nodeDescription": "Switch 001",
                                "automationDeviceType": "Output",
                                "automationDeviceSubType": "Switch Multilevel",
                                "manufacturerName": "Honeywell Multi Mode Comm., 5044, 3033",
                                "manufacturerId": "Switch Multilevel",
                                "productId": "3033",
                                "productType": "5044",
                                "routerCapability": false,
                                "associationState": false,
                                "deviceSecurity": false,
                                "specificType": 2,
                                "securityMode": "Open"
                            },
                            "state": {
                                "lastCommunicationStatusChangeTime": "2019-02-26T22:17:03.9144634Z",
                                "value": 0,
                                "isConnected": false,
                                "inReplaceMode": false
                            },
                            "id": "AD_1",
                            "name": "Outlet"
                        },
                        {
                            "configurations": {
                                "switchType": "Toggle",
                                "switchSubType": "Default",
                                "nodeId": "3",
                                "nodeDescription": "Switch 002",
                                "automationDeviceType": "Output",
                                "automationDeviceSubType": "Switch Binary",
                                "manufacturerName": "Jasco Products Multi Mode Comm., 5052, 3039",
                                "manufacturerId": "Switch Binary",
                                "productId": "3039",
                                "productType": "5052",
                                "routerCapability": false,
                                "associationState": false,
                                "deviceSecurity": false,
                                "specificType": 1,
                                "securityMode": "Open"
                            },
                            "state": {
                                "lastCommunicationStatusChangeTime": "2019-03-06T20:08:16.0600441Z",
                                "value": 1,
                                "isConnected": false,
                                "inReplaceMode": false
                            },
                            "id": "AD_2",
                            "name": "Printer"
                        },
                        {
                            "configurations": {
                                "switchType": "Dimmer",
                                "switchSubType": "Default",
                                "nodeId": "4",
                                "nodeDescription": "Switch 003",
                                "automationDeviceType": "Output",
                                "automationDeviceSubType": "Switch Multilevel",
                                "manufacturerName": "Jasco Products Multi Mode Comm., 4C42, 3031",
                                "manufacturerId": "Switch Multilevel",
                                "productId": "3031",
                                "productType": "4c42",
                                "routerCapability": false,
                                "associationState": false,
                                "deviceSecurity": false,
                                "specificType": 2,
                                "securityMode": "Open"
                            },
                            "state": {
                                "lastCommunicationStatusChangeTime": "2019-04-01T19:59:15.518994Z",
                                "value": 99,
                                "isConnected": true,
                                "inReplaceMode": false
                            },
                            "id": "AD_3",
                            "name": "Lamp"
                        }
                    ]
                },
                "onboardDevices": [
                    {
                        "deviceClass": "Camera",
                        "deviceType": "BuiltIn",
                        "deviceID": "21034",
                        "maxResolution": "1920x1080",
                        "manufacturer": "Honeywell Technology Solutions Pvt Ltd",
                        "model": "HONDASCP100",
                        "serial": "111122223333",
                        "firmwareVer": "90",
                        "macID": "B8:2C:A0:03:22:22",
                        "userDefinedDeviceName": "Living Room",
                        "isAlive": true,
                        "isUpgrading": false,
                        "isProvisioned": true,
                        "wifiStrength": "",
                        "backend": "EMX",
                        "peopleDetectionState": "None"
                    }
                ]
            },
            "geoFence": "off",
            "frConfiguration": {
                "maxPersons": 2,
                "plan": "Free"
            },
            "deviceClass": "DeviceGateway",
            "deviceType": "HONDAS",
            "deviceID": "LSC-B82CA0032222",
            "userDefinedDeviceName": "Security",
            "name": "Security",
            "isAlive": true,
            "isProvisioned": true,
            "macID": "B82CA0032222",
            "deviceSettings": {},
            "service": {
                "mode": "Up"
            }
        }
    
Field Name/Location Data Type Definition
deviceDetails Object Object with collection of device details
deviceDetails.configurations Object Configuration object
deviceDetails.configurations.model String Device Model, should be "DAS"
deviceDetails.configurations.firmwareVersion String Current firmware version
deviceDetails.configurations.mac String MacID
deviceDetails.configurations.wifiInfo.name String Current Wifi SSID used
deviceDetails.configurations.voiceCommands Array Array of voice assistant configurations
deviceDetails.configurations.voiceCommands.voiceEngine String Name of voice engine
deviceDetails.configurations.voiceCommands.enabled Boolean Is the assistant enabled
deviceDetails.state Object Base station state object
deviceDetails.state.isACLoss Boolean Is device plugged in? False means device is using AC power
deviceDetails.state.batteryState Object Battery state info
deviceDetails.state.batteryState.isLow Boolean Is battery level low?
deviceDetails.state.batteryState.level Integer Battery level, in percentage
deviceDetails.state.isTampered Boolean Is the device tamper detection activated?
deviceDetails.state.isOnline Boolean Is the device online?
deviceDetails.state.discoveryMode String Is the device currently in Z-Wave discovery mode?
deviceDetails.state.lasCommunicationStateChange DateTime Last time the isOnline state changed in UTC
deviceDetails.state.isSyncInProgress Boolean Is device sync in progress?
deviceDetails.state.isUpgradeInProgress Boolean Is the device firmware currently being updated?
deviceDetails.state.alexaConnectionState String Is Alexa connected or not?
deviceDetails.partitions Array Array of partitions configured
deviceDetails.partitions.id String ID of partition, used when arming and disarming
deviceDetails.partitions.name String Name of partition
deviceDetails.partitions.configurations Object Partition configuration info
deviceDetails.partitions.configurations.canRestartTimer Boolean Can the exit timer be restarted?
deviceDetails.partitions.configurations.entryDelay Integer Number of seconds after entry before alarm is triggered
deviceDetails.partitions.configurations.exitDelay Integer Number of seconds after arming user has to exit
deviceDetails.partitions.configurations.setStateConfigs Array Array of possible arming modes
deviceDetails.partitions.configurations.setStateConfigs.setState String Setting state: "Disarm", "ArmAway", "ArmStay"
deviceDetails.partitions.configurations.setStateConfigs.enableAlarm Boolean Does this setting enable the alarm?
deviceDetails.partitions.configurations.setStateConfigs.enableCamera Boolean Does this setting enable the camera?
deviceDetails.partitions.configurations.setStateConfigs.chimeVolume Integer Level of chime volume when changing to this config
deviceDetails.partitions.configurations.state Object Arming state information
deviceDetails.partitions.configurations.state.setState String Current arming mode
deviceDetails.partitions.configurations.state.inEntryDelay Boolean Is device in entry delay?
deviceDetails.partitions.configurations.state.inExitDelay Boolean Is device in exit delay?
deviceDetails.partitions.configurations.state.alarmState String Current alarm state
deviceDetails.partitions.configurations.state.isTrouble Boolean Is there a tamper alert
deviceDetails.partitions.configurations.state.isBypassed Boolean Are sensors bypassed?
deviceDetails.partitions.configurations.state.lastUpdatedTime DateTime Last time the state was updated. In UTC.
deviceDetails.partitions.configurations.state.silentModeEnabled Boolean Is silent mode enabled?
deviceDetails.partitions.configurations.state.lastSetStateUpdatedTime DateTime Last set state change
deviceDetails.sensors Array Array of sensor information attached to base station
deviceDetails.sensors.id String ID of sensor
deviceDetails.sensors.name String Name of sensor (usually indicates location)
deviceDetails.sensors.configurations Object Sensor configuration information
deviceDetails.sensors.configurations.firmwareVersion String Sensor firmware version
deviceDetails.sensors.configurations.serialNumber String Sensor serial number
deviceDetails.sensors.configurations.bridgeId String Bridge ID
deviceDetails.sensors.configurations.sensitivity Number Sensitivity level
deviceDetails.sensors.configurations.chime String Chime configuration for sensor trigger
deviceDetails.sensors.configurations.isEnabled Boolean Is the sensor enabled?
deviceDetails.sensors.configurations.responseType String When will the sensor trigger an alert or chime
deviceDetails.sensors.configurations.sensorType String Sensor Type
deviceDetails.sensors.configurations.sensorSubType String Sensor Sub Type
deviceDetails.sensors.state Object Sensor state information
deviceDetails.sensors.state.isAlarm Boolean Is the sensor in alarm state
deviceDetails.sensors.state.isBypassed Boolean Is the sensor bypassed?
deviceDetails.sensors.state.isTrouble Boolean Has the sensor trouble alarm been tripped?
deviceDetails.sensors.state.isTampered Boolean Has the sensor tamper alarm been tripped?
deviceDetails.sensors.state.isEnrolled Boolean Is the sensor enrolled?
deviceDetails.sensors.state.isConnected Boolean Is the sensor connected?
deviceDetails.sensors.state.signalStrength Integer Current signal strength (if available)
deviceDetails.sensors.state.batteryState Object Battery state information
deviceDetails.keyFobs Array Data related to any KeyFobs connected
deviceDetails.keyFobs Array Data related to any KeyFobs connected
deviceDetails.keyFobs.id String ID of KeyFob
deviceDetails.keyFobs.name String Name of keyfob
deviceDetails.keyFobs.partitionId String Partition ID that KeyFob uses
deviceDetails.keyFobs.configurations Object KeyFob configuration information
deviceDetails.keyFobs.configurations.serialNumber String Serial number of KeyFob
deviceDetails.keyFobs.configurations.size String Size of KeyFob
deviceDetails.keyFobs.configurations.firmwareVersion String Firmware Version of KeyFob
deviceDetails.keyFobs.state Object State of KeyFob
deviceDetails.keyFobs.state.keyCommandMapping Array Array of objects pertaining to key command mapping
deviceDetails.keyFobs.state.isEnrolled Boolean Device is enrolled
deviceDetails.keyFobs.state.batteryState Object Battery state information
deviceDetails.keyFobs.state.batteryState.isLow Boolean Is the battery level low?
deviceDetails.keyFobs.state.batterystate.level Float Battery level (in percentage)
deviceDetails.automationDevices Object Automation devices information
deviceDetails.automationDevices.switches Array Information on switches connected to base station
deviceDetails.automationDevices.switches.configurations Object Switch configuration information
deviceDetails.automationDevices.switches.configurations.switchType String Switch type
deviceDetails.automationDevices.switches.configurations.switchSubType String Switch subtype
deviceDetails.automationDevices.switches.configurations.nodeId String Node ID
deviceDetails.automationDevices.switches.configurations.nodeDescription String Node description
deviceDetails.automationDevices.switches.configurations.automationDeviceType String Automation Device Type (e.g., "Output)
deviceDetails.automationDevices.switches.configurations.automationDeviceSubType String Device subtype (e.g., Switch Multilevel)
deviceDetails.automationDevices.switches.configurations.manufacturerName String
deviceDetails.automationDevices.switches.configurations.manufacturerId String
deviceDetails.automationDevices.switches.configurations.productId String
deviceDetails.automationDevices.switches.configurations.productType String
deviceDetails.automationDevices.switches.configurations.routerCapability Boolean
deviceDetails.automationDevices.switches.configurations.associationState Boolean
deviceDetails.automationDevices.switches.configurations.deviceSecurity Boolean
deviceDetails.automationDevices.switches.configurations.specificType Integer
deviceDetails.automationDevices.switches.configurations.securityMode String
deviceDetails.automationDevices.switches.state Object State information
deviceDetails.automationDevices.switches.state.lastCommunicationStatusChangeTime DateTime Timestamp in UTC of last communication state change
deviceDetails.automationDevices.switches.state.value Integer
deviceDetails.automationDevices.switches.state.isConnected Boolean Is the device connected?
deviceDetails.automationDevices.switches.state.inReplaceMode Boolean Is the device in replace mode?
deviceDetails.automationDevices.switches.id String Internal switch ID
deviceDetails.automationDevices.switches.name String User facing device name
deviceDetails.automationDevices.discoveredAutomationDevices Array Array of discovered automation devices
deviceDetails.automationDevices.discoveredAutomationDevices.id String Internal id of device
deviceDetails.automationDevices.discoveredAutomationDevices.nodeId String Node ID of device
deviceDetails.automationDevices.discoveredAutomationDevices.name String Name of device
deviceDetails.automationDevices.discoveredAutomationDevices.configurations Object Object of device configuration information
deviceDetails.automationDevices.discoveredAutomationDevices.configurations.commType String Communication type of device
deviceDetails.automationDevices.discoveredAutomationDevices.configurations.type String Device type
deviceDetails.automationDevices.discoveredAutomationDevices.state Object State information for device
deviceDetails.automationDevices.discoveredAutomationDevices.id String Internal id of device
deviceDetails.onboardDevices.deviceClass String Onboard device class
deviceDetails.onboardDevices.deviceType String Onboard device type
deviceDetails.onboardDevices.deviceID String Onboard device ID, used when calling livestream/status API
deviceDetails.onboardDevices.maxResolution String Device video resolution
deviceDetails.onboardDevices.manufacturer String Onboard device manufacturer
deviceDetails.onboardDevices.model String Device model
deviceDetails.onboardDevices.serial String Onboard device serial number
deviceDetails.onboardDevices.firmwareVer String Onboard device firmware version
deviceDetails.onboardDevices.macID String Onboard device MACID
deviceDetails.onboardDevices.userDefinedDeviceName String User defined device name
deviceDetails.onboardDevices.isAlive Boolean Is device online?
deviceDetails.onboardDevices.isUpgrading Boolean Is device updating?
deviceDetails.onboardDevices.isProvisioned Boolean Is device provisioning?
deviceDetails.onboardDevices.wifiStrength String Wifi signal strength
geoFence Boolean Is device using geofencing?
deviceClass String Class of base device
deviceType String Device Type
deviceID String Unique ID of device
userDefinedDeviceName String User device device name
name String Device name
isAlive Boolean Is device alive?
isProvisioned Boolean Is device provisioned?
macID String Unique device MACID
deviceSettings Object Device settings listing

Resource URL

https://api.honeywell.com/v2 /devices

Query Parameters


Name Values Description
apikey
(required)

Your API Key.

locationId
(required)

LocationID that belongs to the currently logged in user


Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Resource Summary

Security

Category

Thermostat, Water Leak Detector

Working...