Read Unit
Info for a specific unit
Authentication
x-api-keystring
API Key authentication via header
Path parameters
propertyId
The id of the property
unitId
The id of the unit
Response
Expected response to a valid request
number
floorLevel
isADA
streetAddress1
Primary street address line for the unit (e.g. street number and name)
streetAddress2
Secondary street address line for the unit (e.g. apartment, suite, or building number)
city
City in which the unit is located
state
State or province in which the unit is located
zipCode
Postal / ZIP code for the unit
fullAddress
Human-readable address composed from the individual address components (street lines, city, and state/zip), joined with commas. Blank components are omitted. Null when the unit has no address information.
status
isOccupied
Whether the unit counts as occupied per Fortress occupancy logic (UnitStatus cannot move-in and is not Down). Matches the Portfolio Summary occupied-units calculation.
floorPlanId
propertyId
organizationId
buildingId
currentHouseholdId
lastMoveOutId
priorLeaseId
id
readableId
idempotencyId
createdAt
updatedAt
deletedAt
vacantSince
reportOrder
makeReadyDate
Expected make ready date for the unit
reportConfigurationValue
Value of the report configuration for the unit
Allowed values:
lastVacancyStartDate
Date when the unit last became vacant
mostRecentApplicationId
ID of the most recent application for this unit
floorplan
property
building
attachments
households
leases
amenities
applications
moveIns
moveOuts
currentHousehold
lastMoveOut
priorLease
mostRecentApplication
renewalOffers
turns
unitEventBases
unitStatusChanges