Skip to main content
GET
Get a property

Authorizations

Authorization
string
header
required

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

Path Parameters

propertyId
integer<int64>
required

ID of the property

Response

Property found

title
string
description
string
address
string
city
string
images
string<uri>[]

Array of image URLs, each their own comma-separated string

price_pw
integer

Weekly price as a string to preserve precision

bedrooms
integer
Required range: x >= 0
bathrooms
integer
Required range: x >= 0
postcode
string
lat
number<double> | null
lng
number<double> | null
deposit
integer
default:0

Defaults to 0 if not supplied

propertyId
integer<int64>