The Entrata API provides programmatic access to read and write data to our Entrata PaaS, and it retrieves property marketing data, lease and resident details, and more. Our API is organized around RPC protocols, and authenticates users by a username and password generated through the Entrata platform. Each user is a specific client and they can only access API for that particular company.
In order to make our API as explorable as possible, we have provided "Try Now" functionality for all read types of web-services. This functionality returns live data from a specific customer environment.
Our API returns data in XML or JSON format. For more basic calls, JSON is preferred. The response will match the request format and should be specified in the "Content-Type" HTTP header. The URL endpoint depends upon the call being made. For example, if you are making the getCustomers service, you would post to https://[subdomain].entrata.com/api/customers. The subdomain is client specific. Please visit our Code Snippet section for examples and references detailing our web services in several programming languages.
Provides method to retrieve AR codes for a specified management company.
|getArCodes||Returns all AR codes for a specified management company.|
Provides a library of functions to process electronic transactions.
|getArPayments||Retrieves AR payments details with reference to a Payment ID and for a selected date range.|
Provides a library of functions to retrieve or send resident transactions.
Provides a library of functions to retrieve or send customers information.
|getCustomers||Retrieves list of customers for a property.|
|getCustomerTestimonials||Retrieves list of customer testimonials for a property.|
|getTestimonialPickLists||Pick lists for Testimonials|
|searchCustomers||Searches customers for a property.|
|sendCustomerTestimonials||Inserts resident reviews and ratings.|
Provides a library of functions to retrieve or send Document information.
Provides a library of functions to retrieve or send financial information.
Provides a library of functions to retrieve or send leads information.
|getLeadPickLists||Pulls a list of Ids required for other lead services|
|getMitsLeads||Retrieves list of leads. This web service uses Lead Management 3.0 MITS specifications.|
|sendMitsLeads||Inserts new Guest Cards. This web service uses Lead Management 3.0 MITS specifications.|
|updateLeads||It is use to update the lead.|
Provides a library of functions to retrieve or send leases information.
|getExpiringLeases||Returns a list of expiring leases|
|getLeaseDocuments||Pulls list of lease documents.|
|getLeasePickList||Pulls a list of Ids required for other leases services|
|getMitsCollections||Retrieves the collection data.|
|getMitsLeases||Retrieves lease or application information.This web service uses Lease/Application 3.0 MITS specifications.|
Provides a library of functions to retrieve or send work orders (maintenance requests) related information.
Provides a library of functions to retrieve property related information.
|getFloorPlans||Retrieves list of floor plans for a property.|
|getPetTypes||Pulls a list of Pet types|
|getProperties||Retrieves properties details for the management company.|
|getPropertyAnnouncements||Retrieves announcements associated to property.|
|getPropertyPickLists||Pick List for Properties|
|getRentableItems||Retrieves list of rentable items for a property.|
Provides a library of functions to retrieve or send all property units related information.
|getAmenities||Pulls a list of Amenities|
|getMitsPropertyUnits||Retrieves property, floorplans, unit types, units, unit availability and pricing etc. information. This web service uses Property Marketing 3.0 MITS specifications.|
|getSpecials||Pulls a Specials/Concessions for the propertyId passed.|
|getUnitsAvailabilityAndPricing||Pulls a list of Unit availability and their pricing|
|getUnitTypes||Pulls a list of unit types|
|sendAmenities||This web service is used for inserting Property Amenities and Unit Amenities.|
|sendMitsPropertyUnits||Inserts or updates property, floorplans, unit types, units, unit availability and pricing etc. information. This web service uses Property Marketing 3.0 MITS specifications.|
Provides a library of functions to retrieve or send vendors related information.
|getInvoices||Fetch invoice batch for a vendor.|
|getTaxFormData||This web service returns Property management company vendors information and 1099 tax form data.|
|getVendorLocations||Pulls a list of VendorLocations|
|sendInvoices||Inserts invoice batch for a vendor.|
Select any of the web services below to view details and examples.