API ReferenceFloor Plans

List Floor Plans

List all floor plans

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 floor plans
amenitieslist of objects or null
avgLeasedRentdouble or null
baseMarketRentAmountdouble or null
createdAtdatetime or null
deletedAtdatetime or null
financialMarketRentAmountdouble or null
grossRentLimitdouble or null
grossSqFtinteger or null
hudGrossRentdouble or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
isAffordableboolean or null
isCommercialboolean or null
listingslist of objects or null
marketingDescstring or null
marketingNamestring or null
maxRentPercentdouble or null
namestring or null
nonOptionalChargeSumdouble or null
numBathsinteger or null
numBedsinteger or null
numHalfBathsinteger or null
organizationIdstring or nullformat: "uuid"
propertyobject or null
propertyIdstring or nullformat: "uuid"
quotingRentAmountdouble or null
readableIdstring or null
rentableSqFtinteger or null
unitslist of objects or null
updatedAtdatetime or null
utilityAllowancesSumdouble or null