API ReferenceAmenities

List Amenities

List all amenities

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 amenities
namestring
codestring or null
createdAtdatetime or null
deletedAtdatetime or null
endDatedatetime or null
feeAmountdouble or null
floorPlanobject or null
floorPlanIdstring or nullformat: "uuid"
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
includedInMarketRentboolean or null
organizationIdstring or nullformat: "uuid"
propertyobject or null
propertyIdstring or nullformat: "uuid"
readableIdstring or null
startDatedatetime or null
typeenum or nullDefaults to UNIT
Allowed values:
unitobject or null
unitIdstring or nullformat: "uuid"
updatedAtdatetime or null