List Properties

GET

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

GET

/v1/properties

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

200Retrieved

1 {
2   "acquisitionDate": "2024-01-15T09:30:00Z",
3   "activities": [
4     {
5       "notes": "notes",
6       "type": "EMAILED",
7       "prospectId": "prospectId",
8       "assignedUserId": "assignedUserId",
9       "propertyId": "propertyId",
10       "organizationId": "organizationId",
11       "householdId": "householdId",
12       "customerStatus": "customerStatus",
13       "startTime": "2024-01-15T09:30:00Z",
14       "id": "id",
15       "readableId": "readableId",
16       "idempotencyId": "idempotencyId",
17       "createdAt": "2024-01-15T09:30:00Z",
18       "updatedAt": "2024-01-15T09:30:00Z",
19       "deletedAt": "2024-01-15T09:30:00Z"
20     }
21   ],
22   "amenities": [
23     {
24       "name": "name",
25       "code": "code",
26       "startDate": "2024-01-15T09:30:00Z",
27       "endDate": "2024-01-15T09:30:00Z",
28       "type": "UNIT",
29       "feeAmount": 1.1,
30       "includedInMarketRent": true,
31       "propertyId": "propertyId",
32       "unitId": "unitId",
33       "floorPlanId": "floorPlanId",
34       "organizationId": "organizationId",
35       "id": "id",
36       "readableId": "readableId",
37       "idempotencyId": "idempotencyId",
38       "createdAt": "2024-01-15T09:30:00Z",
39       "updatedAt": "2024-01-15T09:30:00Z",
40       "deletedAt": "2024-01-15T09:30:00Z"
41     }
42   ],
43   "applications": [
44     {
45       "notes": "notes",
46       "status": "APPROVED",
47       "submittedAt": "2024-01-15T09:30:00Z",
48       "id": "id",
49       "readableId": "readableId",
50       "idempotencyId": "idempotencyId",
51       "createdAt": "2024-01-15T09:30:00Z",
52       "updatedAt": "2024-01-15T09:30:00Z",
53       "deletedAt": "2024-01-15T09:30:00Z",
54       "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
55       "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
56       "assignedUserId": "assignedUserId",
57       "assignedUnitId": "assignedUnitId",
58       "householdId": "householdId",
59       "leaseId": "leaseId",
60       "applicantId": "applicantId",
61       "organizationId": "organizationId",
62       "propertyId": "propertyId"
63     }
64   ],
65   "attachments": [
66     {
67       "name": "name",
68       "url": "url",
69       "type": "ISSUE",
70       "createdAt": "2024-01-15T09:30:00Z",
71       "updatedAt": "2024-01-15T09:30:00Z",
72       "workOrderId": "workOrderId",
73       "propertyId": "propertyId",
74       "organizationId": "organizationId",
75       "notes": "notes",
76       "id": "id",
77       "readableId": "readableId",
78       "idempotencyId": "idempotencyId",
79       "deletedAt": "2024-01-15T09:30:00Z",
80       "householdId": "householdId",
81       "customerId": "customerId"
82     }
83   ],
84   "countyName": "countyName",
85   "createdAt": "2024-01-15T09:30:00Z",
86   "customers": [
87     {
88       "firstName": "firstName",
89       "middleName": "middleName",
90       "lastName": "lastName",
91       "preferredName": "preferredName",
92       "suffix": "suffix",
93       "birthDate": "birthDate",
94       "status": "APPLICANT",
95       "email": "email",
96       "phone": "phone",
97       "gender": "gender",
98       "headOfHousehold": true,
99       "relationship": "PARTNER",
100       "id": "id",
101       "readableId": "readableId",
102       "idempotencyId": "idempotencyId",
103       "createdAt": "2024-01-15T09:30:00Z",
104       "updatedAt": "2024-01-15T09:30:00Z",
105       "deletedAt": "2024-01-15T09:30:00Z",
106       "householdId": "householdId",
107       "propertyId": "propertyId",
108       "organizationId": "organizationId"
109     }
110   ],
111   "deletedAt": "2024-01-15T09:30:00Z",
112   "deposits": [
113     {
114       "total": 1.1,
115       "fiscalPeriod": "fiscalPeriod",
116       "id": "id",
117       "readableId": "readableId",
118       "idempotencyId": "idempotencyId",
119       "createdAt": "2024-01-15T09:30:00Z",
120       "updatedAt": "2024-01-15T09:30:00Z",
121       "deletedAt": "2024-01-15T09:30:00Z",
122       "propertyId": "propertyId",
123       "organizationId": "organizationId"
124     }
125   ],
126   "documents": [
127     {
128       "key": "value"
129     }
130   ],
131   "email": "email",
132   "faxNumber": "faxNumber",
133   "floorPlans": [
134     {
135       "name": "name",
136       "numBeds": 1,
137       "numBaths": 1,
138       "numHalfBaths": 1,
139       "isAffordable": true,
140       "isCommercial": true,
141       "grossSqFt": 1200,
142       "rentableSqFt": 1100,
143       "marketingName": "marketingName",
144       "marketingDesc": "marketingDesc",
145       "baseMarketRentAmount": 1200.5,
146       "quotingRentAmount": 1200.5,
147       "financialMarketRentAmount": 1200.5,
148       "hudGrossRent": 1.1,
149       "grossRentLimit": 1.1,
150       "maxRentPercent": 1.1,
151       "utilityAllowancesSum": 1.1,
152       "nonOptionalChargeSum": 1.1,
153       "avgLeasedRent": 1.1,
154       "propertyId": "propertyId",
155       "organizationId": "organizationId",
156       "id": "id",
157       "readableId": "readableId",
158       "idempotencyId": "idempotencyId",
159       "createdAt": "2024-01-15T09:30:00Z",
160       "updatedAt": "2024-01-15T09:30:00Z",
161       "deletedAt": "2024-01-15T09:30:00Z"
162     }
163   ],
164   "glEntries": [
165     {
166       "amount": 1.1,
167       "note": "note",
168       "date": "2024-01-15T09:30:00Z",
169       "creditAmount": 1.1,
170       "debitAmount": 1.1,
171       "accountNumber": "accountNumber",
172       "fiscalPeriod": "fiscalPeriod",
173       "id": "id",
174       "readableId": "readableId",
175       "idempotencyId": "idempotencyId",
176       "createdAt": "2024-01-15T09:30:00Z",
177       "updatedAt": "2024-01-15T09:30:00Z",
178       "deletedAt": "2024-01-15T09:30:00Z",
179       "householdId": "householdId",
180       "customerId": "customerId",
181       "propertyId": "propertyId",
182       "organizationId": "organizationId",
183       "transactionId": "transactionId"
184     }
185   ],
186   "households": [
187     {
188       "status": "APPLICANT",
189       "isUnderEviction": true,
190       "id": "id",
191       "readableId": "readableId",
192       "idempotencyId": "idempotencyId",
193       "createdAt": "2024-01-15T09:30:00Z",
194       "updatedAt": "2024-01-15T09:30:00Z",
195       "deletedAt": "2024-01-15T09:30:00Z",
196       "currentUnitId": "currentUnitId",
197       "currentLeaseId": "currentLeaseId",
198       "applicationId": "applicationId",
199       "organizationId": "organizationId",
200       "propertyId": "propertyId",
201       "currentCertificationId": "currentCertificationId",
202       "prospectId": "prospectId",
203       "primaryCustomerId": "primaryCustomerId",
204       "totalActiveRentAmount": 1.1,
205       "totalActiveSubsidyAmount": 1.1,
206       "totalActiveFeesAmount": 1.1,
207       "unitId": "unitId"
208     }
209   ],
210   "id": "id",
211   "idempotencyId": "idempotencyId",
212   "latitude": 1.1,
213   "listings": [
214     {
215       "number": "number",
216       "floorLevel": "floorLevel",
217       "status": "VACANT_READY",
218       "amenityFeeAmt": 1.1,
219       "marketRentAmt": 1.1,
220       "quotingRentAmt": 1.1,
221       "floorPlanId": "floorPlanId",
222       "propertyId": "propertyId",
223       "organizationId": "organizationId",
224       "buildingId": "buildingId",
225       "id": "id",
226       "readableId": "readableId",
227       "idempotencyId": "idempotencyId",
228       "createdAt": "2024-01-15T09:30:00Z",
229       "updatedAt": "2024-01-15T09:30:00Z",
230       "deletedAt": "2024-01-15T09:30:00Z"
231     }
232   ],
233   "longitude": 1.1,
234   "mailingCity": "mailingCity",
235   "mailingCountry": "mailingCountry",
236   "mailingState": "mailingState",
237   "mailingStreetAddress1": "mailingStreetAddress1",
238   "mailingStreetAddress2": "mailingStreetAddress2",
239   "mailingZip": "mailingZip",
240   "maintenanceIssues": [
241     {
242       "description": "description",
243       "type": "UNIT",
244       "id": "id",
245       "readableId": "readableId",
246       "idempotencyId": "idempotencyId",
247       "createdAt": "2024-01-15T09:30:00Z",
248       "updatedAt": "2024-01-15T09:30:00Z",
249       "deletedAt": "2024-01-15T09:30:00Z",
250       "organizationId": "organizationId",
251       "propertyId": "propertyId",
252       "categoryId": "categoryId"
253     }
254   ],
255   "maintenanceLocations": [
256     {
257       "name": "name",
258       "type": "UNIT",
259       "id": "id",
260       "readableId": "readableId",
261       "idempotencyId": "idempotencyId",
262       "createdAt": "2024-01-15T09:30:00Z",
263       "updatedAt": "2024-01-15T09:30:00Z",
264       "deletedAt": "2024-01-15T09:30:00Z",
265       "organizationId": "organizationId",
266       "propertyId": "propertyId"
267     }
268   ],
269   "moveIns": [
270     {
271       "scheduledDate": "scheduledDate",
272       "actualDate": "actualDate",
273       "status": "SCHEDULED",
274       "id": "id",
275       "readableId": "readableId",
276       "idempotencyId": "idempotencyId",
277       "createdAt": "2024-01-15T09:30:00Z",
278       "updatedAt": "2024-01-15T09:30:00Z",
279       "deletedAt": "2024-01-15T09:30:00Z",
280       "organizationId": "organizationId",
281       "propertyId": "propertyId",
282       "unitId": "unitId",
283       "householdId": "householdId",
284       "leaseId": "leaseId"
285     }
286   ],
287   "moveOuts": [
288     {
289       "scheduledDate": "scheduledDate",
290       "actualDate": "actualDate",
291       "status": "SCHEDULED",
292       "reason": "reason",
293       "reasonType": "reasonType",
294       "noticeDate": "noticeDate",
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       "organizationId": "organizationId",
302       "propertyId": "propertyId",
303       "unitId": "unitId",
304       "householdId": "householdId",
305       "leaseId": "leaseId"
306     }
307   ],
308   "name": "name",
309   "offboardedAt": "2024-01-15T09:30:00Z",
310   "organizationId": "organizationId",
311   "phone": "phone",
312   "phoneNumber": "phoneNumber",
313   "physicalCity": "physicalCity",
314   "physicalCountry": "physicalCountry",
315   "physicalState": "physicalState",
316   "physicalStreetAddress1": "physicalStreetAddress1",
317   "physicalStreetAddress2": "physicalStreetAddress2",
318   "physicalZip": "physicalZip",
319   "prospects": [
320     {
321       "firstName": "firstName",
322       "middleName": "middleName",
323       "lastName": "lastName",
324       "phone": "phone",
325       "email": "email",
326       "referralSource": "referralSource",
327       "propertyId": "propertyId",
328       "organizationId": "organizationId",
329       "assignedUserId": "assignedUserId",
330       "id": "id",
331       "readableId": "readableId",
332       "idempotencyId": "idempotencyId",
333       "createdAt": "2024-01-15T09:30:00Z",
334       "updatedAt": "2024-01-15T09:30:00Z"
335     }
336   ],
337   "readableId": "readableId",
338   "rentChanges": [
339     {
340       "startDate": "startDate",
341       "endDate": "endDate",
342       "note": "note",
343       "rentAmount": 1.1,
344       "id": "id",
345       "readableId": "readableId",
346       "idempotencyId": "idempotencyId",
347       "createdAt": "2024-01-15T09:30:00Z",
348       "updatedAt": "2024-01-15T09:30:00Z",
349       "deletedAt": "2024-01-15T09:30:00Z",
350       "leaseId": "leaseId",
351       "organizationId": "organizationId",
352       "propertyId": "propertyId"
353     }
354   ],
355   "rentableItems": [
356     {
357       "name": "name",
358       "propertyId": "propertyId",
359       "organizationId": "organizationId",
360       "id": "id",
361       "readableId": "readableId",
362       "idempotencyId": "idempotencyId",
363       "createdAt": "2024-01-15T09:30:00Z",
364       "updatedAt": "2024-01-15T09:30:00Z",
365       "deletedAt": "2024-01-15T09:30:00Z"
366     }
367   ],
368   "reports": [
369     {
370       "reportId": "reportId",
371       "propertyId": "propertyId",
372       "filter": "filter",
373       "fields": "fields",
374       "sort": "sort",
375       "requestedBy": "requestedBy",
376       "id": "id",
377       "readableId": "readableId",
378       "idempotencyId": "idempotencyId",
379       "createdAt": "2024-01-15T09:30:00Z",
380       "updatedAt": "2024-01-15T09:30:00Z",
381       "deletedAt": "2024-01-15T09:30:00Z",
382       "organizationId": "organizationId"
383     }
384   ],
385   "scheduledTransactions": [
386     {
387       "amount": 1.1,
388       "type": "PAYMENT",
389       "code": "code",
390       "ledger": "OPERATING",
391       "subledger": "RESIDENT",
392       "startDate": "startDate",
393       "endDate": "endDate",
394       "description": "description",
395       "notes": "notes",
396       "id": "id",
397       "idempotencyId": "idempotencyId",
398       "createdAt": "2024-01-15T09:30:00Z",
399       "updatedAt": "2024-01-15T09:30:00Z",
400       "deletedAt": "2024-01-15T09:30:00Z",
401       "organizationId": "organizationId",
402       "leaseId": "leaseId",
403       "householdId": "householdId",
404       "propertyId": "propertyId"
405     }
406   ],
407   "shortName": "shortName",
408   "timezone": "timezone",
409   "transactions": [
410     {
411       "id": "id",
412       "readableId": "readableId",
413       "customerId": "customerId",
414       "householdId": "householdId",
415       "propertyId": "propertyId",
416       "organizationId": "organizationId",
417       "depositId": "depositId",
418       "date": "2024-01-15T09:30:00Z",
419       "amount": 1.1,
420       "note": "note",
421       "code": "code",
422       "subjournal": "RESIDENT",
423       "ledger": "RESIDENT",
424       "fiscalPeriod": "fiscalPeriod",
425       "isPaid": true,
426       "type": "CREDIT",
427       "reversedTransactionId": "reversedTransactionId",
428       "runningBalanceAmount": 1.1,
429       "paymentDate": "2024-01-15T09:30:00Z",
430       "createdAt": "2024-01-15T09:30:00Z",
431       "updatedAt": "2024-01-15T09:30:00Z",
432       "deletedAt": "2024-01-15T09:30:00Z"
433     }
434   ],
435   "turnMoveOutDays": 1,
436   "unitStatusChanges": [
437     {
438       "status": "VACANT_READY",
439       "statusDate": "statusDate",
440       "id": "id",
441       "readableId": "readableId",
442       "idempotencyId": "idempotencyId",
443       "createdAt": "2024-01-15T09:30:00Z",
444       "updatedAt": "2024-01-15T09:30:00Z",
445       "deletedAt": "2024-01-15T09:30:00Z",
446       "unitId": "unitId",
447       "propertyId": "propertyId",
448       "organizationId": "organizationId"
449     }
450   ],
451   "units": [
452     {
453       "number": "number",
454       "floorLevel": "floorLevel",
455       "isADA": true,
456       "status": "VACANT_READY",
457       "floorPlanId": "floorPlanId",
458       "propertyId": "propertyId",
459       "organizationId": "organizationId",
460       "buildingId": "buildingId",
461       "currentHouseholdId": "currentHouseholdId",
462       "lastMoveOutId": "lastMoveOutId",
463       "priorLeaseId": "priorLeaseId",
464       "id": "id",
465       "readableId": "readableId",
466       "idempotencyId": "idempotencyId",
467       "createdAt": "2024-01-15T09:30:00Z",
468       "updatedAt": "2024-01-15T09:30:00Z",
469       "deletedAt": "2024-01-15T09:30:00Z",
470       "vacantSince": "2024-01-15T09:30:00Z",
471       "reportOrder": 1.1,
472       "makeReadyDate": "makeReadyDate",
473       "reportConfigurationValue": "Quoting Rent",
474       "lastVacancyStartDate": "lastVacancyStartDate",
475       "mostRecentApplicationId": "mostRecentApplicationId"
476     }
477   ],
478   "updatedAt": "2024-01-15T09:30:00Z",
479   "userProperties": [
480     {
481       "id": "id",
482       "readableId": "readableId",
483       "idempotencyId": "idempotencyId",
484       "userId": "userId",
485       "propertyId": "propertyId",
486       "organizationId": "organizationId",
487       "createdAt": "2024-01-15T09:30:00Z",
488       "updatedAt": "2024-01-15T09:30:00Z",
489       "deletedAt": "2024-01-15T09:30:00Z"
490     }
491   ],
492   "workOrders": [
493     {
494       "status": "OPEN",
495       "priority": "LOW",
496       "hasPetAlert": true,
497       "completedAt": "2024-01-15T09:30:00Z",
498       "requestorPhone": "requestorPhone",
499       "requestorEmail": "requestorEmail",
500       "requestedStartDateFrom": "requestedStartDateFrom",
501       "requestedStartDateTo": "requestedStartDateTo",
502       "requestedStartTimeFrom": "requestedStartTimeFrom",
503       "requestedStartTimeTo": "requestedStartTimeTo",
504       "dueDate": "dueDate",
505       "description": "description",
506       "serviceNotes": "serviceNotes",
507       "vendorNotes": "vendorNotes",
508       "entryNotes": "entryNotes",
509       "entryPreference": "24_HOUR_NOTICE",
510       "isDoorCodeActive": true,
511       "isAlarmActive": true,
512       "doorCode": "doorCode",
513       "alarmCode": "alarmCode",
514       "holdReason": "holdReason",
515       "otherLocationDetail": "otherLocationDetail",
516       "attachmentIds": "attachmentIds",
517       "technicianNotes": "technicianNotes",
518       "previouslyReported": true,
519       "id": "id",
520       "readableId": "readableId",
521       "idempotencyId": "idempotencyId",
522       "createdAt": "createdAt",
523       "updatedAt": "2024-01-15T09:30:00Z",
524       "deletedAt": "2024-01-15T09:30:00Z",
525       "assignedUserId": "assignedUserId",
526       "householdId": "householdId",
527       "customerId": "customerId",
528       "unitId": "unitId",
529       "maintenanceIssueId": "maintenanceIssueId",
530       "maintenanceLocationId": "maintenanceLocationId",
531       "propertyId": "propertyId",
532       "organizationId": "organizationId",
533       "totalCostOfMaterialsUsed": 1.1,
534       "totalAmountOwedByResident": 1.1,
535       "totalAmountOwedByProperty": 1.1,
536       "hourlyServiceRate": 1.1,
537       "totalLaborCost": 1.1
538     }
539   ]
540 }

List all properties

Query parameters

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

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

sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0

the page number when used with pagination, defaults to 0

limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of properties

acquisitionDatedatetime

activitieslist of objects

amenitieslist of objects

applicationslist of objects

attachmentslist of objects

countyNamestring

createdAtdatetime

customerslist of objects

deletedAtdatetime

depositslist of objects

documentslist of any

emailstring<=50 characters

faxNumberstring

floorPlanslist of objects

glEntrieslist of objects

householdslist of objects

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

latitudedouble

listingslist of objects

longitudedouble

mailingCitystring

mailingCountrystring

mailingStatestring

mailingStreetAddress1string

mailingStreetAddress2string

mailingZipstring

maintenanceIssueslist of objects

maintenanceLocationslist of objects

moveInslist of objects

moveOutslist of objects

namestring

offboardedAtdatetime

organizationIdstringformat: "uuid"

phonestring

phoneNumberstring

physicalCitystring

physicalCountrystring

physicalStatestring

physicalStreetAddress1string

physicalStreetAddress2string

physicalZipstring

prospectslist of objects

readableIdstring

rentChangeslist of objects

rentableItemslist of objects

reportslist of objects

scheduledTransactionslist of objects

shortNamestring

timezonestring

transactionslist of objects

turnMoveOutDaysinteger

Number of days after move-out to calculate make ready date

unitStatusChangeslist of objects

unitslist of objects

updatedAtdatetime

userPropertieslist of objects

workOrderslist of objects