V1 APIInventory
List units
Every unit on the property, denormalized with building and floor-plan context and a per-fee pricing breakdown. Filter before display: a unit is publicly marketable only when `unitAvailable` is true and `unitModel` and `unitGuestSuite` are false.
GET
/api/v1/property/{property}/unitsEvery unit on the property, denormalized with building and floor-plan context and a per-fee pricing breakdown.
Filter before display: a unit is publicly marketable only when unitAvailable is true and unitModel and unitGuestSuite are false.
Path Parameters
property*string
Property UUID. This route is unauthenticated and unscoped, so it does not accept a slug — to address a property by slug, use /api/v1/connection/{connection}/property/{property}.
Format
uuidQuery Parameters
group?string
Group UUID. Matching includes descendants of the selected group.
Format
uuidResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/property/019dbc38-d49e-7310-95d4-711a5b7a4b40/units"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "slug": "string", "permalink": "string", "unitNumber": "string", "unitFloor": "string", "unitInteriorSquareFeet": 0, "unitExteriorSquareFeet": 0, "unitBedrooms": 0, "unitBathrooms": 0, "unitHandicapAccessible": true, "unitFurnished": true, "unitAffordability": true, "unitModel": true, "unitGuestSuite": true, "unitFeatures": "string", "unitViewDirection": "string", "unitViewImage": "string", "unitAvailable": true, "unitAvailableDate": "2019-08-24T14:15:22Z", "unitPrice": 0, "unitMinBaseRent": 0, "unitMaxBaseRent": 0, "unitMinTmlp": 0, "unitMaxTmlp": 0, "unitFees": [ { "fee_id": "6a6e29c0-8cb8-4e1c-8beb-6b16e737bdd5", "code": "string", "name": "string", "description": "string", "class": "string", "calculated_amount": 0, "is_variable": true, "currency": "USD", "frequency": "string", "requirement": "string" } ], "unitFeeTotal": 0, "unitFeeTotalMax": 0, "unitDeposit": 0, "unitPmsId": "string", "unitExternalIds": { "property1": "string", "property2": "string" }, "unitSpecials": "string", "unitAmenities": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "is_property_marketable": true, "code": "string", "description": "string", "type": "string", "tags": [ "string" ], "tags_string": "string", "reference_id": "string", "images": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "thumb_url": "http://example.com", "full_url": "http://example.com", "caption": "string", "alt_text": "string", "tags": [ "string" ], "tags_string": "string", "reference_url": "http://example.com", "title": "string" } ], "virtual_tours": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "provider": "string", "url": "http://example.com", "title": "string", "settings": {}, "image": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "thumb_url": "http://example.com", "full_url": "http://example.com", "caption": "string", "alt_text": "string", "tags": [ "string" ], "tags_string": "string", "reference_url": "http://example.com", "title": "string" }, "tags": [ "string" ], "tags_string": "string" } ], "videos": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "provider": "string", "url": "http://example.com", "title": "string", "settings": {}, "image": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "thumb_url": "http://example.com", "full_url": "http://example.com", "caption": "string", "alt_text": "string", "tags": [ "string" ], "tags_string": "string", "reference_url": "http://example.com", "title": "string" }, "tags": [ "string" ], "tags_string": "string" } ] } ], "unitPdf": "http://example.com", "unitTags": [ "string" ], "unitTagsString": "string", "unitPhotos": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "thumb_url": "http://example.com", "full_url": "http://example.com", "caption": "string", "alt_text": "string", "tags": [ "string" ], "tags_string": "string", "reference_url": "http://example.com", "title": "string" } ], "unitVirtualTours": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "provider": "string", "url": "http://example.com", "title": "string", "settings": {}, "image": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "thumb_url": "http://example.com", "full_url": "http://example.com", "caption": "string", "alt_text": "string", "tags": [ "string" ], "tags_string": "string", "reference_url": "http://example.com", "title": "string" }, "tags": [ "string" ], "tags_string": "string" } ], "unitVideos": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "provider": "string", "url": "http://example.com", "title": "string", "settings": {}, "image": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "thumb_url": "http://example.com", "full_url": "http://example.com", "caption": "string", "alt_text": "string", "tags": [ "string" ], "tags_string": "string", "reference_url": "http://example.com", "title": "string" }, "tags": [ "string" ], "tags_string": "string" } ], "unitTourLink": "http://example.com", "unitQuoteLink": "http://example.com", "unitApplicationLink": "http://example.com", "buildingName": "string", "buildingType": "string", "buildingCode": "string", "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7", "buildingNumber": "string", "buildingImage": "http://example.com", "buildingImageFull": "http://example.com", "floorPlanName": "string", "floorPlanType": "string", "floorPlanTypeName": "string", "floorPlanCode": "string", "floorPlanId": "a96e015e-78bc-437d-a5d4-599dcebbafec", "floorPlanImage": "http://example.com", "floorPlanImageFull": "http://example.com", "floorPlanShoeboxImage": "http://example.com", "floorPlanShoeboxFull": "http://example.com", "floorPlanLocationImage": "string", "floorPlanLocationFull": "string", "floorPlanPdf": "http://example.com", "featured": true, "listIds": [ "string" ], "groups": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "label": "string", "slug": "string", "set": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "objectType": "property" } } ], "derivedGroups": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "label": "string", "slug": "string", "set": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "objectType": "property" } } ], "property": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "key": "string", "slug": "string" } } ]}Fee schedule GET
The property's **effective** fee schedule: property-scope assignments with their overrides applied, expired and future windows excluded, every requirement disclosed, and unit-type or floor-plan restrictions carried on each line rather than filtered (there is no unit in context to filter by). Replaced the raw catalog listing this path used to return, which ignored per-property assignment overrides and never checked effective windows.
List floor plans GET
Floor plans with media, pricing rollups, and availability counts across the units that use them.