Resident
API Calls
For more details on the making API Calls, view the API Calls section.
  • get
    /resident/get
    Fetch a single Resident Object. Accepts the Resident's ID.
  • list_apartment
    /resident/list_apartment
    Fetch an array of all Resident Objects within a specified Apartment. Accepts the Apartment's ID.
  • list
    /resident/list
    Fetch an array of all Resident Objects within the Installation.
  • properties_delete
    /resident/properties_delete
    Delete specified custom properties for a selected Resident. Set the "keys" parameter to an array or comma-seperated string of keys to delete.
  • properties_update
    /resident/properties_update
    Update your custom properties for a selected Resident. Use this API call to associate additional information for this Resident that will be stored in this Resident'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 Resident is added and returns a data payload with the Resident Object of the added Resident.
  • delete
    Triggers when an existing Resident is deleted and returns no data payload.
  • move
    Triggers when an existing Resident is moved from one apartment to another and returns a data payload with the Resident Object of the updated Resident.
  • update
    Triggers when an existing Resident is updated and returns a data payload with the Resident Object of the updated Resident.
Resident Object Returned from API Calls & Webhooks
{
    "access_code":"1212",
    "access_photos_enabled":true,
    "action_pins":[
        {
            "action_length":6,
            "subtitle":"Front Door",
            "caption":"Visitor Access",
            "resident_api":"\/v1\/panel\/trigger_pin\/PANEL_ID\/21\/1"
        },
        {
            "action_length":6,
            "subtitle":"Front Door",
            "caption":"Delivery Access",
            "resident_api":"\/v1\/panel\/trigger_pin\/PANEL_ID\/21\/2"
        }
    ],    
    "androidCount":0,
    "apartment_id":1,
    "building_id":1,
    "email":"username@domain.com",
    "email_id":245,
    "first_name":"Dwight",
    "formatted_address":"42 Central Dr, Farmingdale, NY 11735, USA",
    "id":21,
    "iosCount":0,
    "last_name":"Schrute",
    "phone":"631-555-5500",
    "phone_country":"United States",
    "phone_country_code":"1",
    "phone_ext":"",
    "phone_intl":"+16315555500",
    "phone_sms":false,
    "profile_photo":"https:\/\/www.alphatouch.info\/user_photos\/profile_blank.jpg",
    "properties": {
        "key1":"value1",
        "key2":"value2",
        ... 
    },
    "proximity_code":"1234567890"
}
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.