Docs
Sites APIInventory

Unit types

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

GET/api/sites/v1/unit-types

Studio, one bedroom, two bedroom and so on, with counts and bounds, across the website's properties or one. 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.

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

curl -X GET "https://example.com/api/sites/v1/unit-types"
{  "data": [    {      "slug": "string",      "name": "string",      "bedrooms": 0,      "units_count": 0,      "available_units_count": 0,      "rent": {        "min": 0,        "max": 0,        "base_min": 0,        "base_max": 0      },      "sqft": {        "min": 0,        "max": 0      },      "fees": {        "monthly_total": 0,        "monthly_total_max": 0      }    }  ],  "meta": {    "cache": {      "tags": [        "string"      ],      "ttl": 0    }  }}

Availability feed GET

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}`.

Search facets GET

What a search UI's filters can offer, with counts. The values are exactly what the `beds`, `baths`, `city` and `state` filters accept. Tags: `site`, `inventory:{property_id}`.