Propertys

Get a property by its immutable embed reference

Return one visible property without relying on its mutable URL slug.

get/properties/by-embed-ref/{embed_ref}

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/properties/by-embed-ref/{embed_ref}
  • Auth: none declared

Path parameters

embed_refstring uuid required

Query parameters

country'AU' | 'NZ'

ISO country code used to scope public property inventory.

Headers

API-Version'1'

Major API version. Omit or send 1 for the current v1 surface. Retired operations use RFC 9745 Deprecation and RFC 8594 Sunset headers.

Response

Successful Response

msgstring required

Changes

No recorded changes to this operation across all 1 revision of this API.