Docs
Sites APIInventory

Availability feed

The part of a unit that moves: availability, date and price. Cache the heavy unit and floor-plan payloads for long, and re-read this often. Join on `id` or `slug`. `meta.cache.ttl` is 60. Tags: `inventory:{property_id}`.

GET/api/sites/v1/availability

The part of a unit that moves: availability, date and price. Cache the heavy unit and floor-plan payloads for long, and re-read this often. Join on id or slug. meta.cache.ttl is 60. Tags: inventory:{property_id}.

Authorization

websiteToken
AuthorizationBearer <token>

A Sanctum token scoped to one website.

In: header

Query Parameters

property?string

A property slug on this website. Unknown slug is a 404.

available?boolean
page?integer
Range1 <= value
Default1
per_page?integer
Range1 <= value <= 2000
Default500

Header Parameters

X-Resi-Website?string

Website id. Overrides Host resolution for builds running where Host is meaningless. The token must still be scoped to this website.

If-None-Match?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/sites/v1/availability"
{  "data": [    {      "id": "string",      "slug": "string",      "property_id": "string",      "floor_plan_id": "string",      "is_available": true,      "available_on": "string",      "rent": {        "min": 0,        "max": 0,        "base_min": 0,        "base_max": 0      },      "updated_at": "string"    }  ],  "meta": {    "pagination": {      "total": 0,      "page": 0,      "per_page": 0,      "last_page": 0    },    "cache": {      "tags": [        "string"      ],      "ttl": 0    }  }}

Unit price matrix GET

Rent by move-in date and lease term, from stored data only. This endpoint never calls the property's management system; a unit with no stored matrix returns an empty list. Empty too when the property's pricing display settings hide the price. At most 120 rows. Rate limited more tightly than other reads. Tag: `inventory:{property_id}`.

Unit types GET

Studio, one bedroom, two bedroom and so on, with counts and bounds, across the website's properties or one. Tags: `inventory:{property_id}`.