Resident
API Calls
For more details on the making API Calls, view the API Calls section.
-
get/resident/getFetch a single Resident Object. Accepts the Resident's ID.
-
list/resident/listFetch an array of all Resident Objects within the Installation.
-
list_apartment/resident/list_apartmentFetch an array of all Resident Objects within a specified Apartment. Accepts the Apartment's ID.
-
properties_delete/resident/properties_deleteDelete 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_updateUpdate 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.
-
addTriggers when a new Resident is added and returns a data payload with the Resident Object of the added Resident.
-
deleteTriggers when an existing Resident is deleted and returns no data payload.
-
moveTriggers when an existing Resident is moved from one apartment to another and returns a data payload with the Resident Object of the updated Resident.
-
updateTriggers when an existing Resident is updated and returns a data payload with the Resident Object of the updated Resident.
Object
{
"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,
"door_release_enabled":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
Copyright© 2018-2023 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.