What API tiers are available in the agentOS V4 API?
The agentOS V4 API is organised into distinct tiers, each covering a specific area of functionality. Each tier requires its own API key permission and serves different integration use cases.
The agentOS V4 API is the current API generation and is recommended for all new integrations. It is divided into tiers, each providing access to a different area of the system. You can enable multiple tiers on a single API key by selecting the relevant permissions when the key is created.
For help creating an API key with the correct permissions, see our guide on how to request and manage API keys.
Advertising API
The Advertising API provides the ability to extract marketing data for sales and lettings from agentOS, enabling you to build your own marketing website and advertise your property listings. This is the most commonly used API tier for website integrations.
For full documentation, see the Advertising API guide.
Applications API
The Applications API provides the ability to post tenancy applications and alerts for lettings and sales applicants, as well as submit sales offers. This is used by application portals and lead capture tools that need to feed enquiries directly into agentOS.
For full documentation, see the Applications API guide.
Appointments API
The Appointments API provides the ability to retrieve and create appointments for sales and lettings properties. This is used for online booking systems, viewing schedulers, and diary integrations.
For full documentation, see the Appointments API guide.
Concierge API
The Concierge API provides the ability to extract tenancy and sales data for properties set to be managed by a concierge service, along with utility switching data. Access to this tier requires a concierge-specific API key — contact your client to request one. GDPR consent is enforced automatically on all personal data returned.
For full documentation, see the Concierge API guide.
Contacts API
The Contacts API provides the ability to manage and retrieve contact data for applicants, tenants, landlords, vendors, and purchasers. As contact information is GDPR-restricted, the API only returns data for individuals who have consented to be contacted by third-party marketing sources.
For full documentation, see the Contacts API guide.
Deposits API
The Deposits API provides the ability to retrieve tenancy deposit information held within agentOS. This is used by deposit protection integrations and financial reporting tools.
Documents API
The Documents API provides the ability to upload and retrieve documents associated with properties, tenancies, and contacts. Supported formats include PDF, JPG, PNG, DOC, DOCX, XLS, and XLSX.
Inspections API
The Inspections API provides the ability to retrieve property inspection appointments and related property and tenancy data. This is used by inspection management and property reporting tools.
For full documentation, see the Inspections API guide.
Maintenance API
The Maintenance API covers the complete maintenance lifecycle, including creating and tracking jobs, assigning contractors, processing invoices, and managing documents. This is used by maintenance management platforms and contractor workflow tools.
Notes API
The Notes API provides the ability to create and retrieve notes against system objects such as properties, landlords, tenants, and applicants. This is used by CRM integrations and audit tools.
Property Management API
The Property Management API provides the ability to manage property media, including photos, floor plans, and portal media for both lettings and sales instructions. It also supports lead creation. This tier is particularly useful for portal feed management and media upload tools.
Referencing API
The Referencing API is designed for third-party referencing providers and tenant screening services. It provides access to pending tenant applications and supports attachment of completed referencing documents.
Reporting API
The Reporting API provides access to business intelligence and analytics data held within agentOS. This is used for custom dashboards, management reporting tools, and data warehouse integrations.
Valuations API
The Valuations API provides the ability to submit and manage property valuation workflows, including retrieving valuation appointments and related property data.
Getting support
For questions about API access, key creation, or integration capabilities, contact api@agentos.com.