Sign in

v7

latestOpenAPI 3.1.02026-08-0431138164.3 KB
Property

Property Units

get/v1/property/{property_id}/units

Path parameters

property_idstring required

Query parameters

include_priceboolean
floorplan_namestring
num_bedroomsinteger
num_bedrooms_list[]integer[]
move_in_date_earlieststring date
move_in_date_lateststring date
lease_term_mininteger
lease_term_maxinteger
unit_idstring
only_availableboolean
include_affordableboolean

Response

Successful Response

idstring required
unit_numberstring required
number_of_bedroomsinteger required
number_of_bathroomsnumber required
square_footageinteger
floorinteger
floorplan_namestring
floorplan_urlstring
availability_stagestring required
virtual_tour_linkstring
date_availablestring date
application_availability_statusstring
market_rate_unitinteger
rentinteger
amenitiesstring[]
sub_building_namestring