Propertys

Get Property By State And Slug

Get a visible property by URL state + slug.

Returns 404 if the property is not found or is hidden from public view.

get/properties/by-location/{state}/{slug}

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/properties/by-location/{state}/{slug}
  • Auth: none declared

Path parameters

statestring required
slugstring required

Query parameters

include_capabilitiesboolean nullable
include_content_enrichmentboolean nullable
include_local_entitiesboolean nullable
include_indicative_summaryboolean nullable
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.