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   "claims": [
78     {
79       "balance": 1.1,
80       "unitId": "unitId",
81       "householdId": "householdId",
82       "status": "STARTED",
83       "leaseId": "leaseId",
84       "organizationId": "organizationId",
85       "id": "id",
86       "readableId": "readableId",
87       "idempotencyId": "idempotencyId",
88       "createdAt": "2024-01-15T09:30:00Z",
89       "updatedAt": "2024-01-15T09:30:00Z",
90       "deletedAt": "2024-01-15T09:30:00Z"
91     }
92   ],
93   "createdAt": "2024-01-15T09:30:00Z",
94   "currentHousehold": {
95     "status": "APPLICANT",
96     "isUnderEviction": true,
97     "id": "id",
98     "readableId": "readableId",
99     "idempotencyId": "idempotencyId",
100     "createdAt": "2024-01-15T09:30:00Z",
101     "updatedAt": "2024-01-15T09:30:00Z",
102     "deletedAt": "2024-01-15T09:30:00Z",
103     "currentUnitId": "currentUnitId",
104     "currentLeaseId": "currentLeaseId",
105     "applicationId": "applicationId",
106     "organizationId": "organizationId",
107     "propertyId": "propertyId",
108     "currentCertificationId": "currentCertificationId",
109     "prospectId": "prospectId",
110     "primaryCustomerId": "primaryCustomerId",
111     "totalActiveRentAmount": 1.1,
112     "totalActiveSubsidyAmount": 1.1,
113     "totalActiveFeesAmount": 1.1,
114     "unitId": "unitId"
115   },
116   "currentHouseholdId": "currentHouseholdId",
117   "deletedAt": "2024-01-15T09:30:00Z",
118   "floorLevel": "floorLevel",
119   "floorPlanId": "floorPlanId",
120   "floorplan": {
121     "name": "name",
122     "numBeds": 1,
123     "numBaths": 1,
124     "numHalfBaths": 1,
125     "isAffordable": true,
126     "isCommercial": true,
127     "grossSqFt": 1200,
128     "rentableSqFt": 1100,
129     "marketingName": "marketingName",
130     "marketingDesc": "marketingDesc",
131     "baseMarketRentAmount": 1200.5,
132     "quotingRentAmount": 1200.5,
133     "financialMarketRentAmount": 1200.5,
134     "hudGrossRent": 1.1,
135     "grossRentLimit": 1.1,
136     "maxRentPercent": 1.1,
137     "utilityAllowancesSum": 1.1,
138     "nonOptionalChargeSum": 1.1,
139     "avgLeasedRent": 1.1,
140     "propertyId": "propertyId",
141     "organizationId": "organizationId",
142     "id": "id",
143     "readableId": "readableId",
144     "idempotencyId": "idempotencyId",
145     "createdAt": "2024-01-15T09:30:00Z",
146     "updatedAt": "2024-01-15T09:30:00Z",
147     "deletedAt": "2024-01-15T09:30:00Z"
148   },
149   "households": [
150     {
151       "status": "APPLICANT",
152       "isUnderEviction": true,
153       "id": "id",
154       "readableId": "readableId",
155       "idempotencyId": "idempotencyId",
156       "createdAt": "2024-01-15T09:30:00Z",
157       "updatedAt": "2024-01-15T09:30:00Z",
158       "deletedAt": "2024-01-15T09:30:00Z",
159       "currentUnitId": "currentUnitId",
160       "currentLeaseId": "currentLeaseId",
161       "applicationId": "applicationId",
162       "organizationId": "organizationId",
163       "propertyId": "propertyId",
164       "currentCertificationId": "currentCertificationId",
165       "prospectId": "prospectId",
166       "primaryCustomerId": "primaryCustomerId",
167       "totalActiveRentAmount": 1.1,
168       "totalActiveSubsidyAmount": 1.1,
169       "totalActiveFeesAmount": 1.1,
170       "unitId": "unitId"
171     }
172   ],
173   "id": "id",
174   "idempotencyId": "idempotencyId",
175   "isADA": true,
176   "lastMoveOut": {
177     "scheduledDate": "scheduledDate",
178     "actualDate": "actualDate",
179     "status": "SCHEDULED",
180     "reason": "reason",
181     "reasonType": "reasonType",
182     "noticeDate": "noticeDate",
183     "id": "id",
184     "readableId": "readableId",
185     "idempotencyId": "idempotencyId",
186     "createdAt": "2024-01-15T09:30:00Z",
187     "updatedAt": "2024-01-15T09:30:00Z",
188     "deletedAt": "2024-01-15T09:30:00Z",
189     "organizationId": "organizationId",
190     "propertyId": "propertyId",
191     "unitId": "unitId",
192     "householdId": "householdId",
193     "leaseId": "leaseId"
194   },
195   "lastMoveOutId": "lastMoveOutId",
196   "lastVacancyStartDate": "lastVacancyStartDate",
197   "leases": [
198     {
199       "startDate": "startDate",
200       "endDate": "endDate",
201       "moveInDate": "moveInDate",
202       "moveOutDate": "moveOutDate",
203       "rentAmount": 1.1,
204       "securityDepositAmount": 1.1,
205       "makeReadyDate": "makeReadyDate",
206       "turnMoveOutDays": 1,
207       "documentId": "documentId",
208       "moveOutId": "moveOutId",
209       "id": "id",
210       "readableId": "readableId",
211       "idempotencyId": "idempotencyId",
212       "createdAt": "2024-01-15T09:30:00Z",
213       "updatedAt": "2024-01-15T09:30:00Z",
214       "deletedAt": "2024-01-15T09:30:00Z",
215       "propertyId": "propertyId",
216       "unitId": "unitId",
217       "householdId": "householdId",
218       "organizationId": "organizationId"
219     }
220   ],
221   "makeReadyDate": "makeReadyDate",
222   "mostRecentApplication": {
223     "notes": "notes",
224     "status": "APPROVED",
225     "submittedAt": "2024-01-15T09:30:00Z",
226     "id": "id",
227     "readableId": "readableId",
228     "idempotencyId": "idempotencyId",
229     "createdAt": "2024-01-15T09:30:00Z",
230     "updatedAt": "2024-01-15T09:30:00Z",
231     "deletedAt": "2024-01-15T09:30:00Z",
232     "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
233     "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
234     "assignedUserId": "assignedUserId",
235     "assignedUnitId": "assignedUnitId",
236     "householdId": "householdId",
237     "leaseId": "leaseId",
238     "applicantId": "applicantId",
239     "organizationId": "organizationId",
240     "propertyId": "propertyId"
241   },
242   "mostRecentApplicationId": "mostRecentApplicationId",
243   "moveIns": [
244     {
245       "scheduledDate": "scheduledDate",
246       "actualDate": "actualDate",
247       "status": "SCHEDULED",
248       "id": "id",
249       "readableId": "readableId",
250       "idempotencyId": "idempotencyId",
251       "createdAt": "2024-01-15T09:30:00Z",
252       "updatedAt": "2024-01-15T09:30:00Z",
253       "deletedAt": "2024-01-15T09:30:00Z",
254       "organizationId": "organizationId",
255       "propertyId": "propertyId",
256       "unitId": "unitId",
257       "householdId": "householdId",
258       "leaseId": "leaseId"
259     }
260   ],
261   "moveOuts": [
262     {
263       "scheduledDate": "scheduledDate",
264       "actualDate": "actualDate",
265       "status": "SCHEDULED",
266       "reason": "reason",
267       "reasonType": "reasonType",
268       "noticeDate": "noticeDate",
269       "id": "id",
270       "readableId": "readableId",
271       "idempotencyId": "idempotencyId",
272       "createdAt": "2024-01-15T09:30:00Z",
273       "updatedAt": "2024-01-15T09:30:00Z",
274       "deletedAt": "2024-01-15T09:30:00Z",
275       "organizationId": "organizationId",
276       "propertyId": "propertyId",
277       "unitId": "unitId",
278       "householdId": "householdId",
279       "leaseId": "leaseId"
280     }
281   ],
282   "number": "number",
283   "organizationId": "organizationId",
284   "priorLease": {
285     "startDate": "startDate",
286     "endDate": "endDate",
287     "moveInDate": "moveInDate",
288     "moveOutDate": "moveOutDate",
289     "rentAmount": 1.1,
290     "securityDepositAmount": 1.1,
291     "makeReadyDate": "makeReadyDate",
292     "turnMoveOutDays": 1,
293     "documentId": "documentId",
294     "moveOutId": "moveOutId",
295     "id": "id",
296     "readableId": "readableId",
297     "idempotencyId": "idempotencyId",
298     "createdAt": "2024-01-15T09:30:00Z",
299     "updatedAt": "2024-01-15T09:30:00Z",
300     "deletedAt": "2024-01-15T09:30:00Z",
301     "propertyId": "propertyId",
302     "unitId": "unitId",
303     "householdId": "householdId",
304     "organizationId": "organizationId"
305   },
306   "priorLeaseId": "priorLeaseId",
307   "property": {
308     "name": "name",
309     "shortName": "shortName",
310     "email": "email",
311     "phone": "phone",
312     "physicalStreetAddress1": "physicalStreetAddress1",
313     "physicalStreetAddress2": "physicalStreetAddress2",
314     "physicalCity": "physicalCity",
315     "physicalState": "physicalState",
316     "physicalZip": "physicalZip",
317     "physicalCountry": "physicalCountry",
318     "mailingStreetAddress1": "mailingStreetAddress1",
319     "mailingStreetAddress2": "mailingStreetAddress2",
320     "mailingCity": "mailingCity",
321     "mailingState": "mailingState",
322     "mailingZip": "mailingZip",
323     "mailingCountry": "mailingCountry",
324     "phoneNumber": "phoneNumber",
325     "faxNumber": "faxNumber",
326     "timezone": "timezone",
327     "longitude": 1.1,
328     "latitude": 1.1,
329     "turnMoveOutDays": 1,
330     "organizationId": "organizationId",
331     "id": "id",
332     "readableId": "readableId",
333     "idempotencyId": "idempotencyId",
334     "createdAt": "2024-01-15T09:30:00Z",
335     "updatedAt": "2024-01-15T09:30:00Z",
336     "deletedAt": "2024-01-15T09:30:00Z",
337     "offboardedAt": "2024-01-15T09:30:00Z",
338     "countyName": "countyName",
339     "acquisitionDate": "2024-01-15T09:30:00Z"
340   },
341   "propertyId": "propertyId",
342   "readableId": "readableId",
343   "renewalOffers": [
344     {
345       "offerDate": "2024-01-15T09:30:00Z",
346       "expirationDate": "2024-01-15T09:30:00Z",
347       "termMonths": 1,
348       "rentAmount": 1.1,
349       "id": "id",
350       "readableId": "readableId",
351       "idempotencyId": "idempotencyId",
352       "createdAt": "2024-01-15T09:30:00Z",
353       "updatedAt": "2024-01-15T09:30:00Z",
354       "deletedAt": "2024-01-15T09:30:00Z",
355       "unitId": "unitId",
356       "leaseId": "leaseId",
357       "organizationId": "organizationId",
358       "propertyId": "propertyId"
359     }
360   ],
361   "reportConfigurationValue": "Quoting Rent",
362   "reportOrder": 1.1,
363   "status": "VACANT_READY",
364   "turns": [
365     {
366       "date": "date",
367       "unitId": "unitId",
368       "idempotencyId": "idempotencyId",
369       "createdById": "createdById",
370       "id": "id",
371       "createdAt": "2024-01-15T09:30:00Z",
372       "updatedAt": "2024-01-15T09:30:00Z",
373       "deletedAt": "2024-01-15T09:30:00Z"
374     }
375   ],
376   "unitEventBases": [
377     {
378       "key": "value"
379     }
380   ],
381   "unitStatusChanges": [
382     {
383       "status": "VACANT_READY",
384       "statusDate": "statusDate",
385       "id": "id",
386       "readableId": "readableId",
387       "idempotencyId": "idempotencyId",
388       "createdAt": "2024-01-15T09:30:00Z",
389       "updatedAt": "2024-01-15T09:30:00Z",
390       "deletedAt": "2024-01-15T09:30:00Z",
391       "unitId": "unitId",
392       "propertyId": "propertyId",
393       "organizationId": "organizationId"
394     }
395   ],
396   "updatedAt": "2024-01-15T09:30:00Z",
397   "vacantSince": "2024-01-15T09:30:00Z"
398 }

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 objects

applicationslist of objects

attachmentslist of objects

buildingobject

buildingIdstringformat: "uuid"

claimslist of objects

createdAtdatetime

currentHouseholdobject

currentHouseholdIdstringformat: "uuid"

deletedAtdatetime

floorLevelstring

floorPlanIdstringformat: "uuid"

floorplanobject

householdslist of objects

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

isADAboolean

lastMoveOutobject

lastMoveOutIdstringformat: "uuid"

lastVacancyStartDatestringformat: "date"

Date when the unit last became vacant

leaseslist of objects

makeReadyDatestringformat: "date"

Expected make ready date for the unit

mostRecentApplicationobject

mostRecentApplicationIdstringformat: "uuid"

ID of the most recent application for this unit

moveInslist of objects

moveOutslist of objects

numberstring

organizationIdstringformat: "uuid"

priorLeaseobject

priorLeaseIdstringformat: "uuid"

propertyobject

propertyIdstringformat: "uuid"

readableIdstring

renewalOfferslist of objects

reportConfigurationValueenum

Value of the report configuration for the unit

Allowed values:

reportOrderdouble

statusenum

turnslist of objects

unitEventBaseslist of any

unitStatusChangeslist of objects

updatedAtdatetime

vacantSincedatetime