Site manifest
Everything site-wide a build needs in one call: domains, tracking, redirects, URL patterns and a card per property (at most 500; `meta.properties` counts them). Tags: `site`, plus `property:{id}` and `inventory:{id}` for each property.
/api/sites/v1/siteEverything site-wide a build needs in one call: domains, tracking, redirects, URL patterns and a card per property (at most 500; meta.properties counts them). Tags: site, plus property:{id} and inventory:{id} for each property.
Authorization
websiteToken A Sanctum token scoped to one website.
In: header
Header Parameters
Website id. Overrides Host resolution for builds running where Host is meaningless. The token must still be scoped to this website.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/sites/v1/site"{ "data": { "website": { "id": "string", "name": "string", "type": "property", "platform": "nextjs", "status": "string", "locale": "string", "environment": "production" }, "domains": [ { "hostname": "string", "is_primary": true, "managed_by": "string" } ], "tracking": {}, "redirects": [ { "from": "string", "to": "string", "status": 0 } ], "routing": { "patterns": { "property": "string", "property_archive": "string", "floor_plan": "string", "floor_plan_archive": "string", "unit": "string", "unit_archive": "string" }, "uniform": true }, "properties": [ { "id": "string", "slug": "string", "name": "string", "path": "string", "address": { "street": "string", "street_2": "string", "city": "string", "county": "string", "state": "string", "postal_code": "string", "country": "string", "formatted": "string" }, "location": { "lat": 0, "lng": 0 }, "timezone": "string", "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] }, "phone": "string", "rating": { "average": 0, "count": 0 }, "tags": [ "string" ], "units_count": 0, "available_units_count": 0, "floor_plans_count": 0, "rent": { "min": 0, "max": 0, "base_min": 0, "base_max": 0 }, "pricing_display": { "mode": "string", "hidden_price_label": "string", "no_availability_price_label": "string", "no_price_label": "string", "total_price_label": "string" } } ], "theme": { "tokens": {} }, "search": { "app_id": "string", "search_key": "string", "indices": { "properties": "string", "units": "string" } } }, "meta": { "properties": { "total": 0, "listed": 0 }, "cache": { "tags": [ "string" ], "ttl": 0 } }}Sites API reference
Every Sites endpoint, generated from the OpenAPI document at /openapi/sites.json.
Renderable paths GET
Every path the website renders, with `updated_at`, for static generation and sitemaps. Listed in a fixed order: properties, floor plans, units, entries. Grouped floor plans are listed once, under their primary. Tag: `paths`.