---
title: "Get a property by its immutable embed reference"
method: GET
path: "/properties/by-embed-ref/{embed_ref}"
tags: ["Propertys"]
---

# Get a property by its immutable embed reference

`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

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

## Path parameters

- `embed_ref` string, uuid, required

## Query parameters

- `country` 'AU' | 'NZ': ISO country code used to scope public property inventory.

## Headers

- `API-Version` '1'

## Response `200`

Successful Response

- SuccessPayload
  - `msg` string, required
  - `data` union
    - object
    - unknown[]
      - unknown
    - string

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/totalparks/apis/total-parks-public-api.md) · [All operations](https://skmtc.dev/totalparks/apis/total-parks-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/totalparks/apis/total-parks-public-api/revisions/dcb4c822e2c6?raw)