Commercial Listings APIProperty

Get listing

View as Markdown
**Retrieve the current state of a property held by PropertyPal.** Pass your `reference` in the URL and your branch identifier in the `Rightmove-Agent-ID` header. Useful for reconciliation against your own CRM. ### Response - **`200 OK`** — body is `PropertyAction` with the property record under `data`. - **`404 Not Found`** — no live property exists for the supplied (`reference`, branch) pair.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

referencestringRequired

Headers

Rightmove-Agent-IDstringOptional

Response

200 — Found

metaobject
dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
502
Bad Gateway Error
503
Service Unavailable Error