Docs
Sites APIProperties

Neighborhood

The places around a property, with the account's categories. At most `limit` places. Tag: `property:{id}`.

GET/api/sites/v1/properties/{property}/neighborhood

The places around a property, with the account's categories. At most limit places. Tag: property:{id}.

Authorization

websiteToken
AuthorizationBearer <token>

A Sanctum token scoped to one website.

In: header

Path Parameters

property*string

The property's slug. UUIDs are not accepted.

Query Parameters

limit?integer

How many places to return, by name. A property can hold far more than a map shows at once.

Range1 <= value <= 500
Default100

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/properties/string/neighborhood"
{  "data": {    "origin": {      "name": "string",      "address": "string",      "location": {        "lat": 0,        "lng": 0      }    },    "categories": [      {        "id": "string",        "label": "string",        "color": "string",        "types": [          "string"        ],        "in_use": true      }    ],    "places": [      {        "id": "string",        "name": "string",        "address": "string",        "location": {          "lat": 0,          "lng": 0        },        "category_id": "string",        "category": "string",        "color": "string",        "rating": 0,        "website": "string",        "google_maps_url": "string",        "place_id": "string",        "tags": [          "string"        ],        "images": [          {            "id": "string",            "url": "string",            "thumb_url": "string",            "title": "string",            "caption": "string",            "alt_text": "string",            "tags": [              "string"            ]          }        ],        "travel_times": {          "drive": "string",          "walk": "string",          "bike": "string",          "transit": "string"        }      }    ]  },  "meta": {    "places": {      "total": 0,      "listed": 0    },    "cache": {      "tags": [        "string"      ],      "ttl": 0    }  }}

One property GET

A property with the sections its page renders, named in `include`, in one call. Every includable key is always present and is null when not requested, so the shape never depends on the query string. `has` says which sections hold anything. Tags: `property:{id}`, `inventory:{id}`.

Reviews GET

Published reviews, newest first. `meta.rating` carries the property's overall average and count. Sort keys: `date`, `rating`. Tag: `property:{id}`.