This documentation is under development.
Authorization: Bearer ********************{
"name": "Property Title",
"username": "propertyname1",
"slug": "string",
"status": "draft",
"property_types": [
"office"
],
"transaction_types": [
"lease"
],
"image": {
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption"
},
"currency": "USD",
"location": {
"address": "Main str. 1",
"state": "New Jersey",
"city": "Atlantic City",
"zip": "1234",
"country": "US",
"coordinates": {
"lat": 28.453547,
"lng": -80.554963
}
},
"availabilities": [
{
"name": "Office Space #12",
"status": "active",
"on_market": true,
"on_market_at": "2025-04-31",
"virtualtour": "https://my.matterport.com/show/?m=XXXXX",
"type": "flex",
"lease_type": "Gross",
"unit_no": "12",
"floor_no": "2",
"bedrooms": 3,
"bathrooms": 4,
"surface": 240,
"surface_unit": "sqft",
"rent": 10,
"rent_type": "per_unit_year",
"file": {
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption"
}
}
],
"keyfacts": [
{
"key": "Renovated",
"value": "2020"
}
],
"highlights": [
"string"
],
"gallery": [
{
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption"
}
],
"description": "string",
"submarket": "string",
"sale_price": 10000,
"cap_rate": 2.5,
"units_no": 0,
"year_built": 1800,
"surface": 2300,
"surface_unit": "sqft",
"land_surface": 4.6,
"land_surface_unit": "sqft",
"hide_price": false,
"hide_price_text": "string",
"exclude_price_search": true,
"external_url": "https://example.com/properties/123-mainstreet",
"virtualtours": [
"https://my.matterport.com/show/?m=xxxxxx"
],
"documents": [
{
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption"
}
],
"members": [
0
],
"import_id": "string",
"archived": false
}{
"success": true,
"message": "string",
"id": 0
}