Developer API Reference

Locations

Location Object

locationId string
Unique location identifier
name string
The location name
homeAway string
Desired mode at the location. Can be either home or away
devices array
A list of all the devices installed at the location
alerts array
A list of all the current active alerts for the location
subscriptionIds array
A list of all ids of the subscriptions to this location
{
    "locationId": "ae926a02...dbc8",
    "name": "The Condo",
    "homeAway": "home",
    "devices": [{
          "deviceId": "dac6955c...b96b",
          "type": "monitor",
          "connected": true,
          "calibrated": true
      }],
    "alerts": [{
        "deviceId": "dac6955c...b96b",
        "type": "lowLeak",
        "active": true,
        "startTime": 1514374617,
        "detectedTime": 1514374917,
        "stopTime": 0
    }, {
        "deviceId": "dac6955c...b96b",
        "type": "ambientTemp",
        "active": true,
        "startTime": 1514373460,
        "detectedTime": 1514373760,
        "stopTime": 0
    }],
    "subscriptionIds": ["8402255b...9302"]
}

Device Object

deviceId string
Unique device identifier
type string
The type of device installed
connected boolean
Whether the device is connected or not
calibrated boolean
Whether the device has been calibrated or not
{
  "deviceId": "7a0f6726...97f8",
  "type": "monitor",
  "connected": true,
  "calibrated": true
}