You were redirected to the new home of the Entrata API documentation! 𝘦𝘯𝘵𝘳𝘢𝘵𝘢.𝘤𝘰𝘮/𝘢𝘱𝘪/𝘷1/𝘥𝘰𝘤𝘶𝘮𝘦𝘯𝘵𝘢𝘵𝘪𝘰𝘯 is now 𝘥𝘰𝘤𝘴.𝘦𝘯𝘵𝘳𝘢𝘵𝘢.𝘤𝘰𝘮
Select any of the web services below to view details and examples.
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.
Please note that unless stated otherwise, all dates and times used in the API are assumed to be in Mountain Time (MST or MDT).
The Accept-Language request header parameter can be used to request that the values returned in the response be translated into the language and locale that is desired, provided that the language is active and enabled for the client. Possible values are: [ en-US, en-CA, en-GB, es-MX, es-PE, hi-IN, zh-CN, en-IE, es-US, es-ES, fr-FR, es-CL ].
|This API will specify the API health status whether it is running or not.
Provides a library of functions to retrieve or send applications.
|This service will insert applications.
|This service will insert or update the pets on an application. Please note that any applicable fees will also be applied based on the property fee structure.
|Add Vehicle details to an application
Provides method to retrieve AR codes for a specified management company.
|Returns all AR codes for a specified management company
Provides a library of functions to process electronic transactions.
|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.
|This API is to get the information of Ar Invoices along with transactions and payments.
|Retrieves a list of all transactions for a given lease
|Retrieves list of all transactions for a given lease.
|Inserts lease AR transaction charges.
|Pulls the marketing contact type preferences for a customer and what they have opted in or out of. Note that for SMS, if the customer does not have a mobile number entered Entrata, no SMS preferences will be returned.
|Note: SMS Consent type - Contact Point is updated on updating the SMS consent type - Property Notification.
Provides a library of functions to retrieve or send customers information.
|Retrieves list of customers for a property. By default, this webservice returns residents where their lease status is Current or Notice.
|Retrieves list of customer testimonials for a property.
|Pick lists for Testimonials
|Searches customers for a property.
|Inserts resident reviews and ratings.
|This service allows the user to update the customers' basic required information.
Provides a library of functions to retrieve or send financial information.
|This service will fetch job cost codes.
|retrieve bank accounts for particular management company.
|API pull's details of the budget from Entrata.
|Returns all GL transactions for a property. By default the webservice returns summarized transactions.
|Retrieves GL accounts information.
|This service will fetch job categories
|This service will fetch job cost budgets.
|Returns the job details added on the jobCosting
|Returns the transactionCustomTags and transactionRoutingTags
|Marks the provided GL transactions as exported under the API export type. Does not impact being able to export the same transactions in other export types using other Entrata GL Export formats.
|Inserts the Journal Entries.
Provides a library of functions to retrieve or send leads information.
|Apply quote to the application
|Generates quotes for the application.
|Pulls a list of Ids required for other lead services
|Retrieves a list of leads of all status types. This web service uses Lead Management 3.0 MITS specifications.
|Retrieves a list of prospect quotes from Entrata.
|Inserts new Guest Card.
|Inserts new Guest Cards. This web service uses Lead Management 3.0 MITS specifications. Please note that this service is being replaced by the sendLeads API and will eventually not be supported by Entrata.
|It is use to update the lead.
Provides a library of functions to retrieve or send leases information.
|Cancelling a lease which is in future status with unit and unit spaces associated with it.
|Returns a list of expiring leases
|Pulls list of lease documents.
|Pulls the list of lease documents.
|Pulls a list of Ids required for other leases services
|Retrieves lease or application information. By default, this webservice returns leases that are in Current and Notice lease status. This endpoint is paginated, for pagination details check the response headers.
|Retrieves the collection data.
|Retrieves lease or application information.This web service uses Lease/Application 3.0 MITS specifications. By default, this webservice returns leases which are in Current and Notice lease status.
|web service will return active as well as inactive packages.
|This API can be used to upload documents onto Entrata leases such as application, lease, policy, agreement documents. This API accepts files as a form file upload and the Content-Type should be "multipart/form-data". Please see the "Code Snippet" tab for more technical details and some sample code examples.
|To insert the roommate groups.
|This service allows the user to update the lease's basic required information and occupants.
Provides a library of functions to retrieve or send work orders (maintenance requests) related information.
|We are fetching inspection templates based on the input provided in the request.
|Pulls a list of Ids required for other workorder services
|Retrieves work orders information.
|Inserts new work orders.
|Update the work orders.
Provides a library of functions for retrieving pricing related information.
|Retrieves picklist of id/name for the "CASCADE", "ORIGIN" and "TRIGGER" from the company.
|insertPricing allows updating pricing at a different level with multiple combinations. All nodes create a number of combinations and depending on the property setup API accepts the data. E.g If the property has the setup to accept term wise pricing then only API can accept the allowed terms under the node "leaseTermMonths". Please note that this API is designed for Conventional property type and may not work for other property types. It is intended to price Available Units for marketing purposes.
|sendBudgetedRent insert rates for unavailable units.
Provides a library of functions to retrieve property related information.
|This API pulls information about the property calendar such as general staff and tour hours of operation, allowed length of appointments, and provides the open calendar time slots as per the dates and calendar category types passed in the request.
|Retrieves list of floor plans for a property.
|Pulls a list of Pet types
|Retrieves properties details for the management company.
|Retrieves announcements associated to property.
|Version R2 for getPropertyPickLists. Converted the parameters from attribute to Nodes.
|Retrieves list of rentable items for a property.
|Insert the floorplans
|To insert the Rentable Items in to Entrata
Provides a library of functions to retrieve or send all property units related information.
|Pulls a list of Amenities
|Retrieves property, floorplans, unit types, units, unit availability and pricing etc. information. This web service uses Property Marketing 3.0 MITS specifications. NOTE: For new projects, please do not use this service and instead use "getPropertyUnits" which is the updated version of this service but no longer supports the MITS standards.
|Retrieves property, floorplans, unit types, units, unit availability and pricing, etc. information. If the property requested is a parent property with related child or phased properties then those properties will be found in subsequent pages and can be requested using the page specific URLs provided in the response headers.
|Pulls a Specials/Concessions for the property passed.
|Pulls a list of Unit availability and their pricing
|Pulls a list of unit types. Rates returned are both active and web visible.
|Insert the amenities.
|Insert the property units/unit space and other the required details.
|This service allows user to update the amenities (property/floorplan/unit type/unit space).
Provides a library of functions to retrieve or send vendors related information.
|Fetch invoice batch for a vendor.
|This web service returns Property management company vendors information and 1099 tax form data.
|Pulls a list of VendorLocations
|This web service will return pick list.
|This service returns vendor records based on the vendorIds or vendorCodes provided.
|Inserts invoice batch for a vendor.
|This webservice allows you to update an existing invoice in Entrata.
|This webservice allows users to mark the AP Payments voided.