Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Entrata

The Entrata integration utilizes Entrata Developer Portal and this documentation describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Entrata, visit our connection instructions.

Version​

This integration utilizes the Entrata API v1.

Base URL​

The base URL used for all Entrata API endpoints:
https://apis.entrata.com/ext/orgs/subdomain/v1

Authentication & Authorization​

The DataGrail Entrata integration connects using API Key authentication which requires an API Key.

Sensitive Credentials
Publicly exposing your API credentials can allow unauthorized access to Entrata API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Endpoints Utilized​

DataGrail uses the following endpoints to authorize and test the connection:

MethodEndpointPurposeDocs
POST/statusValidate credentials and check the API health status

Limits​

Limits in Entrata are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

  • DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
  • DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

Capabilities​

Access​

DataGrail's Entrata integration provides Synchronous Access capabilities for the following supported identifier categories: Email and Phone Number.

Data Interactions​

For Access requests, DataGrail will take the following actions:

  1. Fetch all properties with any status.
  2. Search customers by the configured identifier in the each of the properties.
  3. Search leads by the configured identifier in the each of the properties.

Endpoints Utilized​

MethodEndpointPurposeDocs
POST/customersSearch a customer by identifier
POST/leadsSearch a lead by identifier
POST/propertiesFetch properties

 

Need help?
If you have any questions, please reach out to your dedicated Account Manager or contact us at support@datagrail.io.

Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.