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   "configuration": {
85     "propertyDescription": "propertyDescription",
86     "shortDescription": "shortDescription",
87     "officeHoursDescription": "officeHoursDescription",
88     "officeHours": "officeHours",
89     "petPolicyDescription": "petPolicyDescription",
90     "parkingDetailDescription": "parkingDetailDescription",
91     "amenities": "amenities",
92     "marketingUrl": "marketingUrl",
93     "email": "email",
94     "phone": "phone",
95     "faxNumber": "faxNumber",
96     "textingPhoneNumber": "textingPhoneNumber",
97     "physicalStreetAddress1": "physicalStreetAddress1",
98     "physicalStreetAddress2": "physicalStreetAddress2",
99     "physicalCity": "physicalCity",
100     "physicalState": "physicalState",
101     "physicalZip": "physicalZip",
102     "physicalCountry": "physicalCountry",
103     "applicationPortalUrl": "applicationPortalUrl",
104     "availabilityUrl": "availabilityUrl",
105     "lateFeeMethod": "lateFeeMethod",
106     "acceptingOnlineApplications": true,
107     "applicationIncomeRequirement": "applicationIncomeRequirement",
108     "allowedLeaseTermMonths": "allowedLeaseTermMonths",
109     "quoteExpiration": "SAME_DAY",
110     "masterMeteredElectricity": true,
111     "masterMeteredGas": true,
112     "masterMeteredSewer": true,
113     "masterMeteredTrash": true,
114     "masterMeteredWater": true,
115     "masterMeteredOther": "masterMeteredOther",
116     "accrueSecurityDepositInterest": true,
117     "securityDepositInterestPayoutFrequency": "Monthly",
118     "securityDepositSimpleInterestRate": 1.1,
119     "nearestMetroArea": "nearestMetroArea",
120     "timezone": "timezone",
121     "goesOnDaylightSavings": true,
122     "countyName": "countyName",
123     "siteBuiltDate": "siteBuiltDate",
124     "lastRenovationDate": "lastRenovationDate",
125     "managementTookOverDate": "2024-01-15T09:30:00Z",
126     "acquisitionDate": "2024-01-15T09:30:00Z",
127     "managementQuitDate": "2024-01-15T09:30:00Z",
128     "officeAlarmCode": "officeAlarmCode",
129     "hasGateWithCode": true,
130     "clientRepresentativeName": "clientRepresentativeName",
131     "accountantName": "accountantName",
132     "apClerk": "apClerk",
133     "turnMoveOutDays": 1,
134     "evictionStartDate": "evictionStartDate",
135     "leaseNoticeToVacateDays": "leaseNoticeToVacateDays",
136     "emergencyEntranceNotice": "emergencyEntranceNotice",
137     "hasFitnessCenter": true,
138     "hasPool": true,
139     "hasPackageDelivery": true,
140     "nonSmoking": true,
141     "petWeightMax": "petWeightMax",
142     "leadPaintDisclosure": "leadPaintDisclosure",
143     "waterCompany": "waterCompany",
144     "gasCompany": "gasCompany",
145     "electricCompany": "electricCompany",
146     "cableCompany": "cableCompany",
147     "internetCompany": "internetCompany",
148     "pestCompany": "pestCompany",
149     "trashCompany": "trashCompany",
150     "feesStartDate": "2024-01-15T09:30:00Z",
151     "currentPeriodStartDate": "2024-01-15T09:30:00Z",
152     "currentPeriod": "currentPeriod",
153     "buildingProtectionFee": "Building Protection Fee",
154     "leaseRentPercentage": "leaseRentPercentage",
155     "chargesFacilityFeeForLiabilityInsurance": true,
156     "facilitiesFeeAmount": 1,
157     "propertyId": "propertyId",
158     "organizationId": "organizationId",
159     "id": "id",
160     "readableId": "readableId",
161     "idempotencyId": "idempotencyId",
162     "createdAt": "2024-01-15T09:30:00Z",
163     "updatedAt": "2024-01-15T09:30:00Z",
164     "deletedAt": "2024-01-15T09:30:00Z"
165   },
166   "countyName": "countyName",
167   "createdAt": "2024-01-15T09:30:00Z",
168   "customers": [
169     {
170       "firstName": "firstName",
171       "middleName": "middleName",
172       "lastName": "lastName",
173       "preferredName": "preferredName",
174       "suffix": "suffix",
175       "birthDate": "birthDate",
176       "status": "APPLICANT",
177       "email": "email",
178       "phone": "phone",
179       "gender": "gender",
180       "headOfHousehold": true,
181       "relationship": "PARTNER",
182       "id": "id",
183       "readableId": "readableId",
184       "idempotencyId": "idempotencyId",
185       "createdAt": "2024-01-15T09:30:00Z",
186       "updatedAt": "2024-01-15T09:30:00Z",
187       "deletedAt": "2024-01-15T09:30:00Z",
188       "householdId": "householdId",
189       "propertyId": "propertyId",
190       "organizationId": "organizationId"
191     }
192   ],
193   "deletedAt": "2024-01-15T09:30:00Z",
194   "deposits": [
195     {
196       "total": 1.1,
197       "fiscalPeriod": "fiscalPeriod",
198       "id": "id",
199       "readableId": "readableId",
200       "idempotencyId": "idempotencyId",
201       "createdAt": "2024-01-15T09:30:00Z",
202       "updatedAt": "2024-01-15T09:30:00Z",
203       "deletedAt": "2024-01-15T09:30:00Z",
204       "propertyId": "propertyId",
205       "organizationId": "organizationId"
206     }
207   ],
208   "documents": [
209     {
210       "key": "value"
211     }
212   ],
213   "email": "email",
214   "faxNumber": "faxNumber",
215   "floorPlans": [
216     {
217       "name": "name",
218       "numBeds": 1,
219       "numBaths": 1,
220       "numHalfBaths": 1,
221       "isAffordable": true,
222       "isCommercial": true,
223       "grossSqFt": 1200,
224       "rentableSqFt": 1100,
225       "marketingName": "marketingName",
226       "marketingDesc": "marketingDesc",
227       "baseMarketRentAmount": 1200.5,
228       "quotingRentAmount": 1200.5,
229       "financialMarketRentAmount": 1200.5,
230       "hudGrossRent": 1.1,
231       "grossRentLimit": 1.1,
232       "maxRentPercent": 1.1,
233       "utilityAllowancesSum": 1.1,
234       "nonOptionalChargeSum": 1.1,
235       "avgLeasedRent": 1.1,
236       "propertyId": "propertyId",
237       "organizationId": "organizationId",
238       "id": "id",
239       "readableId": "readableId",
240       "idempotencyId": "idempotencyId",
241       "createdAt": "2024-01-15T09:30:00Z",
242       "updatedAt": "2024-01-15T09:30:00Z",
243       "deletedAt": "2024-01-15T09:30:00Z"
244     }
245   ],
246   "glEntries": [
247     {
248       "amount": 1.1,
249       "note": "note",
250       "date": "2024-01-15T09:30:00Z",
251       "creditAmount": 1.1,
252       "debitAmount": 1.1,
253       "accountNumber": "accountNumber",
254       "fiscalPeriod": "fiscalPeriod",
255       "id": "id",
256       "readableId": "readableId",
257       "idempotencyId": "idempotencyId",
258       "createdAt": "2024-01-15T09:30:00Z",
259       "updatedAt": "2024-01-15T09:30:00Z",
260       "deletedAt": "2024-01-15T09:30:00Z",
261       "householdId": "householdId",
262       "customerId": "customerId",
263       "propertyId": "propertyId",
264       "organizationId": "organizationId",
265       "transactionId": "transactionId"
266     }
267   ],
268   "households": [
269     {
270       "status": "APPLICANT",
271       "isUnderEviction": true,
272       "id": "id",
273       "readableId": "readableId",
274       "idempotencyId": "idempotencyId",
275       "createdAt": "2024-01-15T09:30:00Z",
276       "updatedAt": "2024-01-15T09:30:00Z",
277       "deletedAt": "2024-01-15T09:30:00Z",
278       "currentUnitId": "currentUnitId",
279       "currentLeaseId": "currentLeaseId",
280       "applicationId": "applicationId",
281       "organizationId": "organizationId",
282       "propertyId": "propertyId",
283       "currentCertificationId": "currentCertificationId",
284       "prospectId": "prospectId",
285       "primaryCustomerId": "primaryCustomerId",
286       "totalActiveRentAmount": 1.1,
287       "totalActiveSubsidyAmount": 1.1,
288       "totalActiveFeesAmount": 1.1,
289       "unitId": "unitId"
290     }
291   ],
292   "id": "id",
293   "idempotencyId": "idempotencyId",
294   "latitude": 1.1,
295   "listings": [
296     {
297       "number": "number",
298       "floorLevel": "floorLevel",
299       "status": "VACANT_READY",
300       "amenityFeeAmt": 1.1,
301       "marketRentAmt": 1.1,
302       "quotingRentAmt": 1.1,
303       "scheduledMoveInId": "scheduledMoveInId",
304       "scheduledMoveOutId": "scheduledMoveOutId",
305       "floorPlanId": "floorPlanId",
306       "propertyId": "propertyId",
307       "organizationId": "organizationId",
308       "buildingId": "buildingId",
309       "id": "id",
310       "readableId": "readableId",
311       "idempotencyId": "idempotencyId",
312       "createdAt": "2024-01-15T09:30:00Z",
313       "updatedAt": "2024-01-15T09:30:00Z",
314       "deletedAt": "2024-01-15T09:30:00Z"
315     }
316   ],
317   "longitude": 1.1,
318   "mailingCity": "mailingCity",
319   "mailingCountry": "mailingCountry",
320   "mailingState": "mailingState",
321   "mailingStreetAddress1": "mailingStreetAddress1",
322   "mailingStreetAddress2": "mailingStreetAddress2",
323   "mailingZip": "mailingZip",
324   "maintenanceIssues": [
325     {
326       "description": "description",
327       "type": "UNIT",
328       "id": "id",
329       "organizationIssueId": "organizationIssueId",
330       "readableId": "readableId",
331       "idempotencyId": "idempotencyId",
332       "createdAt": "2024-01-15T09:30:00Z",
333       "updatedAt": "2024-01-15T09:30:00Z",
334       "deletedAt": "2024-01-15T09:30:00Z",
335       "organizationId": "organizationId",
336       "propertyId": "propertyId",
337       "categoryId": "categoryId",
338       "maintenanceLocationId": "maintenanceLocationId"
339     }
340   ],
341   "maintenanceLocations": [
342     {
343       "name": "name",
344       "type": "UNIT",
345       "id": "id",
346       "readableId": "readableId",
347       "idempotencyId": "idempotencyId",
348       "createdAt": "2024-01-15T09:30:00Z",
349       "updatedAt": "2024-01-15T09:30:00Z",
350       "deletedAt": "2024-01-15T09:30:00Z",
351       "organizationId": "organizationId",
352       "propertyId": "propertyId"
353     }
354   ],
355   "moveIns": [
356     {
357       "scheduledDate": "scheduledDate",
358       "actualDate": "actualDate",
359       "status": "SCHEDULED",
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       "organizationId": "organizationId",
367       "propertyId": "propertyId",
368       "unitId": "unitId",
369       "householdId": "householdId",
370       "leaseId": "leaseId"
371     }
372   ],
373   "moveOuts": [
374     {
375       "scheduledDate": "scheduledDate",
376       "actualDate": "actualDate",
377       "status": "SCHEDULED",
378       "reason": "reason",
379       "reasonType": "reasonType",
380       "noticeDate": "noticeDate",
381       "id": "id",
382       "readableId": "readableId",
383       "idempotencyId": "idempotencyId",
384       "createdAt": "2024-01-15T09:30:00Z",
385       "updatedAt": "2024-01-15T09:30:00Z",
386       "deletedAt": "2024-01-15T09:30:00Z",
387       "organizationId": "organizationId",
388       "propertyId": "propertyId",
389       "unitId": "unitId",
390       "householdId": "householdId",
391       "leaseId": "leaseId"
392     }
393   ],
394   "name": "name",
395   "offboardedAt": "2024-01-15T09:30:00Z",
396   "organizationId": "organizationId",
397   "phone": "phone",
398   "phoneNumber": "phoneNumber",
399   "physicalCity": "physicalCity",
400   "physicalCountry": "physicalCountry",
401   "physicalState": "physicalState",
402   "physicalStreetAddress1": "physicalStreetAddress1",
403   "physicalStreetAddress2": "physicalStreetAddress2",
404   "physicalZip": "physicalZip",
405   "propertyClass": "Conventional",
406   "prospects": [
407     {
408       "firstName": "firstName",
409       "middleName": "middleName",
410       "lastName": "lastName",
411       "phone": "phone",
412       "email": "email",
413       "referralSource": "referralSource",
414       "propertyId": "propertyId",
415       "organizationId": "organizationId",
416       "assignedUserId": "assignedUserId",
417       "prospectStatusId": "prospectStatusId",
418       "id": "id",
419       "readableId": "readableId",
420       "idempotencyId": "idempotencyId",
421       "createdAt": "2024-01-15T09:30:00Z",
422       "updatedAt": "2024-01-15T09:30:00Z"
423     }
424   ],
425   "readableId": "readableId",
426   "rentChanges": [
427     {
428       "startDate": "startDate",
429       "endDate": "endDate",
430       "note": "note",
431       "rentAmount": 1.1,
432       "id": "id",
433       "readableId": "readableId",
434       "idempotencyId": "idempotencyId",
435       "createdAt": "2024-01-15T09:30:00Z",
436       "updatedAt": "2024-01-15T09:30:00Z",
437       "deletedAt": "2024-01-15T09:30:00Z",
438       "leaseId": "leaseId",
439       "organizationId": "organizationId",
440       "propertyId": "propertyId"
441     }
442   ],
443   "rentableItems": [
444     {
445       "name": "name",
446       "propertyId": "propertyId",
447       "organizationId": "organizationId",
448       "id": "id",
449       "readableId": "readableId",
450       "idempotencyId": "idempotencyId",
451       "createdAt": "2024-01-15T09:30:00Z",
452       "updatedAt": "2024-01-15T09:30:00Z",
453       "deletedAt": "2024-01-15T09:30:00Z"
454     }
455   ],
456   "reports": [
457     {
458       "reportId": "reportId",
459       "propertyId": "propertyId",
460       "filter": "filter",
461       "fields": "fields",
462       "sort": "sort",
463       "requestedBy": "requestedBy",
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       "organizationId": "organizationId"
471     }
472   ],
473   "scheduledTransactions": [
474     {
475       "amount": 1.1,
476       "type": "PAYMENT",
477       "code": "code",
478       "ledger": "OPERATING",
479       "subledger": "RESIDENT",
480       "startDate": "startDate",
481       "endDate": "endDate",
482       "description": "description",
483       "notes": "notes",
484       "frequency": "DAILY",
485       "note": "note",
486       "id": "id",
487       "idempotencyId": "idempotencyId",
488       "createdAt": "2024-01-15T09:30:00Z",
489       "updatedAt": "2024-01-15T09:30:00Z",
490       "deletedAt": "2024-01-15T09:30:00Z",
491       "organizationId": "organizationId",
492       "leaseId": "leaseId",
493       "householdId": "householdId",
494       "propertyId": "propertyId"
495     }
496   ],
497   "shortName": "shortName",
498   "status": "ACTIVE",
499   "timezone": "timezone",
500   "transactions": [
501     {
502       "id": "id",
503       "readableId": "readableId",
504       "customerId": "customerId",
505       "householdId": "householdId",
506       "propertyId": "propertyId",
507       "organizationId": "organizationId",
508       "depositId": "depositId",
509       "date": "2024-01-15T09:30:00Z",
510       "amount": 1.1,
511       "note": "note",
512       "code": "code",
513       "subjournal": "RESIDENT",
514       "ledger": "RESIDENT",
515       "fiscalPeriod": "fiscalPeriod",
516       "isPaid": true,
517       "type": "CREDIT",
518       "reversedTransactionId": "reversedTransactionId",
519       "runningBalanceAmount": 1.1,
520       "paymentDate": "2024-01-15T09:30:00Z",
521       "createdAt": "2024-01-15T09:30:00Z",
522       "updatedAt": "2024-01-15T09:30:00Z",
523       "deletedAt": "2024-01-15T09:30:00Z"
524     }
525   ],
526   "turnMoveOutDays": 1,
527   "unitStatusChanges": [
528     {
529       "status": "VACANT_READY",
530       "statusDate": "statusDate",
531       "id": "id",
532       "readableId": "readableId",
533       "idempotencyId": "idempotencyId",
534       "createdAt": "2024-01-15T09:30:00Z",
535       "updatedAt": "2024-01-15T09:30:00Z",
536       "deletedAt": "2024-01-15T09:30:00Z",
537       "unitId": "unitId",
538       "propertyId": "propertyId",
539       "organizationId": "organizationId"
540     }
541   ],
542   "units": [
543     {
544       "number": "number",
545       "floorLevel": "floorLevel",
546       "isADA": true,
547       "streetAddress1": "streetAddress1",
548       "streetAddress2": "streetAddress2",
549       "city": "city",
550       "state": "state",
551       "zipCode": "zipCode",
552       "fullAddress": "fullAddress",
553       "status": "VACANT_READY",
554       "isOccupied": true,
555       "floorPlanId": "floorPlanId",
556       "propertyId": "propertyId",
557       "organizationId": "organizationId",
558       "buildingId": "buildingId",
559       "currentHouseholdId": "currentHouseholdId",
560       "lastMoveOutId": "lastMoveOutId",
561       "priorLeaseId": "priorLeaseId",
562       "id": "id",
563       "readableId": "readableId",
564       "idempotencyId": "idempotencyId",
565       "createdAt": "2024-01-15T09:30:00Z",
566       "updatedAt": "2024-01-15T09:30:00Z",
567       "deletedAt": "2024-01-15T09:30:00Z",
568       "vacantSince": "2024-01-15T09:30:00Z",
569       "reportOrder": 1.1,
570       "makeReadyDate": "makeReadyDate",
571       "reportConfigurationValue": "Quoting Rent",
572       "lastVacancyStartDate": "lastVacancyStartDate",
573       "mostRecentApplicationId": "mostRecentApplicationId"
574     }
575   ],
576   "updatedAt": "2024-01-15T09:30:00Z",
577   "userProperties": [
578     {
579       "id": "id",
580       "readableId": "readableId",
581       "idempotencyId": "idempotencyId",
582       "userId": "userId",
583       "propertyId": "propertyId",
584       "organizationId": "organizationId",
585       "createdAt": "2024-01-15T09:30:00Z",
586       "updatedAt": "2024-01-15T09:30:00Z",
587       "deletedAt": "2024-01-15T09:30:00Z"
588     }
589   ],
590   "workOrders": [
591     {
592       "status": "OPEN",
593       "priority": "LOW",
594       "hasPetAlert": true,
595       "completedAt": "2024-01-15T09:30:00Z",
596       "requestorPhone": "requestorPhone",
597       "requestorEmail": "requestorEmail",
598       "requestedStartDateFrom": "requestedStartDateFrom",
599       "requestedStartDateTo": "requestedStartDateTo",
600       "requestedStartTimeFrom": "requestedStartTimeFrom",
601       "requestedStartTimeTo": "requestedStartTimeTo",
602       "dueDate": "dueDate",
603       "description": "description",
604       "serviceNotes": "serviceNotes",
605       "vendorNotes": "vendorNotes",
606       "entryNotes": "entryNotes",
607       "entryPreference": "24_HOUR_NOTICE",
608       "isDoorCodeActive": true,
609       "isAlarmActive": true,
610       "doorCode": "doorCode",
611       "alarmCode": "alarmCode",
612       "holdReason": "holdReason",
613       "otherLocationDetail": "otherLocationDetail",
614       "attachmentIds": "attachmentIds",
615       "technicianNotes": "technicianNotes",
616       "previouslyReported": true,
617       "id": "id",
618       "readableId": "readableId",
619       "idempotencyId": "idempotencyId",
620       "createdAt": "createdAt",
621       "updatedAt": "2024-01-15T09:30:00Z",
622       "deletedAt": "2024-01-15T09:30:00Z",
623       "assignedUserId": "assignedUserId",
624       "householdId": "householdId",
625       "customerId": "customerId",
626       "unitId": "unitId",
627       "maintenanceIssueId": "maintenanceIssueId",
628       "maintenanceLocationId": "maintenanceLocationId",
629       "propertyId": "propertyId",
630       "organizationId": "organizationId",
631       "totalCostOfMaterialsUsed": 1.1,
632       "totalAmountOwedByResident": 1.1,
633       "totalAmountOwedByProperty": 1.1,
634       "hourlyServiceRate": 1.1,
635       "totalLaborCost": 1.1
636     }
637   ]
638 }

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

acquisitionDatedatetimeOptional

activitieslist of objectsOptional

amenitieslist of objectsOptional

applicationslist of objectsOptional

attachmentslist of objectsOptional

configurationobjectOptional

countyNamestringOptional

createdAtdatetimeOptional

customerslist of objectsOptional

deletedAtdatetimeOptional

depositslist of objectsOptional

documentslist of anyOptional

emailstringOptional<=50 characters

faxNumberstringOptional

floorPlanslist of objectsOptional

glEntrieslist of objectsOptional

householdslist of objectsOptional

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

latitudedoubleOptional

listingslist of objectsOptional

longitudedoubleOptional

mailingCitystringOptional

mailingCountrystringOptional

mailingStatestringOptional

mailingStreetAddress1stringOptional

mailingStreetAddress2stringOptional

mailingZipstringOptional

maintenanceIssueslist of objectsOptional

maintenanceLocationslist of objectsOptional

moveInslist of objectsOptional

moveOutslist of objectsOptional

namestringOptional

offboardedAtdatetimeOptional

organizationIdstringOptionalformat: "uuid"

phonestringOptional

phoneNumberstringOptional

physicalCitystringOptional

physicalCountrystringOptional

physicalStatestringOptional

physicalStreetAddress1stringOptional

physicalStreetAddress2stringOptional

physicalZipstringOptional

propertyClassenumOptional

The property's class. Null for properties with no class assigned.

prospectslist of objectsOptional

readableIdstringOptional

rentChangeslist of objectsOptional

rentableItemslist of objectsOptional

reportslist of objectsOptional

scheduledTransactionslist of objectsOptional

shortNamestringOptional

statusenumOptional

Property lifecycle status. Fortress aggregates occupancy only for ACTIVE properties.

timezonestringOptional

transactionslist of objectsOptional

turnMoveOutDaysintegerOptional

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

unitStatusChangeslist of objectsOptional

unitslist of objectsOptional

updatedAtdatetimeOptional

userPropertieslist of objectsOptional

workOrderslist of objectsOptional