List Amenities

GET

https://api.fortresstech.io/v1/amenities

GET

/v1/amenities

curl https://api.fortresstech.io/v1/amenities \
     -H "x-api-key: <apiKey>"

200Retrieved

{
  "name": "string",
  "code": "string",
  "startDate": "2024-01-15T09:30:00Z",
  "endDate": "2024-01-15T09:30:00Z",
  "type": "UNIT",
  "feeAmount": 1.1,
  "includedInMarketRent": true,
  "propertyId": "string",
  "unitId": "string",
  "floorPlanId": "string",
  "organizationId": "string",
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "property": {
    "name": "string",
    "shortName": "string",
    "email": "string",
    "phone": "string",
    "physicalStreetAddress1": "string",
    "physicalStreetAddress2": "string",
    "physicalCity": "string",
    "physicalState": "string",
    "physicalZip": "string",
    "physicalCountry": "string",
    "mailingStreetAddress1": "string",
    "mailingStreetAddress2": "string",
    "mailingCity": "string",
    "mailingState": "string",
    "mailingZip": "string",
    "mailingCountry": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "timezone": "string",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "status": "ACTIVE",
    "propertyClass": "Conventional",
    "organizationId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "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": "string",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  },
  "unit": {
    "number": "string",
    "floorLevel": "string",
    "isADA": true,
    "streetAddress1": "string",
    "streetAddress2": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "fullAddress": "string",
    "status": "VACANT_READY",
    "isOccupied": true,
    "floorPlanId": "string",
    "propertyId": "string",
    "organizationId": "string",
    "buildingId": "string",
    "currentHouseholdId": "string",
    "lastMoveOutId": "string",
    "priorLeaseId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "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": "2023-01-15",
    "reportConfigurationValue": "Quoting Rent",
    "lastVacancyStartDate": "2023-01-15",
    "mostRecentApplicationId": "string"
  },
  "floorPlan": {
    "name": "string",
    "numBeds": 1,
    "numBaths": 1,
    "numHalfBaths": 1,
    "isAffordable": true,
    "isCommercial": true,
    "grossSqFt": 1200,
    "rentableSqFt": 1100,
    "marketingName": "string",
    "marketingDesc": "string",
    "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": "string",
    "organizationId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z"
  }
}

List all amenities

Authentication

x-api-keystring

API Key authentication via header

Response

A paged array of amenities

namestring

codestringOptional

startDatedatetimeOptional

endDatedatetimeOptional

typeenumOptionalDefaults to UNIT

Allowed values:

feeAmountdoubleOptional

includedInMarketRentbooleanOptional

propertyIdstringOptionalformat: "uuid"

unitIdstringOptionalformat: "uuid"

floorPlanIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

propertyobjectOptional

unitobjectOptional

floorPlanobjectOptional