Building
API Calls
For more details on the making API Calls, view the API Calls section.
  • get
    /building/get
    Fetch a single Building Object without all of its nested entity object arrays (apartments, residents, & monitors).
  • get_full
    /building/get_full
    Fetch a single Building Object including all of its nested entity object arrays (apartments, residents, & monitors).
  • list
    /building/list
    Fetch an array of all Building Objects without their nested entity objects (apartments, residents, & monitors).
  • list_full
    /building/list_full
    Fetch an array of all Building Objects including their nested entity objects (apartments, residents, & monitors).
  • properties_delete
    /building/properties_delete
    Delete specified custom properties for a selected Building. Set the "keys" parameter to an array or comma-seperated string of keys to delete.
  • properties_update
    /building/properties_update
    Update your custom properties for a selected Building. Use this API call to associate additional information for this Building that will be stored in this Building's properties array.
Webhooks
For more details on the data that is sent to your Webhook Endpoint, view the Webhooks section.
  • add
    Triggers when a new Building is added and returns a data payload with the Building Object of the added Building.
  • delete
    Triggers when an existing Building is deleted and returns no data payload.
  • update
    Triggers when an existing Building is updated and returns a data payload with the Building Object of the updated Building.
Object
{
    "action_pins":[
        {
            "panel_id":"123456",
            "release":1,
            "action_length":6,
            "subtitle":"Front Door",
            "caption":"Visitor Access"
        }, {
            "panel_id":"123456",
            "release":2,
            "action_length":6,
            "subtitle":"Front Door",
            "caption":"Delivery Access"
        }
    ],
    "address":"42 Central Drive",
    "apartments":[...],
    "city":"Farmingdale",
    "color":"blue",
    "country":"United States",
    "formatted_address":"42 Central Dr, Farmingdale, NY 11735, USA",
    "id":1,
    "properties": {
        "key1":"value1",
        "key2":"value2",
        ... 
    },
    "state":"New York",
    "street_heading":"277.7400121306908",
    "street_lat":"40.75467994186277",
    "street_lng":"-73.40923584543378",
    "street_pitch":"-5.024535923262647",
    "street_zoom":"3.4294980411659024",
    "title":"North Tower",
    "zip":"11735-1202"
}
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.