Read Amenity

1 curl https://api.fortresstech.io/v1/amenities/amenityId

1 { 2 "name": "name", 3 "code": "code", 4 "createdAt": "2024-01-15T09:30:00Z", 5 "deletedAt": "2024-01-15T09:30:00Z", 6 "endDate": "2024-01-15T09:30:00Z", 7 "feeAmount": 1.1, 8 "floorPlan": { 9 "name": "name", 10 "numBeds": 1, 11 "numBaths": 1, 12 "numHalfBaths": 1, 13 "isAffordable": true, 14 "isCommercial": true, 15 "grossSqFt": 1200, 16 "rentableSqFt": 1100, 17 "marketingName": "marketingName", 18 "marketingDesc": "marketingDesc", 19 "baseMarketRentAmount": 1200.5, 20 "quotingRentAmount": 1200.5, 21 "financialMarketRentAmount": 1200.5, 22 "hudGrossRent": 1.1, 23 "grossRentLimit": 1.1, 24 "maxRentPercent": 1.1, 25 "utilityAllowancesSum": 1.1, 26 "nonOptionalChargeSum": 1.1, 27 "avgLeasedRent": 1.1, 28 "propertyId": "propertyId", 29 "organizationId": "organizationId", 30 "id": "id", 31 "readableId": "readableId", 32 "idempotencyId": "idempotencyId", 33 "createdAt": "2024-01-15T09:30:00Z", 34 "updatedAt": "2024-01-15T09:30:00Z", 35 "deletedAt": "2024-01-15T09:30:00Z" 36 }, 37 "floorPlanId": "floorPlanId", 38 "id": "id", 39 "idempotencyId": "idempotencyId", 40 "includedInMarketRent": true, 41 "organizationId": "organizationId", 42 "property": { 43 "name": "name", 44 "shortName": "shortName", 45 "email": "email", 46 "phone": "phone", 47 "physicalStreetAddress1": "physicalStreetAddress1", 48 "physicalStreetAddress2": "physicalStreetAddress2", 49 "physicalCity": "physicalCity", 50 "physicalState": "physicalState", 51 "physicalZip": "physicalZip", 52 "physicalCountry": "physicalCountry", 53 "mailingStreetAddress1": "mailingStreetAddress1", 54 "mailingStreetAddress2": "mailingStreetAddress2", 55 "mailingCity": "mailingCity", 56 "mailingState": "mailingState", 57 "mailingZip": "mailingZip", 58 "mailingCountry": "mailingCountry", 59 "phoneNumber": "phoneNumber", 60 "faxNumber": "faxNumber", 61 "timezone": "timezone", 62 "longitude": 1.1, 63 "latitude": 1.1, 64 "turnMoveOutDays": 1, 65 "organizationId": "organizationId", 66 "id": "id", 67 "readableId": "readableId", 68 "idempotencyId": "idempotencyId", 69 "createdAt": "2024-01-15T09:30:00Z", 70 "updatedAt": "2024-01-15T09:30:00Z", 71 "deletedAt": "2024-01-15T09:30:00Z", 72 "offboardedAt": "2024-01-15T09:30:00Z", 73 "countyName": "countyName", 74 "acquisitionDate": "2024-01-15T09:30:00Z" 75 }, 76 "propertyId": "propertyId", 77 "readableId": "readableId", 78 "startDate": "2024-01-15T09:30:00Z", 79 "type": "UNIT", 80 "unit": { 81 "number": "number", 82 "floorLevel": "floorLevel", 83 "isADA": true, 84 "status": "VACANT_READY", 85 "floorPlanId": "floorPlanId", 86 "propertyId": "propertyId", 87 "organizationId": "organizationId", 88 "buildingId": "buildingId", 89 "currentHouseholdId": "currentHouseholdId", 90 "lastMoveOutId": "lastMoveOutId", 91 "priorLeaseId": "priorLeaseId", 92 "id": "id", 93 "readableId": "readableId", 94 "idempotencyId": "idempotencyId", 95 "createdAt": "2024-01-15T09:30:00Z", 96 "updatedAt": "2024-01-15T09:30:00Z", 97 "deletedAt": "2024-01-15T09:30:00Z", 98 "vacantSince": "2024-01-15T09:30:00Z", 99 "reportOrder": 1.1, 100 "makeReadyDate": "makeReadyDate", 101 "reportConfigurationValue": "Quoting Rent", 102 "lastVacancyStartDate": "lastVacancyStartDate", 103 "mostRecentApplicationId": "mostRecentApplicationId" 104 }, 105 "unitId": "unitId", 106 "updatedAt": "2024-01-15T09:30:00Z" 107 }

Info for a specific amenity

Path parameters

amenityIdstringRequired

The id of the amenity

Response

Expected response to a valid request

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