API ReferenceUnits

List Units

List all units

Path parameters

propertyIdstringRequired
The id of the property

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.
sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of units
amenitieslist of objects or null
applicationslist of objects or null
attachmentslist of objects or null
buildingobject or null
buildingIdstring or nullformat: "uuid"
claimslist of objects or null
createdAtdatetime or null
currentHouseholdobject or null
currentHouseholdIdstring or nullformat: "uuid"
deletedAtdatetime or null
floorLevelstring or null
floorPlanIdstring or nullformat: "uuid"
floorplanobject or null
householdslist of objects or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
isADAboolean or null
lastMoveOutobject or null
lastMoveOutIdstring or nullformat: "uuid"
lastVacancyStartDatestring or nullformat: "date"
Date when the unit last became vacant
leaseslist of objects or null
makeReadyDatestring or nullformat: "date"
Expected make ready date for the unit
mostRecentApplicationobject or null
mostRecentApplicationIdstring or nullformat: "uuid"
ID of the most recent application for this unit
moveInslist of objects or null
moveOutslist of objects or null
numberstring or null
organizationIdstring or nullformat: "uuid"
priorLeaseobject or null
priorLeaseIdstring or nullformat: "uuid"
propertyobject or null
propertyIdstring or nullformat: "uuid"
readableIdstring or null
renewalOfferslist of objects or null
reportConfigurationValueenum or null
Value of the report configuration for the unit
Allowed values:
reportOrderdouble or null
statusenum or null
turnslist of objects or null
unitEventBaseslist of any or null
unitStatusChangeslist of objects or null
updatedAtdatetime or null
vacantSincedatetime or null