Apartment
API Calls
For more details on the making API Calls, view the API Calls section.
  • 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_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
    /apartment/list
    Fetch an array of all Apartment Objects in the Installation without all of their nested entity object arrays (residents, & monitors).
  • 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.
Webhooks
For more details on the data that is sent to your Webhook Endpoint, view the Webhooks section.
  • 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.
Object
{
    "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"
}
Sandbox
Please Login to Enable Sandboxing

ALPHA COMMUNICATIONS  |  (DIV. OF GOLDCOM INC.)  |  42 CENTRAL DRIVE  |  FARMINGDALE NY 11735-1202
631-777-5500 MAIN  |   800-666-4800 USA  |   631-777-5599 FAX#  |  http://www.alphacommunications.com
Copyright© 2018-2020 Alpha Communications. All rights reserved.
Amazon, Echo, Alexa, and all related logos are trademarks of Amazon.com, Inc. or its affiliates.
Google LLC All rights reserved. Google and the Google logo are registered trademarks of Google LLC.