List Amenities

curl -G https://api.fortresstech.io/v1/amenities \
     --data-urlencode fields=id,name,property.*,documents.type

{
  "name": "name",
  "code": "code",
  "createdAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "endDate": "2024-01-15T09:30:00Z",
  "feeAmount": 1.1,
  "floorPlan": {
    "name": "name",
    "numBeds": 1,
    "numBaths": 1,
    "numHalfBaths": 1,
    "isAffordable": true,
    "isCommercial": true,
    "grossSqFt": 1200,
    "rentableSqFt": 1100,
    "marketingName": "marketingName",
    "marketingDesc": "marketingDesc",
    "baseMarketRentAmount": 1200.5,
    "quotingRentAmount": 1200.5,
    "financialMarketRentAmount": 1200.5,
    "hudGrossRent": 1.1,
    "grossRentLimit": 1.1,
    "maxRentPercent": 1.1,
    "utilityAllowancesSum": 1.1,
    "nonOptionalChargeSum": 1.1,
    "avgLeasedRent": 1.1,
    "propertyId": "propertyId",
    "organizationId": "organizationId",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z"
  },
  "floorPlanId": "floorPlanId",
  "id": "id",
  "idempotencyId": "idempotencyId",
  "includedInMarketRent": true,
  "organizationId": "organizationId",
  "property": {
    "name": "name",
    "shortName": "shortName",
    "email": "email",
    "phone": "phone",
    "physicalStreetAddress1": "physicalStreetAddress1",
    "physicalStreetAddress2": "physicalStreetAddress2",
    "physicalCity": "physicalCity",
    "physicalState": "physicalState",
    "physicalZip": "physicalZip",
    "physicalCountry": "physicalCountry",
    "mailingStreetAddress1": "mailingStreetAddress1",
    "mailingStreetAddress2": "mailingStreetAddress2",
    "mailingCity": "mailingCity",
    "mailingState": "mailingState",
    "mailingZip": "mailingZip",
    "mailingCountry": "mailingCountry",
    "phoneNumber": "phoneNumber",
    "faxNumber": "faxNumber",
    "timezone": "timezone",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "organizationId": "organizationId",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "offboardedAt": "2024-01-15T09:30:00Z",
    "countyName": "countyName",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  },
  "propertyId": "propertyId",
  "readableId": "readableId",
  "startDate": "2024-01-15T09:30:00Z",
  "type": "UNIT",
  "unit": {
    "number": "number",
    "floorLevel": "floorLevel",
    "isADA": true,
    "status": "VACANT_READY",
    "floorPlanId": "floorPlanId",
    "propertyId": "propertyId",
    "organizationId": "organizationId",
    "buildingId": "buildingId",
    "currentHouseholdId": "currentHouseholdId",
    "lastMoveOutId": "lastMoveOutId",
    "priorLeaseId": "priorLeaseId",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "vacantSince": "2024-01-15T09:30:00Z",
    "reportOrder": 1.1,
    "makeReadyDate": "makeReadyDate",
    "reportConfigurationValue": "Quoting Rent",
    "lastVacancyStartDate": "lastVacancyStartDate",
    "mostRecentApplicationId": "mostRecentApplicationId"
  },
  "unitId": "unitId",
  "updatedAt": "2024-01-15T09:30:00Z"
}

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

createdAtdatetime

deletedAtdatetime

endDatedatetime

feeAmountdouble

floorPlanobject

floorPlanIdstringformat: "uuid"

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

includedInMarketRentboolean

organizationIdstringformat: "uuid"

propertyobject

propertyIdstringformat: "uuid"

readableIdstring

startDatedatetime

typeenumDefaults to UNIT

Allowed values:

unitobject

unitIdstringformat: "uuid"

updatedAtdatetime