V4 API Tier Overview

The following article should provide an outline of the API tiers available on V4 of our API.

Advertising API

The advertising API will provide you with the ability to extract marketing data for sales and lettings from agentOS to allow you to create your own marketing websites to advertise your listings. Additional documentation for the API can be found here.

Applications API

The applications API will provide you with the ability to post applications and alerts for lettings and sales applicants and sales offers. Additional documentation for the API can be found here.

Appointments API

The appointments API will provide you with the ability to retrieve and create appointments for sales and lettings properties. Additional documentation for the API can be found here.

Concierge API

The concierge API will provide you with the ability to extract the tenancies and sales instructions set up in agentOS that are set to be managed by a concierge service, and from those extract the contact details of any parties involved in the tenancy or sale. Additional documentation for the API can be found here.

Contacts API

The contacts API will provide you with the ability to extract people's contact details set up in agentOS. This can be used to create mailing lists for marketing purposes. Additional documentation for the API can be found here.

Deposits API

The deposits API will provide you with the ability to extract deposit data for tenancies. Additional documentation for the API is coming soon.

Documents API

The documents API will provide you with the ability to obtain and upload documents.  Additional documentation for the API is coming soon.

Inspections API

The inspections API will provide you with the ability to retrieve and manage property inspections within agentOS. Additional documentation surrounding integrating with our inspections API can be found here.

Notes API

The notes API will provide you with the ability to retrieve and create notes within agentOS. Additional documentation surrounding integrating is coming soon.

Valuations API

The valuations API will provide you with the ability to create valuations within agentOS. Additional documentation surrounding integrating is coming soon.

Property Management API

The property management API will provide you with the ability to create leads within agentOS, upload and delete phoots and submit portal media. Additional documentation surrounding integrating is coming soon.