Read Amenity

{
  "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,
    "status": "ACTIVE",
    "propertyClass": "Conventional",
    "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,
    "streetAddress1": "streetAddress1",
    "streetAddress2": "streetAddress2",
    "city": "city",
    "state": "state",
    "zipCode": "zipCode",
    "fullAddress": "fullAddress",
    "status": "VACANT_READY",
    "isOccupied": true,
    "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"
}

Info for a specific amenity

Path parameters

amenityIdstringRequired

The id of the amenity

Response

Expected response to a valid request

namestring

codestringOptional

createdAtdatetimeOptional

deletedAtdatetimeOptional

endDatedatetimeOptional

feeAmountdoubleOptional

floorPlanobjectOptional

floorPlanIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

includedInMarketRentbooleanOptional

organizationIdstringOptionalformat: "uuid"

propertyobjectOptional

propertyIdstringOptionalformat: "uuid"

readableIdstringOptional

startDatedatetimeOptional

typeenumOptionalDefaults to UNIT

unitobjectOptional

unitIdstringOptionalformat: "uuid"

updatedAtdatetimeOptional