Sign in

v6

OpenAPI 3.1.02026-08-0331136162.2 KB
Property

Get Unit

Get a unit by ID and lease term

get/v1/property/{property_id}/units/{unit_id}

Path parameters

property_idstring required
unit_idstring required

Query parameters

lease_terminteger
move_in_datestring date
include_priceboolean
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