> A stable REST API gives your engineering team and integration partners direct access to contacts, saved searches, account info, and live property data.

*Source: https://aeroidx.com/features/developers/rest-api/ — this is the markdown version of that page, generated at build time.*

---

**Browse features**

-   [AI Coach](https://aeroidx.com/features/ai/ai-coach/)
-   [AI Lead Alert Suggestions](https://aeroidx.com/features/ai/lead-alert-suggestions/)
-   [AI Natural Language Search](https://aeroidx.com/features/ai/natural-language-search/)
-   [AI Property Q&A](https://aeroidx.com/features/ai/property-qa/)
-   [AI Website Setup](https://aeroidx.com/features/ai/ai-website-setup/)
-   [AI-Drafted Property Emails](https://aeroidx.com/features/ai/ai-drafted-emails/)

-   [Advanced Filter Schema](https://aeroidx.com/features/idx/advanced-filter-schema/)
-   [Custom Search Fields](https://aeroidx.com/features/idx/custom-search-fields/)
-   [Custom SMTP Email Delivery](https://aeroidx.com/features/idx/custom-smtp-email-delivery/)
-   [Featured Listings](https://aeroidx.com/features/idx/featured-listings/)
-   [Listing Details Layout](https://aeroidx.com/features/idx/listing-details-layout/)
-   [Map Search Widget](https://aeroidx.com/features/idx/map-search-widget/)
-   [Page Path Configuration](https://aeroidx.com/features/idx/page-path-configuration/)
-   [Supplemental Listings](https://aeroidx.com/features/idx/supplemental-listings/)

-   [Agent Alerts & Broker Reports](https://aeroidx.com/features/leads/agent-alerts/)
-   [Behavioral Tracking](https://aeroidx.com/features/leads/behavioral-tracking/)
-   [Facebook Dynamic Ads Feed](https://aeroidx.com/features/leads/facebook-ads-feed/)
-   [Follow Up Boss Integration](https://aeroidx.com/features/leads/follow-up-boss/)
-   [GoHighLevel Integration](https://aeroidx.com/features/leads/gohighlevel/)
-   [Lead Routing & Assignment](https://aeroidx.com/features/leads/lead-routing/)
-   [Leads Dashboard](https://aeroidx.com/features/leads/leads-dashboard/)
-   [Market Area Subscriptions](https://aeroidx.com/features/leads/market-area-subscriptions/)
-   [Saved Searches](https://aeroidx.com/features/leads/saved-searches/)
-   [Send Properties to Leads](https://aeroidx.com/features/leads/send-properties/)
-   [SureSend Integration](https://aeroidx.com/features/leads/suresend/)

-   [Component Color Settings](https://aeroidx.com/features/websites/component-color-settings/)
-   [Custom CSS Themes](https://aeroidx.com/features/websites/custom-css-themes/)
-   [IDX Button for GoHighLevel](https://aeroidx.com/features/websites/idx-button-for-gohighlevel/)
-   [One-Click Website](https://aeroidx.com/features/websites/one-click-website/)
-   [Showing Schedule](https://aeroidx.com/features/websites/showing-schedule/)
-   [Single Property Websites](https://aeroidx.com/features/websites/single-property-websites/)
-   [Themed Widget Skins](https://aeroidx.com/features/websites/themed-widget-skins/)
-   [Visual Widget Builder](https://aeroidx.com/features/websites/visual-widget-builder/)

-   [Agency Dashboard](https://aeroidx.com/features/teams/agency-dashboard/)
-   [Embedded Dashboard](https://aeroidx.com/features/teams/embedded-dashboard/)
-   [Per-Agent Custom Websites](https://aeroidx.com/features/teams/per-agent-websites/)
-   [Roster Management](https://aeroidx.com/features/teams/roster-management/)
-   [Roster-to-GHL Sub-Account Mapping](https://aeroidx.com/features/teams/roster-ghl-mapping/)
-   [Sub-Account Management & Impersonation](https://aeroidx.com/features/teams/sub-accounts-impersonation/)

-   [API Key Management](https://aeroidx.com/features/developers/api-keys/)
-   [MCP Server](https://aeroidx.com/features/developers/mcp-server/)
-   [REST API v1](https://aeroidx.com/features/developers/rest-api/)
-   [Webhooks](https://aeroidx.com/features/developers/webhooks/)

AI 6

-   [AI Coach](https://aeroidx.com/features/ai/ai-coach/)
-   [AI Lead Alert Suggestions](https://aeroidx.com/features/ai/lead-alert-suggestions/)
-   [AI Natural Language Search](https://aeroidx.com/features/ai/natural-language-search/)
-   [AI Property Q&A](https://aeroidx.com/features/ai/property-qa/)
-   [AI Website Setup](https://aeroidx.com/features/ai/ai-website-setup/)
-   [AI-Drafted Property Emails](https://aeroidx.com/features/ai/ai-drafted-emails/)

IDX Search 8

-   [Advanced Filter Schema](https://aeroidx.com/features/idx/advanced-filter-schema/)
-   [Custom Search Fields](https://aeroidx.com/features/idx/custom-search-fields/)
-   [Custom SMTP Email Delivery](https://aeroidx.com/features/idx/custom-smtp-email-delivery/)
-   [Featured Listings](https://aeroidx.com/features/idx/featured-listings/)
-   [Listing Details Layout](https://aeroidx.com/features/idx/listing-details-layout/)
-   [Map Search Widget](https://aeroidx.com/features/idx/map-search-widget/)
-   [Page Path Configuration](https://aeroidx.com/features/idx/page-path-configuration/)
-   [Supplemental Listings](https://aeroidx.com/features/idx/supplemental-listings/)

Leads & CRM 11

-   [Agent Alerts & Broker Reports](https://aeroidx.com/features/leads/agent-alerts/)
-   [Behavioral Tracking](https://aeroidx.com/features/leads/behavioral-tracking/)
-   [Facebook Dynamic Ads Feed](https://aeroidx.com/features/leads/facebook-ads-feed/)
-   [Follow Up Boss Integration](https://aeroidx.com/features/leads/follow-up-boss/)
-   [GoHighLevel Integration](https://aeroidx.com/features/leads/gohighlevel/)
-   [Lead Routing & Assignment](https://aeroidx.com/features/leads/lead-routing/)
-   [Leads Dashboard](https://aeroidx.com/features/leads/leads-dashboard/)
-   [Market Area Subscriptions](https://aeroidx.com/features/leads/market-area-subscriptions/)
-   [Saved Searches](https://aeroidx.com/features/leads/saved-searches/)
-   [Send Properties to Leads](https://aeroidx.com/features/leads/send-properties/)
-   [SureSend Integration](https://aeroidx.com/features/leads/suresend/)

Websites 8

-   [Component Color Settings](https://aeroidx.com/features/websites/component-color-settings/)
-   [Custom CSS Themes](https://aeroidx.com/features/websites/custom-css-themes/)
-   [IDX Button for GoHighLevel](https://aeroidx.com/features/websites/idx-button-for-gohighlevel/)
-   [One-Click Website](https://aeroidx.com/features/websites/one-click-website/)
-   [Showing Schedule](https://aeroidx.com/features/websites/showing-schedule/)
-   [Single Property Websites](https://aeroidx.com/features/websites/single-property-websites/)
-   [Themed Widget Skins](https://aeroidx.com/features/websites/themed-widget-skins/)
-   [Visual Widget Builder](https://aeroidx.com/features/websites/visual-widget-builder/)

Teams 6

-   [Agency Dashboard](https://aeroidx.com/features/teams/agency-dashboard/)
-   [Embedded Dashboard](https://aeroidx.com/features/teams/embedded-dashboard/)
-   [Per-Agent Custom Websites](https://aeroidx.com/features/teams/per-agent-websites/)
-   [Roster Management](https://aeroidx.com/features/teams/roster-management/)
-   [Roster-to-GHL Sub-Account Mapping](https://aeroidx.com/features/teams/roster-ghl-mapping/)
-   [Sub-Account Management & Impersonation](https://aeroidx.com/features/teams/sub-accounts-impersonation/)

Developers & API 4

-   [API Key Management](https://aeroidx.com/features/developers/api-keys/)
-   [MCP Server](https://aeroidx.com/features/developers/mcp-server/)
-   [REST API v1](https://aeroidx.com/features/developers/rest-api/)
-   [Webhooks](https://aeroidx.com/features/developers/webhooks/)

[Home](https://aeroidx.com/)  [Features](https://aeroidx.com/features/)  [Developers](https://aeroidx.com/features/all/#developers)  REST API v1

# REST API v1

Build anything on top of your IDX data

A stable REST API gives your engineering team and integration partners direct access to contacts, saved searches, account info, and live property data.

[Schedule Demo](https://aeroidx.com/schedule/) [All features](https://aeroidx.com/features/all/)

## What it does

The AeroIDX REST API is the connection point for everything your team wants to build around AeroIDX. Sync leads into a custom CRM, create contacts from a third-party form, attach a saved search to a buyer's record, or query live MLS listings from a partner app, all from one well-documented surface. Integration partners use it to make AeroIDX a first-class citizen in whatever stack the brokerage already runs.

## Key capabilities

-   List, show, create, and update contacts
-   Create a saved search and attach it to a contact
-   Read account info: user details and MLS board configuration
-   Search live properties by price, bedrooms, bathrooms, city, and type
-   API-key authentication with per-key permissions and optional expiry
-   Agent endpoints that surface the same MCP tools and AI coaching to custom interfaces

## Good to know

-   API v1 is scoped to a single AeroIDX account; there is no cross-account querying
-   The `permissions` array on API keys is stored, but enforcement granularity depends on the middleware version in use, so verify with the integration guide
-   A v2 prefix exists in the router but all v2 routes are currently commented out

## Why teams choose this

1.  An integration partner can sync AeroIDX leads into any CRM in an afternoon

2.  External tools can attach property-alert subscriptions to a lead without touching the AeroIDX UI

3.  Pagination scales to brokerages with thousands of contacts, so an import won't hit rate-limit surprises midway

4.  A read-only key can pull data into an analytics tool without ever being able to write


### Built for

Primary

Developer or integration partner building on top of AeroIDX

Secondary

IT admin or brokerage technical lead automating lead data flows

## Related features

[

API Key Management

Create and manage the keys that authenticate every v1 request

](https://aeroidx.com/features/developers/api-keys/)[

MCP Server

AI-native interface built on top of the same underlying data layer as the REST API

](https://aeroidx.com/features/developers/mcp-server/)[

Webhooks

Receive push notifications for events rather than polling the API

](https://aeroidx.com/features/developers/webhooks/)
