Docs
V1 APIConnections

List amenities

Enabled amenities attached to the property. Non-marketable amenities are also excluded unless the resolved display settings allow them. Scoped to the portfolio: `{property}` is a slug resolved against the properties attached to `{connection}`, so a slug outside this portfolio is a `404` rather than another site's property.

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

Enabled amenities attached to the property. Non-marketable amenities are also excluded unless the resolved display settings allow them. Scoped to the portfolio: {property} is a slug resolved against the properties attached to {connection}, so a slug outside this portfolio is a 404 rather than another site's property.

Path Parameters

connection*string

Connection UUID.

Formatuuid
property*string

Property slug, resolved against the properties attached to {connection}. A slug outside that portfolio is a 404. Slug only — a UUID does not resolve here.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/connection/497f6eca-6276-4993-bfeb-53cbbbba6f08/property/1520-gough-street/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"        }      ]    }  ]}