• get

  /installation/get

  Fetch the Installation Object without all of its other entity object arrays (buildings, apartments, residents, panels, staff stations & monitors).
• get_full

  /installation/get_full

  Fetch the full Installation Object including all of its other entity object arrays (buildings, apartments, residents, panels, staff stations & monitors).
• isolate_user

  /installation/isolate_user

  Fetch the full Installation Object as it pertains to a specific email/user. Accepts an email ID, and returns all embedded entity objects (buildings, apartments, residents, panels, staff stations & monitors) relevant to the specified user. For example, only the buildings and apartments that the user belongs to will be returned. Only the panels and staff stations related to those buildings will be returned. Accepts the Resident's Email ID
• properties_delete

  /installation/properties_delete

  Delete specified custom properties for this Installation. Set the "keys" parameter to an array or comma-seperated string of keys to delete.
• properties_update

  /installation/properties_update

  Update your custom properties for this Installation. Use this API call to associate additional information for this installation that will be stored in this Installation's properties array.
• update_devices

  /installation/update_devices

  Send the Refresh Command to All System Devices to ensure their programming is up to date.

• activate

  Triggers when an Installation's Service is activated and returns no data payload. This will cause your deactivated integration to start working again, so it's important to use this data to handle the activation of services gracefully.
• deactivate

  Triggers when an Installation's Service is deactivated and returns no data payload. This will cause your integration to stop working, so it's important to use this data to handle the termination of services gracefully.
• update

  Triggers when an Installation is updated and returns a data payload with the Installation Object of the updated Installation. Does not contain embedded Objects (Administrators, Panels, Staff Stations, Buildings, Apartments, Residents or Monitors).
• webhook_test

  Triggers when an Installation's Webhook URL is saved/updated and is caused by our servers verifying that the provided endpoint returns a Valid 200 Status. NOTE: This webhook can be triggered even if Installation webhooks are disabled!

{
    "access_code_min":"4",
    "active":true,
    "address_list":[...],
    "administrators": [...],
    "apartment_term":"Apartment",
    "apartments_term":"Apartments",
    "building_term":"Building",
    "buildings": [...],
    "buildings_term":"Buildings",
    "commercial":true,
    "companies_term":"Companies",
    "company_term":"Company",
    "counts":{
        "connected_devices":1,
        "total_devices":1,
        "buildings":1,
        "apartments":150,
        "residents":416,
        "managers":3,
        "staff_stations":0,
        "connected_staff_stations":0,
        "panels":1,
        "connected_panels":1,
        "monitors":0,
        "connected_monitors":0,
        "relay_controllers":0
    },
    "default_language":"EN",
    "id":1,
    "max_apartments":0,
    "max_residents":0,
    "max_residents_per_apartment":0,
    "panels": [...],
    "properties": {
        "key1":"value1",
        "key2":"value2",
        ... 
    },
    "resident_access_edit":true,
    "resident_access_enabled":true,
    "resident_edit_enabled":1,
    "resident_term":"Tenant",
    "residents_term":"Tenants",
    "staff_stations": [...],
    "timezone":"America\/New_York",
    "title":"101 Broadway"
}