Docs
Sites APIBootstrap

Renderable paths

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

GET/api/sites/v1/paths

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.

Authorization

websiteToken
AuthorizationBearer <token>

A Sanctum token scoped to one website.

In: header

Query Parameters

type?string

Limit to one or more types, comma-separated: property, floor_plan, unit, entry. An unknown type is a 422.

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/paths"
{  "data": [    {      "path": "string",      "type": "property",      "slug": "string",      "property_slug": "string",      "content_type": "string",      "updated_at": "string"    }  ],  "meta": {    "pagination": {      "total": 0,      "page": 0,      "per_page": 0,      "last_page": 0    },    "cache": {      "tags": [        "string"      ],      "ttl": 0    }  }}

Site manifest GET

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.

Resolve a path GET

What serves this path: a content entry, a property, a floor plan, a unit, a redirect, or nothing (404 with `type: not_found`). Checked in that order, so a path something occupies always wins over a redirect.