References API

🚧

Experimental Feature

The References API is currently an experimental feature. Therefore, the API and this documentation is subject to change. If you have any questions, please email Engrain Support.

Overview

The References API provides mappings from third-party data providers, such as property management systems (PMS), to Engrain's stable asset and unit IDs. Engrain calls these mappings references. Each reference group links a distinct provider’s asset or unit ID to the corresponding Engrain ID.

For more detail on using the Unit Map® REST API, see the REST API documentation and OpenAPI spec.

Learn how to implement the References API with our helpful quick start guide, here.

Data Providers

For each data provider, we define what the reference values represent and how the values are retrieved.

PMS Vendors
Entrata
MRI
RealPage OneSite
ResMan
Yardi RentCafe
Yardi Voyager

CRM
Funnel

Custom Solutions
Greystar
Venterra Realty

Partner Solutions
AppWork

Data Sources and References Key:Value Mapping

Property Management System

*Multiple unit reference keys exist. Multiple keys create flexibility for reference data consumers to ensure there is a value that can be related to as many datasets as possible. Consumers can identify the key that contains the value that relates to their dataset accordingly.

Property Management System: Rentable Items

null Values

Engrain's interactive maps and datasets represent the physical space of each property which will result in units appearing in the references API with a null value as the units exist on the physical map, but not in the property management system at the time the map and dataset were created. This is expected behavior and the null value units will either obtain a provider reference id or be removed from the dataset.

CRM

Custom Solutions

Partner Solutions

Floor Plan and Unit Type Mapping

Overview

The Floor Plans and Units endpoints provide mappings from third-party data providers’ floor plan and unit type IDs to Engrain’s floor plan and unit IDs. Unlike asset and unit references, floor plan and unit type mappings are not part of the References API and will be returned from the applicable resource.