Docs
Sites APIBootstrap

Resolve a path

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.

GET/api/sites/v1/resolve

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.

Authorization

websiteToken
AuthorizationBearer <token>

A Sanctum token scoped to one website.

In: header

Query Parameters

path*string

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/resolve?path=string"
{  "data": {    "type": "entry",    "path": "string",    "entry": {      "id": "string",      "slug": "string",      "path": "string",      "status": "string",      "content_type": "string",      "property_id": "string",      "data": {},      "seo": {},      "terms": [        {          "id": "string",          "slug": "string",          "label": "string",          "taxonomy": "string"        }      ],      "schema": {},      "published_at": "string",      "expires_at": "string",      "updated_at": "string"    }  },  "meta": {    "cache": {      "tags": [        "string"      ],      "ttl": 0    }  }}

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

Group sets GET

Account-wide group sets plus those belonging to the website's own properties. Group ids are what the `group` filter accepts. Tag: `site`.