This documentation is under development.
Authorization: Bearer ********************
{
"id": 0,
"name": "Property Title",
"username": "propertyname1",
"slug": "propertyslug1",
"external_url": "https://example.com/properties/123-mainstreet",
"status": "draft",
"property_types": [
"office"
],
"transaction_types": [
"lease"
],
"currency": "USD",
"image": {
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption",
"filepath": "string"
},
"location": {
"address": "Main str. 1",
"state": "New Jersey",
"city": "Atlantic City",
"zip": "1234",
"country": "US",
"coordinates": {
"lat": 28.453547,
"lng": -80.554963
}
},
"submarket": "string",
"sale_price": 10000,
"cap_rate": 2.5,
"units_no": 0,
"year_built": "string",
"surface": 2300,
"surface_unit": "sqft",
"land_surface": 4.6,
"land_surface_unit": "sqft",
"hide_price": true,
"hide_price_text": "string",
"exclude_price_search": true,
"modules": {
"header": {
"login_button_label": "Document Portal",
"show_login_button": true,
"logo_image": {
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption",
"filepath": "string"
},
"logo_inverted_image": {
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption",
"filepath": "string"
},
"logo_link_url": "string",
"logo_link_attr": "new_tab",
"logo_style": "default",
"layout": "white-opaque-normal"
},
"hero": {
"title": "Intellicenter",
"sub_title": "Your Next Office Awaits: Lease a Class A Space Today",
"layout": "bottom-overlay",
"callout": "Limited Time Offer!",
"cta_label": "Request A Callback",
"cta_action": "modal",
"cta_url": "https://example.com/path",
"image": {
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption",
"filepath": "string"
}
},
"overview": {
"slug": "overview",
"title": "Building Overview",
"sub_title": "Summary",
"layout": "normal",
"description": "Multiline property description here.",
"order": "1"
},
"highlights": {
"slug": "highlights",
"title": "string",
"sub_title": "Highlights",
"items": [
{
"key": "Renovated",
"value": "2020"
}
]
},
"amenities": {
"slug": "amenities",
"sub_title": "Amenities",
"items": [
"Ample parking: Say goodbye to the stress of finding parking with the large, on-site parking lot available to tenants and guests."
]
},
"availabilities": {
"slug": "availabilities",
"title": "Availabilities",
"layout": "cards",
"order": "2",
"description": "Available units for lease",
"items": [
{
"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": 0,
"file": {
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption",
"filepath": "string"
}
}
]
},
"location": {
"slug": "location",
"title": "Location",
"order": "4",
"map_zoom": "15",
"map_center": {
"lat": 28.453547,
"lng": -80.554963
},
"pois": [
{
"lat": 28.453547,
"lng": -80.554963,
"address": "200 S College St, Charlotte, NC 28202",
"name": "Dunkin Donuts",
"category": "string"
}
],
"poi_categories": [
{
"id": "string",
"color": "red",
"label": "Building"
}
]
},
"team": {
"slug": "string",
"title": "string",
"intro": "string",
"layout": "cards",
"members": [
{
"id": 0,
"email": "john.doe@email.com",
"first_name": "John",
"last_name": "Doe",
"title": "Broker",
"phone": "123445678",
"phone_2": "string",
"company": "Lease Inc.",
"location": "New Jersey",
"order": "string",
"image": {
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption",
"filepath": "string"
},
"url": "http://example.com"
}
],
"order": 0
},
"gallery": {
"title": "Gallery",
"slug": "gallery",
"layout": "masonry",
"items": [
{
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption",
"filepath": "string"
}
],
"order": 5
},
"tenants": {
"slug": "string",
"title": "string",
"items": [
{
"filename": "filename-01.jpg",
"description": "File description / Image caption",
"filepath": "string",
"address": "string",
"name": "string",
"url": "http://example.com"
}
],
"order": 0
},
"downloads": {
"slug": "files",
"title": "Downloads",
"layout": "cards",
"items": [
{
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption",
"filepath": "string",
"name": "Property Brochure"
}
],
"order": 8
},
"virtualtour": {
"slug": "string",
"title": "string",
"sub_title": "string",
"layout": "inline",
"description": "string",
"embed_code": "string",
"image": {
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption",
"filepath": "string"
}
},
"contact": {
"slug": "string",
"title": "Contact",
"layout": "black-center",
"intro": "For more information, please use the form below:",
"order": 0,
"leads_email": "info@yourcompany.com",
"address": "South Alston Avenue, Suite 210 \\n Durham, NC 27713",
"phone": "1234567",
"fax": "string",
"logo_image": {
"url": "https://example.com/path/to/filename-01.jpg",
"filename": "filename-01.jpg",
"description": "File description / Image caption",
"filepath": "string"
},
"logo_url": "string"
}
},
"settings": {
"template": "sharplaunch_1",
"color": "231b4e",
"meta_title": "Sample Meta Title",
"meta_description": "Sample Meta Description",
"ganalytics_id": "string",
"locales": {
"languages": [
"en-US"
],
"default_language": "en-US"
}
},
"created_at": "2024-07-10 10:28:39",
"updated_at": "2024-07-10 10:28:39"
}