V1 API
V1 API reference
Every V1 endpoint, generated from the OpenAPI document at /openapi/v1.json.
Endpoints
Property
The property profile, its amenities and its fees.
| Endpoint | Summary |
|---|---|
GET /api/v1/property/{property} | Get a property |
GET /api/v1/property/{property}/amenities | List amenities |
GET /api/v1/property/{property}/fees | Fee schedule |
Inventory
Units, floor plans, unit types, buildings, and lease-term pricing.
| Endpoint | Summary |
|---|---|
GET /api/v1/property/{property}/units | List units |
GET /api/v1/property/{property}/floor-plans | List floor plans |
GET /api/v1/property/{property}/unit-types | List unit types |
GET /api/v1/property/{property}/buildings | List buildings |
GET /api/v1/property/{property}/unit/{unit}/price-matrix | Get a unit's lease-term price matrix |
Content
Marketing content: galleries, media, FAQs, reviews, announcements, content blocks, neighborhood.
| Endpoint | Summary |
|---|---|
GET /api/v1/property/{property}/galleries | List galleries |
GET /api/v1/property/{property}/media | Get property media |
GET /api/v1/property/{property}/faqs | List FAQs |
GET /api/v1/property/{property}/reviews | List reviews |
GET /api/v1/property/{property}/announcements | List announcements |
GET /api/v1/property/{property}/content-groups | List content blocks |
GET /api/v1/property/{property}/content-conditionals | Get content conditionals |
GET /api/v1/property/{property}/neighborhood | Get neighborhood |
GET /api/v1/property/{property}/panels | List panels |
GET /api/v1/property/{property}/lists | List lists |
GET /api/v1/property/{property}/instagram | List Instagram posts |
Configuration
Website, widget, group and integration configuration for the property.
| Endpoint | Summary |
|---|---|
GET /api/v1/property/{property}/website | Get website configuration |
GET /api/v1/property/{property}/widget | Get widget configuration |
GET /api/v1/property/{property}/groups | List group sets |
GET /api/v1/property/{property}/integrations | List integrations |
Leads
Form discovery, lead sources, and public lead submission.
| Endpoint | Summary |
|---|---|
GET /api/v1/property/{property}/forms | List forms |
GET /api/v1/property/{property}/lead-sources | List lead sources |
POST /api/v1/leads | Submit a lead |
Tours
Live tour availability and booking, proxied to the property's tour provider.
| Endpoint | Summary |
|---|---|
POST /api/v1/tour/get-availability | Check tour availability |
POST /api/v1/tour/reserve | Reserve a tour |
Analytics
Demand funnel events and traffic-source observations.
| Endpoint | Summary |
|---|---|
POST /api/v1/demand-events | Record a demand event |
POST /api/v1/source-observations | Record a source observation |
Operations
Cache purge.
| Endpoint | Summary |
|---|---|
POST /api/v1/cache/clear | Purge the website cache for a property or portfolio |
Connections
Public delivery endpoints backed by portfolio and merged-property connections.
| Endpoint | Summary |
|---|---|
GET /api/v1/connection/{connection}/parent-property | Get a merged parent property |
GET /api/v1/connection/{connection}/floor-plans | List merged floor plans |
GET /api/v1/connection/{connection}/units | List merged units |
GET /api/v1/connection/{connection}/unit-types | List merged unit types |
GET /api/v1/connection/{connection}/properties | List connection properties |
GET /api/v1/connection/{connection}/property/{property} | Get a property |
GET /api/v1/connection/{connection}/property/{property}/amenities | List amenities |
GET /api/v1/connection/{connection}/property/{property}/fees | Fee schedule |
GET /api/v1/connection/{connection}/property/{property}/floor-plans | List floor plans |
GET /api/v1/connection/{connection}/property/{property}/galleries | List galleries |
GET /api/v1/connection/{connection}/property/{property}/media | Get property media |
GET /api/v1/connection/{connection}/property/{property}/panels | List panels |
GET /api/v1/connection/{connection}/property/{property}/units | List units |
GET /api/v1/connection/{connection}/property/{property}/unit-types | List unit types |
GET /api/v1/connection/{connection}/property/{property}/website | Get website configuration |
GET /api/v1/connection/{connection}/property/{property}/buildings | List buildings |
GET /api/v1/connection/{connection}/property/{property}/faqs | List FAQs |
GET /api/v1/connection/{connection}/property/{property}/reviews | List reviews |
GET /api/v1/connection/{connection}/property/{property}/announcements | List announcements |
GET /api/v1/connection/{connection}/property/{property}/content-groups | List content blocks |
GET /api/v1/connection/{connection}/property/{property}/content-conditionals | Get content conditionals |
GET /api/v1/connection/{connection}/property/{property}/neighborhood | Get neighborhood |
GET /api/v1/connection/{connection}/property/{property}/lists | List lists |
GET /api/v1/connection/{connection}/property/{property}/widget | Get widget configuration |
GET /api/v1/connection/{connection}/property/{property}/groups | List group sets |
GET /api/v1/connection/{connection}/property/{property}/forms | List forms |
GET /api/v1/connection/{connection}/property/{property}/lead-sources | List lead sources |
GET /api/v1/connection/{connection}/property/{property}/integrations | List integrations |
GET /api/v1/connection/{connection}/property/{property}/unit/{unit}/price-matrix | Get a unit's lease-term price matrix |
GET /api/v1/connection/{connection}/property/{property}/instagram | List Instagram posts |
Last updated on
Pricing and fees
Base rent, total monthly leasing price, fee breakdowns, and how a property's pricing display settings shape V1 payloads.
Get a property GET
The property profile a website renders: contact details, urls, tags, media, the street address and coordinates, and the availability and rent rollups.