Fetch the current canonical property by Placekey

Server URLloading...

GET

/v1/properties/{id}

Send

Authorization

Path

Returns one merged current property view addressed by its identifier. It does not return listing history. Property identity on this platform is the property's Placekey, so {id} is the Placekey of the record you want (for example 223-227@5vg-82n-pgk). Use /reso/odata/Property?placekey={placekey} when you need every entitled listing associated with that property, including historical, active, sale, lease, and multi-MLS records.

The response is filtered by your signed entitlement bundle. The bundle's predicate is pushed into the canonical ClickHouse query and then re-evaluated in process before any field is returned; meta.entitlement_version stamps the exact bundle version that filtered the response, so two responses carrying the same value were filtered identically.

Field-level redaction is expressed as absence: attributes you are not entitled to see are omitted from data.attributes entirely rather than returned as null. A null you do receive is therefore a real value from the canonical record, not a hidden one.

Access is scoped to your entitlement: a property outside your scope returns 404 not_found rather than revealing that the record exists. If the platform cannot prove the response would be filtered correctly — for example, the SQL pushdown and the in-process predicate disagree — the request fails closed with 503 service_unavailable rather than returning unverified data; retry with backoff.

Path Parameters

Response Body

curl -X GET "https://example.com/v1/properties/string"

{  "data": {    "id": "223-227@5vg-82n-pgk",    "domain": "listing",    "version": "01J8F3ZK9Q7W2C4E6G8H0M1N3P",    "attributes": {      "state": "CA",      "zip": "90012",      "status": "Active",      "list_price": 1295000,      "bedrooms": 3,      "bathrooms": 2,      "living_area_sqft": 1840,      "mls_id": "example-mls",      "osn": "ExampleMLS"    }  },  "meta": {    "entitlement_version": 7  }}

{  "error": "string"}

{  "error": "string"}

{  "error": "string"}