• get

  /apartment/get

  Fetch a single Apartment Object without all of its nested entity object arrays (residents, & monitors). Accepts the Apartment's ID.
• get_full

  /apartment/get_full

  Fetch a single Apartment Object including all of its nested entity object arrays (residents, & monitors). Accepts the Apartment's ID.
• list

  /apartment/list

  Fetch an array of all Apartment Objects in the Installation without all of their nested entity object arrays (residents, & monitors).
• list_building

  /apartment/list_building

  Fetch an array of all Apartment Objects within a specified Building without all of their nested entity object arrays (residents, & monitors). Accepts the Building's ID.
• list_building_full

  /apartment/list_building_full

  Fetch an array of all Apartment Objects within a specified Building including all of their nested entity object arrays (residents, & monitors). Accepts the Building's ID.
• list_full

  /apartment/list_full

  Fetch an array of all Apartment Objects in the Installation including all of their nested entity object arrays (residents, & monitors).
• properties_delete

  /apartment/properties_delete

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

  /apartment/properties_update

  Update your custom properties for a selected Apartment. Use this API call to associate additional information for this Apartment that will be stored in this Apartment's properties array.

• add

  Triggers when new Apartments are added. If a single apartment is added, the data payload will contain the Apartment Object of the added Apartment. If Multiple Apartments are added, the entity_id field will contain an array of Apartment IDs and the data payload will contain the Array of Apartment Objects of the added Apartments.
• delete

  Triggers when an existing Apartment is deleted and returns no data payload.
• update

  Triggers when an existing Apartment is updated and returns a data payload with the Apartment Object of the updated Apartment.

{
    "atrc_board":0,
    "atrc_position":1,
    "building_id":1,
    "company_name":"",
    "elevator_board":0,
    "elevator_position":0,
    "id":1,
    "monitors":[...],
    "phone":"",
    "phone_ext":"",
    "properties": {
        "key1":"value1",
        "key2":"value2",
        ... 
    },
    "residents":[...],
    "title":"101A"
}