ALIS API Reference Guide

The ALIS API Export empowers your team to access hundreds of data points captured in ALIS for your own discrete reporting needs. This tool allows you to pull mergeable data exports directly into Excel Worksheets, Power BI Reports, and Google Sheets. 

What are APIs and endpoints?

An API (Application Programming Interface) is a set of protocols that enables different software to exchange data. An endpoint is a specific URL address within that API where requests are sent to access a particular resource, such as retrieving a list of residents or viewing current occupancies.

Example: https://api.alisonline.com/v1/export/communities/floorPlan/hqOccupancies

Refer to these external resources for additional information on APIs:

• A16Z: API World Summit
• FreeCodeCamp: What is an API?

ALIS API Export versions

There are two distinct methods for extracting data from ALIS, each designed for a different purpose.

• v1 Standard Excel Export: If you just need a static file to email to a stakeholder, store as a backup, or manually analyze, use the Standard Excel Export (v1). For step-by-step instructions on exporting data via this method, refer to the ALIS API v1: Standard Excel Exports guide.
• v2 Paged Export: If you are trying to have data automatically feed into another software (like Power BI or a custom dashboard), use the Paged Export (v2). For step-by-step instructions on exporting data via this method, refer to the ALIS API v2: Paged Exports (Microsoft Suite) and ALIS API v2: Paged Exports (Google Workspace) guides.

Step 1 - Access ALIS API Exports

The ALIS team must first create and enable your API access. We store these securely and will provide you with a unique username and password for your company. For assistance, contact your Account Manager or our ALIS Customer Success Team.  

Once you have been provided credentials, follow the steps below: 

1. Navigate to https://api.alisonline.com/index.html. 
2. In the top right hand 'Select a definition' dropdown menu, the default option is API v1. If you plan to pull larger datasets using Excel Advanced Power Query or PowerBI, be sure to choose API v2.
3. Then, click Authorize. 
4. In the 'Available authorizations' pop-up, type in the company Username and Password provided.
5. Once credentials have been entered, click Authorize. Then, click Close.

Step 2 - Select your endpoints 

Once you have entered credentials, the next step is to select your data endpoints from the ALIS API index. 

1. In the ALIS API index page, click the down arrows to see the specific values included in each export group.
2. Make note of the "URI stem" (e.g., /v2/export/communities) for the data you wish to pull. 

Once you have selected your endpoints, you can then proceed with your export. 

Step 3 - Export Data 

There are two methods for Excel. Use the Standard v1 Import for simple, quick data pulls. Use the Advanced Power Query if you require advanced pagination (pulling large datasets) or automated refreshing. 

• Standard Excel Export (v1): For detailed step-by-step instructions and FAQs, refer to this ALIS API v1: Standard Excel Exports guide.
• Advanced Power Query and Power BI Reports (v2): For detailed step-by-step instructions, refer to this ALIS API v2: Paged Exports (Microsoft Suite) guide. 
• Google Workspace/Sheets (v2): For detailed step-by-step instructions, refer to this ALIS API v2: Paged Exports (Google Workspace) guide.