---
title: "Get Properties Json"
method: GET
path: "/properties/json"
tags: ["Propertys"]
---

# Get Properties Json

`GET /properties/json`

## Request

- Base URL: `http://localhost:8000`
- URL: `http://localhost:8000/properties/json`
- Auth: none declared

Get a geojson FeatureCollection of all properties.

Note: Hidden properties are excluded from this endpoint.

Caching: this dataset only changes when an admin edits a property,
so we cache the encoded payload in Redis for an hour and advertise
the same TTL to shared caches (Cloudflare). Browsers get a shorter
`max-age` so a stale tab heals quickly without a full reload.

## Query parameters

- `expanded` boolean, nullable
- `include_capabilities` boolean, nullable
- `country` 'AU' | 'NZ': ISO country code used to scope public property inventory.

## Headers

- `API-Version` '1'

## Response `200`

Successful Response

- PropertyList: PropertyList is a Pydantic model that represents the schema for a list of properties.
  - `root` Property[], required
    - `id` integer, required
    - `name` string, required
    - `type` integer, required
    - `slug` string, required
    - `address` string, required
    - `state` string, required
    - `country` 'AU' | 'NZ'
    - `region` string, nullable
    - `lat` number, required
    - `lon` number, required
    - `desc` string, nullable, required
    - `pms` string, nullable, required
    - `pms_config` PropertyPMSConfig, required
      - `type` string, required
      - `endpoint` string, required
      - `newbook` NewbookConfig
        - `username` string, nullable, required
        - `password` string, nullable, required
        - `instance_token` string, required
      - `rms` RMSConfig
        - `client_id` string, required
        - `client_password` string, required
    - `website` string, uri, nullable, required
    - `email` string, email, nullable, required
    - `phone_free` string, nullable, required
    - `phone_alt` string, nullable, required
    - `features` integer[], nullable
    - `managements` integer[], nullable
    - `highlights` string[], nullable
    - `images` PropertyImage[], nullable
      - `description` string, nullable, required
      - `url` string, uri, required
    - `status` string, nullable, required
    - `visibility` string
    - `booking_enabled` boolean
    - `register_date` string, date-time, nullable, required
    - `updated_at` string, date-time, nullable

## 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)
