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
applicationslist of objects
attachmentslist of objects
buildingobject
buildingIdstringformat: "uuid"
claimslist of objects
createdAtdatetime
currentHouseholdobject
currentHouseholdIdstringformat: "uuid"
deletedAtdatetime
floorLevelstring
floorPlanIdstringformat: "uuid"
floorplanobject
householdslist of objects
idstringformat: "uuid"
idempotencyIdstringformat: "uuid"
isADAboolean
lastMoveOutobject
lastMoveOutIdstringformat: "uuid"
lastVacancyStartDatestringformat: "date"
Date when the unit last became vacant
leaseslist of objects
makeReadyDatestringformat: "date"
Expected make ready date for the unit
mostRecentApplicationobject
mostRecentApplicationIdstringformat: "uuid"
ID of the most recent application for this unit
moveInslist of objects
moveOutslist of objects
numberstring
organizationIdstringformat: "uuid"
priorLeaseobject
priorLeaseIdstringformat: "uuid"
propertyobject
propertyIdstringformat: "uuid"
readableIdstring
renewalOfferslist of objects
reportConfigurationValueenum
Value of the report configuration for the unit
Allowed values:
reportOrderdouble
statusenum
turnslist of objects
unitEventBaseslist of any
unitStatusChangeslist of objects
updatedAtdatetime
vacantSincedatetime