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": 29769,
		"name": "Office",
		"streetAddress": "1985 Douglas drive n",
		"city": "Golden valley ",
		"state": "MN",
		"country": "Usa",
		"zipcode": "55401",
		"devices": [
			{
				"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
				}
			},
			{
				"displayedOutdoorHumidity": 54,
				"vacationHold": {
					"enabled": false
				},
				"currentSchedulePeriod": {
					"day": "Monday",
					"period": "P2"
				},
				"scheduleCapabilities": {
					"availableScheduleTypes": [
						"None",
						"Geofenced",
						"TimedEmea"
					],
					"schedulableFan": false
				},
				"scheduleType": {
					"scheduleType": "Timed",
					"scheduleSubType": "EMEA"
				},
				"scheduleStatus": "Pause",
				"allowedTimeIncrements": 10,
				"settings": {
					"hardwareSettings": {
						"brightness": 4,
						"maxBrightness": 5
					},
					"temperatureMode": {
						"air": true
					},
					"specialMode": {}
				},
				"deviceClass": "Thermostat",
				"deviceType": "Thermostat",
				"deviceID": "LCC-00D02DAB2004",
				"userDefinedDeviceName": "upstairs ",
				"name": "upstairs ",
				"isAlive": true,
				"isUpgrading": false,
				"isProvisioned": true,
				"macID": "00D02DAB2004",
				"deviceSettings": {},
				"units": "Celsius",
				"indoorTemperature": 23,
				"outdoorTemperature": 10.5,
				"allowedModes": [
					"Heat",
					"Off"
				],
				"deadband": 0,
				"hasDualSetpointStatus": false,
				"minHeatSetpoint": 5,
				"maxHeatSetpoint": 35,
				"minCoolSetpoint": -18,
				"maxCoolSetpoint": -18,
				"changeableValues": {
					"mode": "Heat",
					"heatSetpoint": 20,
					"coolSetpoint": 32,
					"thermostatSetpointStatus": "PermanentHold",
					"endHeatSetpoint": 20,
					"endCoolSetpoint": 32,
					"heatCoolMode": "Heat"
				},
				"operationStatus": {
					"mode": "EquipmentOff",
					"fanRequest": false,
					"circulationFanRequest": true
				}
			},
			{
				"firmwareVer": "0.5.16A4",
				"waterPresent": false,
				"currentSensorReadings": {
					"time": "2017-10-18T17:51:46",
					"temperature": 22.82,
					"humidity": 41.6
				},
				"currentAlarms": [],
				"lastCheckin": "2017-10-18T17:51:47",
				"lastDeviceSettingUpdatedOn": "0001-01-01T00:00:00",
				"batteryRemaining": 100,
				"isRegistered": true,
				"hasDeviceCheckedIn": true,
				"isDeviceOffline": false,
				"firstFailedAttemptTime": "0001-01-01T00:00:00",
				"failedConnectionAttempts": 0,
				"wifiSignalStrength": -53,
				"isFirmwareUpdateRequired": false,
				"time": "2017-10-18T17:51:46",
				"deviceClass": "LeakDetector",
				"deviceType": "Water Leak Detector",
				"deviceID": "0d2931a0-b6c8-43fc-805a-bc1e6a378bf6",
				"userDefinedDeviceName": "Master Bathroom",
				"backend": {
					"id": "0d2931a0-b6c8-43fc-805a-bc1e6a378bf6"
				},
				"isAlive": true,
				"isUpgrading": false,
				"isProvisioned": true,
				"deviceSettings": {
					"temp": {
						"high": {
							"limit": 37
						},
						"low": {
							"limit": 7
						}
					},
					"humidity": {
						"high": {
							"limit": 70
						},
						"low": {
							"limit": 20
						}
					},
					"userDefinedName": "Master Bathroom",
					"buzzerMuted": false,
					"checkinPeriod": 24,
					"currentSensorReadPeriod": 60
				}
			}
		],
		"users": [
			{
				"userID": 81447,
				"username": "hw.test@gmail.com",
				"firstname": "Hw",
				"lastname": "test",
				"created": 1466524834,
				"deleted": -62135596800,
				"activated": true,
				"connectedHomeAccountExists": true,
				"locationRoleMapping": [
					{
						"locationID": 29769,
						"role": "Adult",
						"locationName": "Office",
						"status": 1
					}
				],
				"isCurrentUser": true
			}
		],
		"timeZoneId": "Central",
		"timeZone": "Central Standard Time",
		"daylightSavingTimeEnabled": true,
		"geoFenceEnabled": false
	},
	{
		"locationID": 58988,
		"name": "Home",
		"streetAddress": "1985 Douglas Drive",
		"city": "Los Angeles",
		"state": "ca",
		"country": "Usa",
		"zipcode": "90003",
		"devices": [
			{
				"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
				}
			},
			{
				"displayedOutdoorHumidity": 39,
				"vacationHold": {
					"enabled": false
				},
				"currentSchedulePeriod": {
					"day": "Monday",
					"period": "Away"
				},
				"scheduleCapabilities": {
					"availableScheduleTypes": [
						"None",
						"Geofenced",
						"TimedNorthAmerica"
					],
					"schedulableFan": false
				},
				"scheduleType": {
					"scheduleType": "Timed",
					"scheduleSubType": "NA"
				},
				"scheduleStatus": "Resume",
				"allowedTimeIncrements": 15,
				"settings": {
					"hardwareSettings": {
						"brightness": 1,
						"maxBrightness": 5
					},
					"fan": {
						"allowedModes": [
							"On",
							"Auto",
							"Circulate"
						],
						"changeableValues": {
							"mode": "Circulate"
						}
					},
					"temperatureMode": {
						"air": true
					},
					"specialMode": {
						"autoChangeoverActive": false
					}
				},
				"deviceClass": "Thermostat",
				"deviceType": "Thermostat",
				"deviceID": "LCC-00D02DB60BA0",
				"userDefinedDeviceName": "Retail",
				"name": "Retail",
				"isAlive": false,
				"isUpgrading": false,
				"isProvisioned": true,
				"macID": "00D02DB60BA0",
				"deviceSettings": {},
				"units": "Fahrenheit",
				"indoorTemperature": 74,
				"outdoorTemperature": 71.8,
				"allowedModes": [
					"Heat",
					"Off",
					"Cool",
					"Auto"
				],
				"deadband": 0,
				"hasDualSetpointStatus": false,
				"minHeatSetpoint": 50,
				"maxHeatSetpoint": 90,
				"minCoolSetpoint": 50,
				"maxCoolSetpoint": 90,
				"changeableValues": {
					"mode": "Off",
					"autoChangeoverActive": false,
					"heatSetpoint": 62,
					"coolSetpoint": 85,
					"thermostatSetpointStatus": "NoHold",
					"nextPeriodTime": "18:00:00",
					"endHeatSetpoint": 62,
					"endCoolSetpoint": 85,
					"heatCoolMode": "Cool"
				},
				"operationStatus": {
					"mode": "EquipmentOff",
					"fanRequest": false,
					"circulationFanRequest": true
				}
			},
			{
				"displayedOutdoorHumidity": 60,
				"vacationHold": {
					"enabled": false
				},
				"currentSchedulePeriod": {
					"day": "Monday",
					"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": "Auto"
						}
					},
					"temperatureMode": {
						"air": true
					},
					"specialMode": {}
				},
				"deviceClass": "Thermostat",
				"deviceType": "Thermostat",
				"deviceID": "LCC-00D02DBBBBC0",
				"userDefinedDeviceName": "T62",
				"name": "T62",
				"isAlive": false,
				"isUpgrading": false,
				"isProvisioned": true,
				"macID": "00D02DBBBBC0",
				"deviceSettings": {},
				"units": "Fahrenheit",
				"indoorTemperature": 74,
				"outdoorTemperature": 75,
				"allowedModes": [
					"Heat",
					"Off",
					"Cool"
				],
				"deadband": 0,
				"hasDualSetpointStatus": false,
				"minHeatSetpoint": 50,
				"maxHeatSetpoint": 90,
				"minCoolSetpoint": 50,
				"maxCoolSetpoint": 90,
				"changeableValues": {
					"mode": "Cool",
					"heatSetpoint": 50,
					"coolSetpoint": 74,
					"thermostatSetpointStatus": "PermanentHold",
					"nextPeriodTime": "18:00:00",
					"endHeatSetpoint": 62,
					"endCoolSetpoint": 85,
					"heatCoolMode": "Cool"
				},
				"operationStatus": {
					"mode": "EquipmentOff",
					"fanRequest": false,
					"circulationFanRequest": false
				}
			},
			{
				"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"
			}
		],
		"users": [
			{
				"userID": 81447,
				"username": "hw.test@gmail.com",
				"firstname": "Hw",
				"lastname": "test",
				"created": 1466524834,
				"deleted": -62135596800,
				"activated": true,
				"connectedHomeAccountExists": true,
				"locationRoleMapping": [
					{
						"locationID": 58988,
						"role": "Adult",
						"locationName": "Home",
						"status": 1
					}
				],
				"isCurrentUser": true
			},
			{
				"userID": 278557,
				"username": "hw.test@gmail.com",
				"firstname": "HW",
				"lastname": "test",
				"created": 1493756876,
				"deleted": -62135596800,
				"activated": true,
				"connectedHomeAccountExists": true,
				"locationRoleMapping": [
					{
						"locationID": 58988,
						"role": "Adult",
						"locationName": "Home",
						"status": 1
					}
				],
				"isCurrentUser": false
			}
		],
		"timeZoneId": "Central",
		"timeZone": "Central Standard Time",
		"daylightSavingTimeEnabled": true,
		"geoFenceEnabled": false
	},
	{
		"locationID": 377467,
		"name": "UK",
		"country": "Canada",
		"zipcode": "KT12 5PAY",
		"users": [
			{
				"userID": 81447,
				"username": "hw.test@gmail.com",
				"firstname": "Hw",
				"lastname": "test",
				"created": 1466524834,
				"deleted": -62135596800,
				"activated": true,
				"connectedHomeAccountExists": true,
				"locationRoleMapping": [
					{
						"locationID": 377467,
						"role": "Adult",
						"locationName": "UK",
						"status": 1
					}
				],
				"isCurrentUser": true
			}
		],
		"timeZoneId": "Central",
		"timeZone": "Central Standard Time",
		"daylightSavingTimeEnabled": true,
		"geoFenceEnabled": false,
		"predictiveAIREnabled": false,
		"comfortLevel": 0
	},
	{
		"locationID": 378708,
		"name": "Camera",
		"country": "Usa",
		"zipcode": "55422",
		"devices": [],
		"users": [
			{
				"userID": 81447,
				"username": "hw.test@gmail.com",
				"firstname": "Hw",
				"lastname": "test",
				"created": 1466524834,
				"deleted": -62135596800,
				"activated": true,
				"connectedHomeAccountExists": true,
				"locationRoleMapping": [
					{
						"locationID": 378708,
						"role": "Adult",
						"locationName": "Camera",
						"status": 1
					}
				],
				"isCurrentUser": true
			}
		],
		"timeZoneId": "Central",
		"timeZone": "Central Standard Time",
		"daylightSavingTimeEnabled": true,
		"geoFenceEnabled": false,
		"predictiveAIREnabled": false,
		"comfortLevel": 0
	}
]
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...