GetallLocations

GET

Get all Locations

Get all locations, this will also return all devices within those locations

For specific device data structures, please see Get Device By Type and ID.

    [
    {
        "locationID": 559589,
        "name": "Home",
        "country": "US",
        "zipcode": "55422",
        "devices": [
            {
                "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"
                }
            },
            {
                "firmwareVersion": "1.1.0.0",
                "displayedOutdoorHumidity": 39,
                "vacationHold": {
                    "vacationStart": "2019-04-25T19:05:48",
                    "vacationEnd": "2019-04-26T19:05:48",
                    "heatSetpoint": 70,
                    "coolSetpoint": 72,
                    "enabled": true
                },
                "currentSchedulePeriod": {
                    "day": "Monday",
                    "period": "Away"
                },
                "scheduleCapabilities": {
                    "availableScheduleTypes": [
                        "None",
                        "Geofenced",
                        "TimedNorthAmerica"
                    ],
                    "schedulableFan": false
                },
                "scheduleType": {
                    "scheduleType": "Timed",
                    "scheduleSubType": "NA"
                },
                "scheduleStatus": "Resume",
                "allowedTimeIncrements": 15,
                "settings": {
                    "hardwareSettings": {
                        "brightness": 2,
                        "maxBrightness": 10
                    },
                    "fan": {
                        "allowedModes": [
                            "On",
                            "Auto"
                        ],
                        "changeableValues": {
                            "mode": "Auto"
                        },
                        "allowedSpeeds": [
                            {
                                "item": "Low",
                                "value": {
                                    "speed": 1,
                                    "mode": "On"
                                }
                            },
                            {
                                "item": "Medium",
                                "value": {
                                    "speed": 2,
                                    "mode": "On"
                                }
                            },
                            {
                                "item": "High",
                                "value": {
                                    "speed": 3,
                                    "mode": "On"
                                }
                            },
                            {
                                "item": "Auto",
                                "value": {
                                    "speed": null,
                                    "mode": "Auto"
                                }
                            }
                        ]
                    },
                    "temperatureMode": {
                        "air": true
                    },
                    "specialMode": {}
                },
                "deviceClass": "Thermostat",
                "deviceType": "Thermostat",
                "deviceID": "LCC-B82CA00245E5",
                "userDefinedDeviceName": "D6",
                "name": "D6",
                "isAlive": true,
                "isUpgrading": false,
                "isProvisioned": true,
                "macID": "B82CA00245E5",
                "deviceSettings": {},
                "parentDeviceId": 1,
                "partnerInfo": {
                    "singleOrMultiODUConfiguration": 1,
                    "parentDeviceModelId": 1,
                    "parentDeviceBrandId": 1,
                    "oduName": "Outdoor Unit 1"
                },
                "service": {
                    "mode": "Up"
                },
                "deviceRegistrationDate": "2018-05-30T19:57:05.2866667",
                "units": "Fahrenheit",
                "indoorTemperature": 76,
                "outdoorTemperature": 68.7,
                "allowedModes": [
                    "Heat",
                    "Off",
                    "Cool"
                ],
                "deadband": 0,
                "hasDualSetpointStatus": false,
                "minHeatSetpoint": 61,
                "maxHeatSetpoint": 88,
                "minCoolSetpoint": 61,
                "maxCoolSetpoint": 88,
                "changeableValues": {
                    "mode": "Off",
                    "heatSetpoint": 62,
                    "coolSetpoint": 85,
                    "thermostatSetpointStatus": "NoHold",
                    "nextPeriodTime": "18:00:00",
                    "endHeatSetpoint": 62,
                    "endCoolSetpoint": 85,
                    "heatCoolMode": "Heat"
                },
                "operationStatus": {
                    "mode": "EquipmentOff",
                    "fanRequest": false,
                    "circulationFanRequest": false
                },
                "indoorHumidity": 32,
                "indoorHumidityStatus": "Measured",
                "deviceModel": "D6"
            },
            {
                "waterPresent": false,
                "currentSensorReadings": {
                    "time": "2019-04-24T13:59:02",
                    "temperature": 21.55,
                    "humidity": 30.5
                },
                "currentAlarms": [],
                "lastCheckin": "2019-04-24T13:59:03",
                "lastDeviceSettingUpdatedOn": "0001-01-01T00:00:00",
                "batteryRemaining": 50,
                "isRegistered": true,
                "hasDeviceCheckedIn": true,
                "isDeviceOffline": false,
                "firstFailedAttemptTime": "0001-01-01T00:00:00",
                "failedConnectionAttempts": 0,
                "wifiSignalStrength": -29,
                "time": "2019-04-24T13:59:02",
                "deviceClass": "LeakDetector",
                "deviceType": "Water Leak Detector",
                "deviceID": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
                "userDefinedDeviceName": "Basement",
                "backend": {},
                "isAlive": true,
                "isUpgrading": false,
                "isProvisioned": true,
                "deviceSettings": {
                    "temp": {
                        "high": {
                            "limit": 26.5
                        },
                        "low": {
                            "limit": 15.5
                        }
                    },
                    "humidity": {
                        "high": {
                            "limit": 85
                        },
                        "low": {
                            "limit": 20
                        }
                    },
                    "userDefinedName": "Basement",
                    "buzzerMuted": false,
                    "checkinPeriod": 8,
                    "currentSensorReadPeriod": 60
                },
                "service": {
                    "mode": "Up"
                },
                "deviceRegistrationDate": "2018-06-19T19:02:40.73"
            },
            {
                "firmwareVersion": "1.0.6.0",
                "displayedOutdoorHumidity": 39,
                "vacationHold": {
                    "vacationStart": "2019-04-25T08:05:36",
                    "vacationEnd": "2019-04-26T08:05:36",
                    "heatSetpoint": 70,
                    "coolSetpoint": 72,
                    "enabled": true
                },
                "currentSchedulePeriod": {
                    "day": "Monday",
                    "period": "Away"
                },
                "scheduleCapabilities": {
                    "availableScheduleTypes": [
                        "None",
                        "Geofenced",
                        "TimedNorthAmerica"
                    ],
                    "schedulableFan": false
                },
                "scheduleType": {
                    "scheduleType": "Timed",
                    "scheduleSubType": "NA"
                },
                "scheduleStatus": "Resume",
                "allowedTimeIncrements": 15,
                "settings": {
                    "hardwareSettings": {
                        "brightness": 10,
                        "maxBrightness": 10
                    },
                    "fan": {
                        "allowedModes": [
                            "On",
                            "Auto"
                        ],
                        "changeableValues": {
                            "mode": "Auto"
                        },
                        "allowedSpeeds": [
                            {
                                "item": "Low",
                                "value": {
                                    "speed": 1,
                                    "mode": "On"
                                }
                            },
                            {
                                "item": "Medium",
                                "value": {
                                    "speed": 2,
                                    "mode": "On"
                                }
                            },
                            {
                                "item": "High",
                                "value": {
                                    "speed": 3,
                                    "mode": "On"
                                }
                            },
                            {
                                "item": "Auto",
                                "value": {
                                    "speed": null,
                                    "mode": "Auto"
                                }
                            }
                        ]
                    },
                    "temperatureMode": {
                        "air": true
                    },
                    "specialMode": {}
                },
                "deviceClass": "Thermostat",
                "deviceType": "Thermostat",
                "deviceID": "LCC-B82CA00BD3D9",
                "userDefinedDeviceName": "D62",
                "name": "D62",
                "isAlive": true,
                "isUpgrading": false,
                "isProvisioned": true,
                "macID": "B82CA00BD3D9",
                "deviceSettings": {},
                "parentDeviceId": 1,
                "partnerInfo": {
                    "singleOrMultiODUConfiguration": 1,
                    "parentDeviceModelId": 1,
                    "parentDeviceBrandId": 1
                },
                "service": {
                    "mode": "Up"
                },
                "deviceRegistrationDate": "2019-02-19T20:32:39.4166667",
                "units": "Fahrenheit",
                "indoorTemperature": 74,
                "outdoorTemperature": 68.7,
                "allowedModes": [
                    "Heat",
                    "Off",
                    "Cool"
                ],
                "deadband": 0,
                "hasDualSetpointStatus": false,
                "minHeatSetpoint": 61,
                "maxHeatSetpoint": 88,
                "minCoolSetpoint": 61,
                "maxCoolSetpoint": 88,
                "changeableValues": {
                    "mode": "Off",
                    "heatSetpoint": 62,
                    "coolSetpoint": 85,
                    "thermostatSetpointStatus": "NoHold",
                    "nextPeriodTime": "18:00:00",
                    "endHeatSetpoint": 62,
                    "endCoolSetpoint": 85,
                    "heatCoolMode": "Heat"
                },
                "operationStatus": {
                    "mode": "EquipmentOff",
                    "fanRequest": false,
                    "circulationFanRequest": false
                },
                "indoorHumidity": 32,
                "indoorHumidityStatus": "Measured",
                "deviceModel": "D6"
            },
            {
                "groups": [
                    {
                        "id": 0,
                        "name": "default",
                        "rooms": [
                            0,
                            1,
                            2,
                            3
                        ]
                    }
                ],
                "displayedOutdoorHumidity": 51,
                "vacationHold": {
                    "enabled": false
                },
                "currentSchedulePeriod": {
                    "day": "Wednesday",
                    "period": "Away"
                },
                "scheduleCapabilities": {
                    "availableScheduleTypes": [
                        "None",
                        "Geofenced",
                        "TimedNorthAmerica"
                    ],
                    "schedulableFan": true
                },
                "scheduleType": {
                    "scheduleType": "Timed",
                    "scheduleSubType": "NA"
                },
                "scheduleStatus": "Resume",
                "allowedTimeIncrements": 15,
                "settings": {
                    "hardwareSettings": {
                        "brightness": 0,
                        "maxBrightness": 0
                    },
                    "fan": {
                        "allowedModes": [
                            "On",
                            "Auto",
                            "Circulate"
                        ],
                        "changeableValues": {
                            "mode": "Auto"
                        }
                    },
                    "temperatureMode": {
                        "air": true
                    },
                    "specialMode": {
                        "autoChangeoverActive": false
                    }
                },
                "deviceClass": "Thermostat",
                "deviceType": "Thermostat",
                "deviceID": "LCC-B82CA0196B73",
                "userDefinedDeviceName": "Living Room",
                "name": "Living Room",
                "isAlive": false,
                "isUpgrading": false,
                "isProvisioned": true,
                "macID": "B82CA0196B73",
                "deviceSettings": {},
                "priorityType": "PickARoom",
                "service": {
                    "mode": "Up"
                },
                "deviceRegistrationDate": "2019-03-21T20:14:34.6833333",
                "units": "Fahrenheit",
                "indoorTemperature": 73,
                "outdoorTemperature": 45.5,
                "allowedModes": [
                    "Heat",
                    "Off",
                    "Cool",
                    "Auto"
                ],
                "deadband": 0,
                "hasDualSetpointStatus": false,
                "minHeatSetpoint": 50,
                "maxHeatSetpoint": 90,
                "minCoolSetpoint": 50,
                "maxCoolSetpoint": 90,
                "changeableValues": {
                    "mode": "Heat",
                    "autoChangeoverActive": false,
                    "heatSetpoint": 62,
                    "coolSetpoint": 85,
                    "thermostatSetpointStatus": "NoHold",
                    "nextPeriodTime": "18:00:00",
                    "heatCoolMode": "Heat"
                },
                "operationStatus": {
                    "mode": "EquipmentOff",
                    "fanRequest": false,
                    "circulationFanRequest": false
                },
                "indoorHumidity": 21,
                "indoorHumidityStatus": "Measured",
                "deviceModel": "T9-T10"
            },
            {
                "displayedOutdoorHumidity": 39,
                "vacationHold": {
                    "enabled": false
                },
                "currentSchedulePeriod": {
                    "day": "Monday",
                    "period": "Away"
                },
                "scheduleCapabilities": {
                    "availableScheduleTypes": [
                        "None",
                        "Geofenced",
                        "TimedNorthAmerica"
                    ],
                    "schedulableFan": false
                },
                "scheduleType": {
                    "scheduleType": "Timed",
                    "scheduleSubType": "NA"
                },
                "scheduleStatus": "Pause",
                "allowedTimeIncrements": 15,
                "settings": {
                    "hardwareSettings": {
                        "brightness": 0,
                        "maxBrightness": 5
                    },
                    "fan": {
                        "allowedModes": [
                            "On",
                            "Auto",
                            "Circulate"
                        ],
                        "changeableValues": {
                            "mode": "On"
                        }
                    },
                    "temperatureMode": {
                        "air": true
                    },
                    "specialMode": {
                        "autoChangeoverActive": false
                    }
                },
                "deviceClass": "Thermostat",
                "deviceType": "Thermostat",
                "deviceID": "LCC-00D02DBBB86A",
                "userDefinedDeviceName": "T61",
                "name": "T61",
                "isAlive": true,
                "isUpgrading": false,
                "isProvisioned": true,
                "macID": "00D02DBBB86A",
                "deviceSettings": {},
                "service": {
                    "mode": "Up"
                },
                "deviceRegistrationDate": "2019-03-22T16:37:31.24",
                "units": "Fahrenheit",
                "indoorTemperature": 76,
                "outdoorTemperature": 68.7,
                "allowedModes": [
                    "Heat",
                    "Off",
                    "Cool",
                    "Auto"
                ],
                "deadband": 0,
                "hasDualSetpointStatus": false,
                "minHeatSetpoint": 50,
                "maxHeatSetpoint": 90,
                "minCoolSetpoint": 50,
                "maxCoolSetpoint": 90,
                "changeableValues": {
                    "mode": "Heat",
                    "autoChangeoverActive": false,
                    "heatSetpoint": 62,
                    "coolSetpoint": 85,
                    "thermostatSetpointStatus": "PermanentHold",
                    "heatCoolMode": "Heat"
                },
                "operationStatus": {
                    "mode": "EquipmentOff",
                    "fanRequest": false,
                    "circulationFanRequest": false
                },
                "deviceModel": "T5-T6"
            },
            {
                "displayedOutdoorHumidity": 39,
                "vacationHold": {
                    "enabled": false
                },
                "currentSchedulePeriod": {
                    "day": "Monday",
                    "period": "Home"
                },
                "scheduleCapabilities": {
                    "availableScheduleTypes": [
                        "None",
                        "Geofenced",
                        "TimedNorthAmerica"
                    ],
                    "schedulableFan": false
                },
                "scheduleType": {
                    "scheduleType": "None"
                },
                "scheduleStatus": "Pause",
                "allowedTimeIncrements": 15,
                "settings": {
                    "hardwareSettings": {
                        "brightness": 5,
                        "maxBrightness": 5
                    },
                    "fan": {
                        "allowedModes": [
                            "On",
                            "Auto",
                            "Circulate"
                        ],
                        "changeableValues": {
                            "mode": "On"
                        }
                    },
                    "temperatureMode": {
                        "air": false
                    },
                    "specialMode": {
                        "autoChangeoverActive": false
                    }
                },
                "deviceClass": "Thermostat",
                "deviceType": "Thermostat",
                "deviceID": "LCC-00D02DAC6E81",
                "userDefinedDeviceName": "T5",
                "name": "T5",
                "isAlive": true,
                "isUpgrading": false,
                "isProvisioned": true,
                "macID": "00D02DAC6E81",
                "deviceSettings": {},
                "service": {
                    "mode": "Up"
                },
                "deviceRegistrationDate": "2019-03-22T16:45:40.9933333",
                "units": "Fahrenheit",
                "indoorTemperature": 76,
                "outdoorTemperature": 68.7,
                "allowedModes": [
                    "Heat",
                    "Off",
                    "Cool",
                    "Auto"
                ],
                "deadband": 0,
                "hasDualSetpointStatus": false,
                "minHeatSetpoint": 50,
                "maxHeatSetpoint": 90,
                "minCoolSetpoint": 50,
                "maxCoolSetpoint": 90,
                "changeableValues": {
                    "mode": "Heat",
                    "autoChangeoverActive": false,
                    "heatSetpoint": 68,
                    "coolSetpoint": 85,
                    "thermostatSetpointStatus": "NoHold",
                    "heatCoolMode": "Heat"
                },
                "operationStatus": {
                    "mode": "EquipmentOff",
                    "fanRequest": false,
                    "circulationFanRequest": false
                },
                "deviceModel": "T5-T6"
            },
            {
                "displayedOutdoorHumidity": 94,
                "vacationHold": {
                    "enabled": false
                },
                "currentSchedulePeriod": {
                    "day": "Monday",
                    "period": "Away"
                },
                "scheduleCapabilities": {
                    "availableScheduleTypes": [
                        "None",
                        "Geofenced",
                        "TimedNorthAmerica"
                    ],
                    "schedulableFan": false
                },
                "scheduleType": {
                    "scheduleType": "Timed",
                    "scheduleSubType": "NA"
                },
                "scheduleStatus": "Pause",
                "allowedTimeIncrements": 15,
                "settings": {
                    "hardwareSettings": {
                        "brightness": 0,
                        "maxBrightness": 5
                    },
                    "ventilationModeSettings": {
                        "changeableValues": "Auto",
                        "ventilationTimer": 0,
                        "ventilationCoreTimer": 0,
                        "ventilationSpeed": 0,
                        "ventilationFanRequested": false
                    },
                    "fan": {
                        "allowedModes": [
                            "On",
                            "Auto",
                            "Circulate"
                        ],
                        "changeableValues": {
                            "mode": "Auto"
                        }
                    },
                    "temperatureMode": {
                        "air": true
                    },
                    "specialMode": {}
                },
                "deviceClass": "Thermostat",
                "deviceType": "Thermostat",
                "deviceID": "LCC-00D02DAB5C8E",
                "userDefinedDeviceName": "Pro",
                "name": "Pro",
                "isAlive": false,
                "isUpgrading": false,
                "isProvisioned": true,
                "macID": "00D02DAB5C8E",
                "deviceSettings": {},
                "service": {
                    "mode": "Up"
                },
                "deviceRegistrationDate": "2019-03-22T16:59:54.3933333",
                "units": "Fahrenheit",
                "indoorTemperature": 73,
                "outdoorTemperature": 45,
                "allowedModes": [
                    "Heat",
                    "Off",
                    "Cool"
                ],
                "deadband": 0,
                "hasDualSetpointStatus": false,
                "minHeatSetpoint": 50,
                "maxHeatSetpoint": 90,
                "minCoolSetpoint": 50,
                "maxCoolSetpoint": 90,
                "changeableValues": {
                    "mode": "Cool",
                    "heatSetpoint": 72,
                    "coolSetpoint": 75,
                    "thermostatSetpointStatus": "PermanentHold",
                    "heatCoolMode": "Cool"
                },
                "operationStatus": {
                    "mode": "EquipmentOff",
                    "fanRequest": false,
                    "circulationFanRequest": false
                },
                "deviceModel": "T5-T6"
            },
            {
                "thermostatVersion": "02.02.20.00",
                "scheduleStatus": "Resume",
                "allowedTimeIncrements": 15,
                "settings": {
                    "homeSetPoints": {
                        "homeHeatSP": 70,
                        "homeCoolSP": 78,
                        "units": "Fahrenheit"
                    },
                    "awaySetPoints": {
                        "awayHeatSP": 62,
                        "awayCoolSP": 85,
                        "smartCoolSP": 80,
                        "smartHeatSP": 55,
                        "useAutoSmart": true,
                        "units": "Fahrenheit"
                    },
                    "hardwareSettings": {
                        "brightness": 6,
                        "volume": 10,
                        "maxBrightness": 10,
                        "maxVolume": 10
                    },
                    "fan": {
                        "allowedModes": [
                            "Auto",
                            "On",
                            "Circulate"
                        ],
                        "changeableValues": {
                            "mode": "Circulate"
                        },
                        "fanRunning": false
                    },
                    "temperatureMode": {
                        "feelsLike": false,
                        "air": false
                    },
                    "specialMode": {
                        "autoChangeoverActive": false,
                        "emergencyHeatActive": true
                    }
                },
                "deviceClass": "Thermostat",
                "deviceType": "Thermostat",
                "deviceID": "TCC-1882318",
                "userDefinedDeviceName": "Round",
                "name": "Round",
                "schedule": {
                    "scheduleType": "Geofence"
                },
                "isAlive": false,
                "isUpgrading": false,
                "isProvisioned": false,
                "macID": "00D02D7F0959",
                "deviceSettings": {},
                "service": {
                    "mode": "Up"
                },
                "deviceRegistrationDate": "2019-03-25T16:55:37.76",
                "units": "Fahrenheit",
                "indoorTemperature": 73,
                "outdoorTemperature": 58,
                "allowedModes": [
                    "Cool",
                    "Heat",
                    "Off",
                    "Auto"
                ],
                "deadband": 0,
                "hasDualSetpointStatus": false,
                "minHeatSetpoint": 40,
                "maxHeatSetpoint": 99,
                "minCoolSetpoint": 40,
                "maxCoolSetpoint": 99,
                "changeableValues": {
                    "mode": "Heat",
                    "autoChangeoverActive": false,
                    "emergencyHeatActive": true,
                    "heatSetpoint": 70,
                    "coolSetpoint": 78,
                    "heatCoolMode": "Heat"
                },
                "operationStatus": {
                    "mode": "EquipmentOff"
                },
                "smartAway": {
                    "active": false,
                    "timeOfDay": "00:00:00",
                    "durationInHours": 0,
                    "durationInDays": 0,
                    "lastUsedFormat": "TimeOfDay",
                    "endsIn": "2000-01-01T00:00:00-06:00"
                },
                "indoorHumidity": 32,
                "indoorHumidityStatus": "Measured",
                "deviceModel": "Round"
            }
        ],
        "users": [
            {
                "userID": 625115,
                "username": "hwhome.test.1@gmail.com",
                "firstname": "hw",
                "lastname": "test",
                "created": 1516641186,
                "deleted": -62135596800,
                "activated": true,
                "connectedHomeAccountExists": true,
                "locationRoleMapping": [
                    {
                        "locationID": 559589,
                        "role": "Adult",
                        "locationName": "Home",
                        "status": 1
                    }
                ],
                "isOptOut": "",
                "isCurrentUser": true
            },
            {
                "userID": 81447,
                "username": "hw.alexa.1@gmail.com",
                "firstname": "Hw",
                "lastname": "Alexa",
                "created": 1466524834,
                "deleted": -62135596800,
                "activated": true,
                "connectedHomeAccountExists": true,
                "locationRoleMapping": [
                    {
                        "locationID": 559589,
                        "role": "Adult",
                        "locationName": "hw_Home",
                        "status": 1
                    }
                ],
                "isOptOut": "",
                "isCurrentUser": false
            },
            {
                "userID": 87020,
                "username": "honeywellapisupport@honeywell.com",
                "firstname": "Honeywell",
                "lastname": "ApiSupport",
                "created": 1469546366,
                "deleted": -62135596800,
                "activated": true,
                "connectedHomeAccountExists": true,
                "locationRoleMapping": [
                    {
                        "locationID": 559589,
                        "role": "Adult",
                        "locationName": "hw_Home",
                        "status": 1
                    }
                ],
                "isOptOut": "",
                "isCurrentUser": false
            }
        ],
        "timeZoneId": "Central",
        "timeZone": "Central Standard Time",
        "ianaTimeZone": "America/Chicago",
        "daylightSavingTimeEnabled": true,
        "geoFences": [
            {
                "geofenceEnabled": true,
                "geoFenceID": 566868,
                "latitude": 45.0006638,
                "longitude": -93.36234,
                "radius": 500,
                "geoOccupancy": {
                    "withinFence": 0,
                    "outsideFence": 1
                }
            }
        ],
        "geoFenceEnabled": true,
        "predictiveAIREnabled": false,
        "comfortLevel": 0,
        "geoFenceNotificationEnabled": true,
        "geoFenceNotificationTypeId": 13,
        "configuration": {
            "faceRecognition": {
                "enabled": true,
                "maxPersons": 2,
                "maxEtas": 2,
                "maxEtaPersons": 1,
                "schedules": [
                    {
                        "time": [
                            {
                                "start": "15:00:00",
                                "end": "17:00:00"
                            }
                        ],
                        "days": [
                            "Sunday",
                            "Monday",
                            "Tuesday",
                            "Wednesday",
                            "Thursday",
                            "Friday",
                            "Saturday"
                        ]
                    }
                ]
            }
        }
    },
    {
        "locationID": 559598,
        "name": "UK",
        "country": "GB",
        "zipcode": "KT12 5PY",
        "devices": [
            {
                "displayedOutdoorHumidity": 87,
                "vacationHold": {
                    "enabled": false
                },
                "currentSchedulePeriod": {
                    "day": "Wednesday",
                    "period": "P4"
                },
                "scheduleCapabilities": {
                    "availableScheduleTypes": [
                        "None",
                        "Geofenced",
                        "TimedEmea"
                    ],
                    "schedulableFan": false
                },
                "scheduleType": {
                    "scheduleType": "Timed",
                    "scheduleSubType": "EMEA"
                },
                "dhwZone": {
                    "deviceId": "LCC-DHW-00D02DE7ED4E",
                    "deviceClass": "DHW",
                    "deviceType": "DHW",
                    "dhw": {
                        "dhwState": "Off",
                        "status": "NoHold",
                        "boostDuration": 0,
                        "vacationHold": {
                            "enabled": true
                        },
                        "geoBoostEnabled": false,
                        "nextPeriodTime": "00:00:00"
                    },
                    "currentSchedulePeriod": {
                        "day": "Wednesday",
                        "period": "P6"
                    }
                },
                "scheduleStatus": "Resume",
                "allowedTimeIncrements": 10,
                "settings": {
                    "hardwareSettings": {
                        "brightness": 4,
                        "maxBrightness": 5
                    },
                    "temperatureMode": {
                        "air": false
                    },
                    "specialMode": {}
                },
                "deviceClass": "Thermostat",
                "deviceType": "Thermostat",
                "deviceID": "LCC-00D02DE7ED4E",
                "userDefinedDeviceName": "DHW",
                "name": "DHW",
                "isAlive": false,
                "isUpgrading": false,
                "isProvisioned": true,
                "macID": "00D02DE7ED4E",
                "deviceSettings": {},
                "service": {
                    "mode": "Up"
                },
                "deviceRegistrationDate": "2018-11-13T20:02:10.88",
                "units": "Celsius",
                "indoorTemperature": 23,
                "outdoorTemperature": 4,
                "allowedModes": [
                    "Heat",
                    "Off"
                ],
                "deadband": 0,
                "hasDualSetpointStatus": false,
                "minHeatSetpoint": 5,
                "maxHeatSetpoint": 35,
                "minCoolSetpoint": -18,
                "maxCoolSetpoint": -18,
                "changeableValues": {
                    "mode": "Heat",
                    "heatSetpoint": 16,
                    "coolSetpoint": 10,
                    "thermostatSetpointStatus": "NoHold",
                    "heatCoolMode": "Heat",
                    "endHeatSetpoint": null,
                    "endCoolSetpoint": null
                },
                "operationStatus": {
                    "mode": "EquipmentOff",
                    "fanRequest": false,
                    "circulationFanRequest": false
                },
                "deviceModel": "T5-T6"
            }
        ],
        "users": [
            {
                "userID": 625115,
                "username": "hwhome.test.1@gmail.com",
                "firstname": "hw",
                "lastname": "test",
                "created": 1516641186,
                "deleted": -62135596800,
                "activated": true,
                "connectedHomeAccountExists": true,
                "locationRoleMapping": [
                    {
                        "locationID": 559598,
                        "role": "Adult",
                        "locationName": "UK",
                        "status": 1
                    }
                ],
                "isOptOut": "",
                "isCurrentUser": true
            }
        ],
        "timeZone": "GMT Standard Time",
        "ianaTimeZone": "Europe/London",
        "daylightSavingTimeEnabled": true,
        "geoFenceEnabled": false,
        "predictiveAIREnabled": false,
        "comfortLevel": 0,
        "geoFenceNotificationEnabled": false,
        "geoFenceNotificationTypeId": 13,
        "configuration": {
            "faceRecognition": {
                "enabled": false,
                "maxPersons": 2,
                "maxEtas": 2,
                "maxEtaPersons": 1,
                "schedules": [
                    {
                        "time": [
                            {
                                "start": "15:00:00",
                                "end": "17:00:00"
                            }
                        ],
                        "days": [
                            "Sunday",
                            "Monday",
                            "Tuesday",
                            "Wednesday",
                            "Thursday",
                            "Friday",
                            "Saturday"
                        ]
                    }
                ]
            }
        }
    }
]
Field Name/Location Data Type Definition
locationID Integer Unique LocationID for a user's location.
name String User-defined name of location
streetAddress String User-defined street address of location
city String User-defined city of location
state String User-defined US State
country String Country of location
zipcode Integer User-defined Zip Code of location
devices Object Array Array of objects containing device data for each device attached to the location
users Object Array Array of objects, each object contains data for each user with access to the location
user.userID Integer Unique UserID
user.username String User's username to login, usually an email address
user.firstname String User's first name
user.lastname String User's last name
user.created Unix Timestamp Date and time account was created in epoch format
user.deleted Unix Timestamp Date and time account was deleted, negative number if not deleted
user.activated Boolean True/false if user has been activated
user.connectedHomeAccountExists Boolean
user.locationRoleMapping Object Array
user.locationRoleMapping.locationID Integer
user.locationRoleMapping.role String User role
user.locationRoleMapping.locationName String Name of location
user.locationRoleMapping.status Integer
user.isCurrentUser Boolean Is this user the currently logged in user (determined from OAuth Token)
timeZone String Time Zone of the location
timeZoneId String ID of the TimeZone
daylightSavingTimeEnabled Boolean Is DST enabled for this location
geoFences Array Shows configuration of user-defined geofences from our application
geoFenceEnabled Boolean Is geofencing used by the user?

Resource URL

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

Query Parameters


Name Values Description
apikey
(required)

Your API Key


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

Smart Home Security, Camera, Thermostat, Water Leak Detector

Working...