Read Unit

GET

https://api.fortresstech.io/v1/properties/:propertyId/units/:unitId

GET

/v1/properties/:propertyId/units/:unitId

$ curl -G https://api.fortresstech.io/v1/properties/propertyId/units/unitId \
>      --data-urlencode fields=id,name,property.*,documents.type

200Retrieved

1 {
2   "amenities": [
3     {
4       "name": "name",
5       "code": "code",
6       "startDate": "2024-01-15T09:30:00Z",
7       "endDate": "2024-01-15T09:30:00Z",
8       "type": "UNIT",
9       "feeAmount": 1.1,
10       "includedInMarketRent": true,
11       "propertyId": "propertyId",
12       "unitId": "unitId",
13       "floorPlanId": "floorPlanId",
14       "organizationId": "organizationId",
15       "id": "id",
16       "readableId": "readableId",
17       "idempotencyId": "idempotencyId",
18       "createdAt": "2024-01-15T09:30:00Z",
19       "updatedAt": "2024-01-15T09:30:00Z",
20       "deletedAt": "2024-01-15T09:30:00Z"
21     }
22   ],
23   "applications": [
24     {
25       "notes": "notes",
26       "status": "APPROVED",
27       "submittedAt": "2024-01-15T09:30:00Z",
28       "id": "id",
29       "readableId": "readableId",
30       "idempotencyId": "idempotencyId",
31       "createdAt": "2024-01-15T09:30:00Z",
32       "updatedAt": "2024-01-15T09:30:00Z",
33       "deletedAt": "2024-01-15T09:30:00Z",
34       "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
35       "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
36       "assignedUserId": "assignedUserId",
37       "assignedUnitId": "assignedUnitId",
38       "householdId": "householdId",
39       "leaseId": "leaseId",
40       "applicantId": "applicantId",
41       "organizationId": "organizationId",
42       "propertyId": "propertyId"
43     }
44   ],
45   "attachments": [
46     {
47       "name": "name",
48       "url": "url",
49       "type": "ISSUE",
50       "createdAt": "2024-01-15T09:30:00Z",
51       "updatedAt": "2024-01-15T09:30:00Z",
52       "workOrderId": "workOrderId",
53       "propertyId": "propertyId",
54       "organizationId": "organizationId",
55       "notes": "notes",
56       "id": "id",
57       "readableId": "readableId",
58       "idempotencyId": "idempotencyId",
59       "deletedAt": "2024-01-15T09:30:00Z",
60       "householdId": "householdId",
61       "customerId": "customerId"
62     }
63   ],
64   "building": {
65     "name": "name",
66     "numFloors": 1.1,
67     "id": "id",
68     "readableId": "readableId",
69     "idempotencyId": "idempotencyId",
70     "createdAt": "2024-01-15T09:30:00Z",
71     "updatedAt": "2024-01-15T09:30:00Z",
72     "deletedAt": "2024-01-15T09:30:00Z",
73     "organizationId": "organizationId",
74     "propertyId": "propertyId"
75   },
76   "buildingId": "buildingId",
77   "city": "city",
78   "claims": [
79     {
80       "balance": 1.1,
81       "unitId": "unitId",
82       "householdId": "householdId",
83       "status": "STARTED",
84       "leaseId": "leaseId",
85       "organizationId": "organizationId",
86       "id": "id",
87       "readableId": "readableId",
88       "idempotencyId": "idempotencyId",
89       "createdAt": "2024-01-15T09:30:00Z",
90       "updatedAt": "2024-01-15T09:30:00Z",
91       "deletedAt": "2024-01-15T09:30:00Z"
92     }
93   ],
94   "createdAt": "2024-01-15T09:30:00Z",
95   "currentHousehold": {
96     "status": "APPLICANT",
97     "isUnderEviction": true,
98     "id": "id",
99     "readableId": "readableId",
100     "idempotencyId": "idempotencyId",
101     "createdAt": "2024-01-15T09:30:00Z",
102     "updatedAt": "2024-01-15T09:30:00Z",
103     "deletedAt": "2024-01-15T09:30:00Z",
104     "currentUnitId": "currentUnitId",
105     "currentLeaseId": "currentLeaseId",
106     "applicationId": "applicationId",
107     "organizationId": "organizationId",
108     "propertyId": "propertyId",
109     "currentCertificationId": "currentCertificationId",
110     "prospectId": "prospectId",
111     "primaryCustomerId": "primaryCustomerId",
112     "totalActiveRentAmount": 1.1,
113     "totalActiveSubsidyAmount": 1.1,
114     "totalActiveFeesAmount": 1.1,
115     "unitId": "unitId"
116   },
117   "currentHouseholdId": "currentHouseholdId",
118   "deletedAt": "2024-01-15T09:30:00Z",
119   "floorLevel": "floorLevel",
120   "floorPlanId": "floorPlanId",
121   "floorplan": {
122     "name": "name",
123     "numBeds": 1,
124     "numBaths": 1,
125     "numHalfBaths": 1,
126     "isAffordable": true,
127     "isCommercial": true,
128     "grossSqFt": 1200,
129     "rentableSqFt": 1100,
130     "marketingName": "marketingName",
131     "marketingDesc": "marketingDesc",
132     "baseMarketRentAmount": 1200.5,
133     "quotingRentAmount": 1200.5,
134     "financialMarketRentAmount": 1200.5,
135     "hudGrossRent": 1.1,
136     "grossRentLimit": 1.1,
137     "maxRentPercent": 1.1,
138     "utilityAllowancesSum": 1.1,
139     "nonOptionalChargeSum": 1.1,
140     "avgLeasedRent": 1.1,
141     "propertyId": "propertyId",
142     "organizationId": "organizationId",
143     "id": "id",
144     "readableId": "readableId",
145     "idempotencyId": "idempotencyId",
146     "createdAt": "2024-01-15T09:30:00Z",
147     "updatedAt": "2024-01-15T09:30:00Z",
148     "deletedAt": "2024-01-15T09:30:00Z"
149   },
150   "fullAddress": "fullAddress",
151   "households": [
152     {
153       "status": "APPLICANT",
154       "isUnderEviction": true,
155       "id": "id",
156       "readableId": "readableId",
157       "idempotencyId": "idempotencyId",
158       "createdAt": "2024-01-15T09:30:00Z",
159       "updatedAt": "2024-01-15T09:30:00Z",
160       "deletedAt": "2024-01-15T09:30:00Z",
161       "currentUnitId": "currentUnitId",
162       "currentLeaseId": "currentLeaseId",
163       "applicationId": "applicationId",
164       "organizationId": "organizationId",
165       "propertyId": "propertyId",
166       "currentCertificationId": "currentCertificationId",
167       "prospectId": "prospectId",
168       "primaryCustomerId": "primaryCustomerId",
169       "totalActiveRentAmount": 1.1,
170       "totalActiveSubsidyAmount": 1.1,
171       "totalActiveFeesAmount": 1.1,
172       "unitId": "unitId"
173     }
174   ],
175   "id": "id",
176   "idempotencyId": "idempotencyId",
177   "isADA": true,
178   "isOccupied": true,
179   "lastMoveOut": {
180     "scheduledDate": "scheduledDate",
181     "actualDate": "actualDate",
182     "status": "SCHEDULED",
183     "reason": "reason",
184     "reasonType": "reasonType",
185     "noticeDate": "noticeDate",
186     "id": "id",
187     "readableId": "readableId",
188     "idempotencyId": "idempotencyId",
189     "createdAt": "2024-01-15T09:30:00Z",
190     "updatedAt": "2024-01-15T09:30:00Z",
191     "deletedAt": "2024-01-15T09:30:00Z",
192     "organizationId": "organizationId",
193     "propertyId": "propertyId",
194     "unitId": "unitId",
195     "householdId": "householdId",
196     "leaseId": "leaseId"
197   },
198   "lastMoveOutId": "lastMoveOutId",
199   "lastVacancyStartDate": "lastVacancyStartDate",
200   "leases": [
201     {
202       "startDate": "startDate",
203       "endDate": "endDate",
204       "moveInDate": "moveInDate",
205       "moveOutDate": "moveOutDate",
206       "rentAmount": 1.1,
207       "leasedRent": 1.1,
208       "securityDepositAmount": 1.1,
209       "makeReadyDate": "makeReadyDate",
210       "turnMoveOutDays": 1,
211       "documentId": "documentId",
212       "moveOutId": "moveOutId",
213       "id": "id",
214       "readableId": "readableId",
215       "idempotencyId": "idempotencyId",
216       "createdAt": "2024-01-15T09:30:00Z",
217       "updatedAt": "2024-01-15T09:30:00Z",
218       "deletedAt": "2024-01-15T09:30:00Z",
219       "propertyId": "propertyId",
220       "unitId": "unitId",
221       "householdId": "householdId",
222       "organizationId": "organizationId"
223     }
224   ],
225   "makeReadyDate": "makeReadyDate",
226   "mostRecentApplication": {
227     "notes": "notes",
228     "status": "APPROVED",
229     "submittedAt": "2024-01-15T09:30:00Z",
230     "id": "id",
231     "readableId": "readableId",
232     "idempotencyId": "idempotencyId",
233     "createdAt": "2024-01-15T09:30:00Z",
234     "updatedAt": "2024-01-15T09:30:00Z",
235     "deletedAt": "2024-01-15T09:30:00Z",
236     "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
237     "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
238     "assignedUserId": "assignedUserId",
239     "assignedUnitId": "assignedUnitId",
240     "householdId": "householdId",
241     "leaseId": "leaseId",
242     "applicantId": "applicantId",
243     "organizationId": "organizationId",
244     "propertyId": "propertyId"
245   },
246   "mostRecentApplicationId": "mostRecentApplicationId",
247   "moveIns": [
248     {
249       "scheduledDate": "scheduledDate",
250       "actualDate": "actualDate",
251       "status": "SCHEDULED",
252       "id": "id",
253       "readableId": "readableId",
254       "idempotencyId": "idempotencyId",
255       "createdAt": "2024-01-15T09:30:00Z",
256       "updatedAt": "2024-01-15T09:30:00Z",
257       "deletedAt": "2024-01-15T09:30:00Z",
258       "organizationId": "organizationId",
259       "propertyId": "propertyId",
260       "unitId": "unitId",
261       "householdId": "householdId",
262       "leaseId": "leaseId"
263     }
264   ],
265   "moveOuts": [
266     {
267       "scheduledDate": "scheduledDate",
268       "actualDate": "actualDate",
269       "status": "SCHEDULED",
270       "reason": "reason",
271       "reasonType": "reasonType",
272       "noticeDate": "noticeDate",
273       "id": "id",
274       "readableId": "readableId",
275       "idempotencyId": "idempotencyId",
276       "createdAt": "2024-01-15T09:30:00Z",
277       "updatedAt": "2024-01-15T09:30:00Z",
278       "deletedAt": "2024-01-15T09:30:00Z",
279       "organizationId": "organizationId",
280       "propertyId": "propertyId",
281       "unitId": "unitId",
282       "householdId": "householdId",
283       "leaseId": "leaseId"
284     }
285   ],
286   "number": "number",
287   "organizationId": "organizationId",
288   "priorLease": {
289     "startDate": "startDate",
290     "endDate": "endDate",
291     "moveInDate": "moveInDate",
292     "moveOutDate": "moveOutDate",
293     "rentAmount": 1.1,
294     "leasedRent": 1.1,
295     "securityDepositAmount": 1.1,
296     "makeReadyDate": "makeReadyDate",
297     "turnMoveOutDays": 1,
298     "documentId": "documentId",
299     "moveOutId": "moveOutId",
300     "id": "id",
301     "readableId": "readableId",
302     "idempotencyId": "idempotencyId",
303     "createdAt": "2024-01-15T09:30:00Z",
304     "updatedAt": "2024-01-15T09:30:00Z",
305     "deletedAt": "2024-01-15T09:30:00Z",
306     "propertyId": "propertyId",
307     "unitId": "unitId",
308     "householdId": "householdId",
309     "organizationId": "organizationId"
310   },
311   "priorLeaseId": "priorLeaseId",
312   "property": {
313     "name": "name",
314     "shortName": "shortName",
315     "email": "email",
316     "phone": "phone",
317     "physicalStreetAddress1": "physicalStreetAddress1",
318     "physicalStreetAddress2": "physicalStreetAddress2",
319     "physicalCity": "physicalCity",
320     "physicalState": "physicalState",
321     "physicalZip": "physicalZip",
322     "physicalCountry": "physicalCountry",
323     "mailingStreetAddress1": "mailingStreetAddress1",
324     "mailingStreetAddress2": "mailingStreetAddress2",
325     "mailingCity": "mailingCity",
326     "mailingState": "mailingState",
327     "mailingZip": "mailingZip",
328     "mailingCountry": "mailingCountry",
329     "phoneNumber": "phoneNumber",
330     "faxNumber": "faxNumber",
331     "timezone": "timezone",
332     "longitude": 1.1,
333     "latitude": 1.1,
334     "turnMoveOutDays": 1,
335     "status": "ACTIVE",
336     "propertyClass": "Conventional",
337     "organizationId": "organizationId",
338     "id": "id",
339     "readableId": "readableId",
340     "idempotencyId": "idempotencyId",
341     "createdAt": "2024-01-15T09:30:00Z",
342     "updatedAt": "2024-01-15T09:30:00Z",
343     "deletedAt": "2024-01-15T09:30:00Z",
344     "offboardedAt": "2024-01-15T09:30:00Z",
345     "countyName": "countyName",
346     "acquisitionDate": "2024-01-15T09:30:00Z"
347   },
348   "propertyId": "propertyId",
349   "readableId": "readableId",
350   "renewalOffers": [
351     {
352       "offerDate": "2024-01-15T09:30:00Z",
353       "expirationDate": "2024-01-15T09:30:00Z",
354       "termMonths": 1,
355       "rentAmount": 1.1,
356       "masterLeaseTermId": "masterLeaseTermId",
357       "termDescription": "termDescription",
358       "id": "id",
359       "readableId": "readableId",
360       "idempotencyId": "idempotencyId",
361       "createdAt": "2024-01-15T09:30:00Z",
362       "updatedAt": "2024-01-15T09:30:00Z",
363       "deletedAt": "2024-01-15T09:30:00Z",
364       "unitId": "unitId",
365       "leaseId": "leaseId",
366       "organizationId": "organizationId",
367       "propertyId": "propertyId"
368     }
369   ],
370   "reportConfigurationValue": "Quoting Rent",
371   "reportOrder": 1.1,
372   "state": "state",
373   "status": "VACANT_READY",
374   "streetAddress1": "streetAddress1",
375   "streetAddress2": "streetAddress2",
376   "turns": [
377     {
378       "date": "date",
379       "unitId": "unitId",
380       "idempotencyId": "idempotencyId",
381       "createdById": "createdById",
382       "id": "id",
383       "createdAt": "2024-01-15T09:30:00Z",
384       "updatedAt": "2024-01-15T09:30:00Z",
385       "deletedAt": "2024-01-15T09:30:00Z"
386     }
387   ],
388   "unitEventBases": [
389     {
390       "key": "value"
391     }
392   ],
393   "unitStatusChanges": [
394     {
395       "status": "VACANT_READY",
396       "statusDate": "statusDate",
397       "id": "id",
398       "readableId": "readableId",
399       "idempotencyId": "idempotencyId",
400       "createdAt": "2024-01-15T09:30:00Z",
401       "updatedAt": "2024-01-15T09:30:00Z",
402       "deletedAt": "2024-01-15T09:30:00Z",
403       "unitId": "unitId",
404       "propertyId": "propertyId",
405       "organizationId": "organizationId"
406     }
407   ],
408   "updatedAt": "2024-01-15T09:30:00Z",
409   "vacantSince": "2024-01-15T09:30:00Z",
410   "zipCode": "zipCode"
411 }

Info for a specific unit

Path parameters

propertyIdstringRequired

The id of the property

unitIdstringRequired

The id of the unit

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"

Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request

amenitieslist of objectsOptional

applicationslist of objectsOptional

attachmentslist of objectsOptional

buildingobjectOptional

buildingIdstringOptionalformat: "uuid"

citystringOptional

City in which the unit is located

claimslist of objectsOptional

createdAtdatetimeOptional

currentHouseholdobjectOptional

currentHouseholdIdstringOptionalformat: "uuid"

deletedAtdatetimeOptional

floorLevelstringOptional

floorPlanIdstringOptionalformat: "uuid"

floorplanobjectOptional

fullAddressstringOptional

Human-readable address composed from the individual address components (street lines, city, and state/zip), joined with commas. Blank components are omitted. Null when the unit has no address information.

householdslist of objectsOptional

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

isADAbooleanOptional

isOccupiedbooleanOptional

Whether the unit counts as occupied per Fortress occupancy logic (UnitStatus cannot move-in and is not Down). Matches the Portfolio Summary occupied-units calculation.

lastMoveOutobjectOptional

lastMoveOutIdstringOptionalformat: "uuid"

lastVacancyStartDatestringOptionalformat: "date"

Date when the unit last became vacant

leaseslist of objectsOptional

makeReadyDatestringOptionalformat: "date"

Expected make ready date for the unit

mostRecentApplicationobjectOptional

mostRecentApplicationIdstringOptionalformat: "uuid"

ID of the most recent application for this unit

moveInslist of objectsOptional

moveOutslist of objectsOptional

numberstringOptional

organizationIdstringOptionalformat: "uuid"

priorLeaseobjectOptional

priorLeaseIdstringOptionalformat: "uuid"

propertyobjectOptional

propertyIdstringOptionalformat: "uuid"

readableIdstringOptional

renewalOfferslist of objectsOptional

reportConfigurationValueenumOptional

Value of the report configuration for the unit

reportOrderdoubleOptional

statestringOptional

State or province in which the unit is located

statusenumOptional

streetAddress1stringOptional

Primary street address line for the unit (e.g. street number and name)

streetAddress2stringOptional

Secondary street address line for the unit (e.g. apartment, suite, or building number)

turnslist of objectsOptional

unitEventBaseslist of anyOptional

unitStatusChangeslist of objectsOptional

updatedAtdatetimeOptional

vacantSincedatetimeOptional

zipCodestringOptional

Postal / ZIP code for the unit