Developer API Reference

Get all Locations

Retrive all locations associated with an account

GET /v1/locations

Query Parameters

page number
Results page to return
perPage number
Number of locations to return per page

Response Body

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the following location details.

page number
Current page of the returned locations
perPage number
Number of locations returned per page
pageCount string
Number of pages available
total number
Total number of locations
locations array
A list of all the locations
GET /v1/locations/ HTTP/1.1
Content-Type: application/json
Authorization: Bearer {}
    "page": 1,
    "perPage": 5,
    "pageCount": 1,
    "total": 1,
    "locations": [ {
        "locationId": "ae926a02...dbc8",
        "name": "The Condo",
        "homeAway": "home",
        "devices": [{
              "deviceId": "dac6955c...b96b",
              "type": "monitor",
              "connected": false,
              "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": []
    } ]