Docs
Sites APIInventory

Search facets

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

GET/api/sites/v1/facets

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

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/facets"
{  "data": {    "properties_count": 0,    "units_count": 0,    "available_units_count": 0,    "rent": {      "min": 0,      "max": 0,      "base_min": 0,      "base_max": 0    },    "sqft": {      "min": 0,      "max": 0    },    "bedrooms": [      {        "value": 0,        "units_count": 0,        "available_units_count": 0      }    ],    "bathrooms": [      {        "value": 0,        "units_count": 0,        "available_units_count": 0      }    ],    "cities": [      {        "value": "string",        "state": "string",        "properties_count": 0      }    ],    "states": [      {        "value": "string",        "properties_count": 0      }    ]  },  "meta": {    "cache": {      "tags": [        "string"      ],      "ttl": 0    }  }}

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

Lead sources for every property GET

One block per property on the website, so a centralized site builds from one call. A property's lead sources, tracking phone numbers and emails, and the rules a site evaluates in the browser to pick a source for a visit. Tag: `lead-sources:{property_id}`.