propertyIdstringrequired
Example:prop_8f2c1a
Retrieve a property
get
Path Parameters
Response
application/json
Response
application/json
Property
Property
typestringrequired
Allowed values:apartmenthouselandcommercialparking
Example:apartment
titlestringrequired
<= 120 characters
Example:3-Bedroom Period Home near Riverside Park
descriptionstring
Example:Well-maintained period apartment on the second floor with two south-facing balconies.
addressobjectrequired
Show Child Parameters
living_area_sqmnumber(float)
Example:86.5
lot_size_sqmnumber(float)
Example:412
roomsnumber(float)
Example:3
year_builtinteger
Example:1908
floorinteger
Example:2
purchase_price_eurinteger
Example:645000
cold_rent_eurinteger
Example:1450
service_charges_eurinteger
Example:280
available_fromstring(date)
Example:2026-11-01
energy_certificateobject
Figures needed to publish a listing.
Show Child Parameters
commissionobject
Show Child Parameters
idstring
Example:prop_8f2c1a
statusstring
Allowed values:draftactivereservedsoldrentedarchived
Example:active
media_countinteger
Example:14
created_atstring(date-time)
Example:2026-08-14T08:12:44Z
updated_atstring(date-time)
Example:2026-08-20T09:38:02Z
get/properties/{propertyId}
Authentication
Path Parameters
application/json
Update a property
Updates individual fields. Listings already generated remain unchanged.
patch
Path Parameters
propertyIdstringrequired
Example:prop_8f2c1a
Body
application/json
Body
application/json
PropertyInput
typestringrequired
Allowed values:apartmenthouselandcommercialparking
Example:apartment
titlestringrequired
<= 120 characters
Example:3-Bedroom Period Home near Riverside Park
descriptionstring
Example:Well-maintained period apartment on the second floor with two south-facing balconies.
addressobjectrequired
Show Child Parameters
living_area_sqmnumber(float)
Example:86.5
lot_size_sqmnumber(float)
Example:412
roomsnumber(float)
Example:3
year_builtinteger
Example:1908
floorinteger
Example:2
purchase_price_eurinteger
Example:645000
cold_rent_eurinteger
Example:1450
service_charges_eurinteger
Example:280
available_fromstring(date)
Example:2026-11-01
energy_certificateobject
Figures needed to publish a listing.
Show Child Parameters
commissionobject
Show Child Parameters
Response
application/json
Response
application/json
Updated
Property
typestringrequired
Allowed values:apartmenthouselandcommercialparking
Example:apartment
titlestringrequired
<= 120 characters
Example:3-Bedroom Period Home near Riverside Park
descriptionstring
Example:Well-maintained period apartment on the second floor with two south-facing balconies.
addressobjectrequired
Show Child Parameters
living_area_sqmnumber(float)
Example:86.5
lot_size_sqmnumber(float)
Example:412
roomsnumber(float)
Example:3
year_builtinteger
Example:1908
floorinteger
Example:2
purchase_price_eurinteger
Example:645000
cold_rent_eurinteger
Example:1450
service_charges_eurinteger
Example:280
available_fromstring(date)
Example:2026-11-01
energy_certificateobject
Figures needed to publish a listing.
Show Child Parameters
commissionobject
Show Child Parameters
idstring
Example:prop_8f2c1a
statusstring
Allowed values:draftactivereservedsoldrentedarchived
Example:active
media_countinteger
Example:14
created_atstring(date-time)
Example:2026-08-14T08:12:44Z
updated_atstring(date-time)
Example:2026-08-20T09:38:02Z
patch/properties/{propertyId}
Authentication
Path Parameters
Body
{
"purchase_price_eur": 629000
}
application/json
Archive a property
Takes the property off the market. The record remains readable.
delete
Path Parameters
propertyIdstringrequired
Example:prop_8f2c1a
Response
Response
Archived
delete/properties/{propertyId}
Authentication
Path Parameters
Media
List a property's media
get
Path Parameters
propertyIdstringrequired
Example:prop_8f2c1a
Response
200 application/json
Response
200 application/json
Media list
dataarray[object]
Show Child Parameters
get/properties/{propertyId}/media
Authentication
Path Parameters
200 application/json