Docs
V1 APIProperty

List amenities

Enabled amenities attached to the property. Non-marketable amenities are also excluded unless the resolved display settings allow them.

GET/api/v1/property/{property}/amenities

Enabled amenities attached to the property. Non-marketable amenities are also excluded unless the resolved display settings allow them.

Path Parameters

property*string

Property UUID. This route is unauthenticated and unscoped, so it does not accept a slug — to address a property by slug, use /api/v1/connection/{connection}/property/{property}.

Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/property/019dbc38-d49e-7310-95d4-711a5b7a4b40/amenities"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "is_property_marketable": true,      "code": "string",      "description": "string",      "type": "string",      "tags": [        "string"      ],      "tags_string": "string",      "reference_id": "string",      "images": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "thumb_url": "http://example.com",          "full_url": "http://example.com",          "caption": "string",          "alt_text": "string",          "tags": [            "string"          ],          "tags_string": "string",          "reference_url": "http://example.com",          "title": "string"        }      ],      "virtual_tours": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "provider": "string",          "url": "http://example.com",          "title": "string",          "settings": {},          "image": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "thumb_url": "http://example.com",            "full_url": "http://example.com",            "caption": "string",            "alt_text": "string",            "tags": [              "string"            ],            "tags_string": "string",            "reference_url": "http://example.com",            "title": "string"          },          "tags": [            "string"          ],          "tags_string": "string"        }      ],      "videos": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "provider": "string",          "url": "http://example.com",          "title": "string",          "settings": {},          "image": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "thumb_url": "http://example.com",            "full_url": "http://example.com",            "caption": "string",            "alt_text": "string",            "tags": [              "string"            ],            "tags_string": "string",            "reference_url": "http://example.com",            "title": "string"          },          "tags": [            "string"          ],          "tags_string": "string"        }      ]    }  ]}

Get a property GET

The property profile a website renders: contact details, urls, tags, media, the street address and coordinates, and the availability and rent rollups.

Fee schedule GET

The property's **effective** fee schedule: property-scope assignments with their overrides applied, expired and future windows excluded, every requirement disclosed, and unit-type or floor-plan restrictions carried on each line rather than filtered (there is no unit in context to filter by). Replaced the raw catalog listing this path used to return, which ignored per-property assignment overrides and never checked effective windows.