Sites APIProperties
One property
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}`.
GET
/api/sites/v1/properties/{property}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}.
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
include?string
Comma-separated: amenities, announcements, buildings, content, faqs, fees, galleries, groups, media, office_hours. An unknown value is a 422.
content_keys?string
With include=content: comma-separated block keys to return.
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"{ "data": { "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" }, "description": "string", "contact": { "phones": [ {} ], "emails": [ {} ], "socials": [ {} ] }, "urls": { "website": "string", "resident_portal": "string", "application": "string", "tour_booking": "string" }, "leasing": { "applicant_hold_period_days": 0, "availability_window_days": 0 }, "pet_policy": { "description": "string", "restrictions": "string" }, "pricing": { "hidden_price_label": "string", "no_availability_price_label": "string", "no_price_label": "string", "hide_all_pricing": true, "hide_price_when_no_availability": true, "pricing_display_mode": "BASE_AND_TOTAL", "tmlp_label": "string", "show_fee_breakdown": true, "fee_breakdown_behavior": "EXPANDED", "pricing_disclaimer_text": "string" }, "display": { "prepend_building_number_to_unit_number": true, "show_non_marketable_amenities": true, "hide_available_units": true }, "has": { "amenities": true, "announcements": true, "buildings": true, "content": true, "faqs": true, "galleries": true, "neighborhood": true, "reviews": true, "instagram": true, "floor_plans": true, "available_units": true }, "amenities": [ { "id": "string", "name": "string", "code": "string", "description": "string", "type": "string", "is_marketable": true, "tags": [ "string" ], "images": [ { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } ], "videos": [ { "id": "string", "provider": "string", "url": "string", "title": "string", "settings": {}, "tags": [ "string" ], "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } } ], "virtual_tours": [ { "id": "string", "provider": "string", "url": "string", "title": "string", "settings": {}, "tags": [ "string" ], "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } } ] } ], "announcements": [ { "id": "string", "key": "string", "title": "string", "meta": "string", "text": "string", "disclaimer": "string", "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] }, "links": [ { "url": "string", "text": "string" } ], "starts_at": "string", "ends_at": "string" } ], "buildings": [ { "id": "string", "number": "string", "code": "string", "name": "string", "type": "string", "description": "string", "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] }, "images": [ { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } ], "available_units_count": 0, "tags": [ "string" ], "groups": [ { "id": "string", "label": "string", "slug": "string", "set": { "id": "string", "key": "string", "name": "string", "object_type": "string" } } ] } ], "content": [ { "id": "string", "key": "string", "type": "string", "media_type": "string", "title": "string", "subtitle": "string", "description": "string", "links": [ { "url": "string", "text": "string" } ], "images": [ { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } ], "background_image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] }, "videos": [ { "id": "string", "provider": "string", "url": "string", "title": "string", "settings": {}, "tags": [ "string" ], "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } } ], "virtual_tours": [ { "id": "string", "provider": "string", "url": "string", "title": "string", "settings": {}, "tags": [ "string" ], "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } } ], "items": [ { "id": "string", "media_type": "string", "title": "string", "meta": "string", "text": "string", "links": [ { "url": "string", "text": "string" } ], "images": [ { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } ], "background_image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] }, "videos": [ { "id": "string", "provider": "string", "url": "string", "title": "string", "settings": {}, "tags": [ "string" ], "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } } ], "virtual_tours": [ { "id": "string", "provider": "string", "url": "string", "title": "string", "settings": {}, "tags": [ "string" ], "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } } ] } ] } ], "faqs": [ { "id": "string", "question": "string", "answer": "string", "tags": [ "string" ], "sort_order": 0, "topic": { "id": "string", "title": "string", "description": "string", "sort_order": 0 } } ], "fees": { "lines": [ {} ], "monthly_total": 0, "monthly_total_max": 0, "upfront_total": 0 }, "galleries": [ { "id": "string", "key": "string", "type": "string", "title": "string", "text": "string", "images": [ { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } ], "panoramas": [ { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } ], "videos": [ { "id": "string", "provider": "string", "url": "string", "title": "string", "settings": {}, "tags": [ "string" ], "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } } ], "virtual_tours": [ { "id": "string", "provider": "string", "url": "string", "title": "string", "settings": {}, "tags": [ "string" ], "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } } ] } ], "groups": [ { "id": "string", "label": "string", "slug": "string", "set": { "id": "string", "key": "string", "name": "string", "object_type": "string" } } ], "media": { "property_images": [ { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } ], "images": [ { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } ], "background_image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] }, "videos": [ { "id": "string", "provider": "string", "url": "string", "title": "string", "settings": {}, "tags": [ "string" ], "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } } ], "virtual_tours": [ { "id": "string", "provider": "string", "url": "string", "title": "string", "settings": {}, "tags": [ "string" ], "image": { "id": "string", "url": "string", "thumb_url": "string", "title": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ] } } ] }, "office_hours": { "hours": [ { "day": "string", "time": "string" } ], "display_heading": "string", "disclaimer": "string" } }, "meta": { "includes": [ "string" ], "cache": { "tags": [ "string" ], "ttl": 0 } }}List properties GET
The website's enabled properties as cards, in the website's order unless sorted. The same card the manifest carries. On a property website this is the one property. Sort keys: `name`, `order`. Tags: `site`, plus `property:{id}` and `inventory:{id}` for each property on the page. When a rent filter is used, anything whose price the property's display settings would hide is left out of the results, so a filter can never reveal a hidden price.
Neighborhood GET
The places around a property, with the account's categories. At most `limit` places. Tag: `property:{id}`.