List Households

GET

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

GET

/v1/households

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

200Retrieved

1 [
2   {
3     "application": {
4       "notes": "notes",
5       "status": "APPROVED",
6       "submittedAt": "2024-01-15T09:30:00Z",
7       "id": "id",
8       "readableId": "readableId",
9       "idempotencyId": "idempotencyId",
10       "createdAt": "2024-01-15T09:30:00Z",
11       "updatedAt": "2024-01-15T09:30:00Z",
12       "deletedAt": "2024-01-15T09:30:00Z",
13       "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
14       "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
15       "assignedUserId": "assignedUserId",
16       "assignedUnitId": "assignedUnitId",
17       "householdId": "householdId",
18       "leaseId": "leaseId",
19       "applicantId": "applicantId",
20       "organizationId": "organizationId",
21       "propertyId": "propertyId"
22     },
23     "applicationId": "applicationId",
24     "attachments": [
25       {
26         "name": "name",
27         "url": "url",
28         "type": "ISSUE",
29         "createdAt": "2024-01-15T09:30:00Z",
30         "updatedAt": "2024-01-15T09:30:00Z",
31         "workOrderId": "workOrderId",
32         "propertyId": "propertyId",
33         "organizationId": "organizationId"
34       }
35     ],
36     "balance": {
37       "id": "id",
38       "residentAmt": 1.1,
39       "securityAmt": 1.1,
40       "securityHeldAmt": 1.1,
41       "camAmt": 1.1,
42       "organizationId": "organizationId",
43       "propertyId": "propertyId",
44       "householdId": "householdId"
45     },
46     "certifications": [
47       {}
48     ],
49     "claims": [
50       {
51         "balance": 1.1,
52         "unitId": "unitId",
53         "householdId": "householdId"
54       }
55     ],
56     "createdAt": "2024-01-15T09:30:00Z",
57     "currentCertification": {
58       "reviewStatus": "APPROVED",
59       "effectiveDate": "effectiveDate",
60       "anticipatedDate": "anticipatedDate",
61       "nextRecertificationDate": "nextRecertificationDate",
62       "contractNumber": "contractNumber",
63       "type": "MOVE_IN",
64       "subsidyType": "BMR_235",
65       "secondarySubsidyType": "secondarySubsidyType",
66       "tenantPaymentAmount": 1.1,
67       "assistancePaymentAmount": 1.1,
68       "utilityAllowanceAmount": 1.1,
69       "marketRentAmount": 1.1,
70       "grossRentAmount": 1.1,
71       "contractRentAmount": 1.1,
72       "ownerSignatureDate": "ownerSignatureDate",
73       "customerSignatureDate": "customerSignatureDate",
74       "customerSignatureSuccess": true,
75       "numEligibleMembers": 1,
76       "householdIncomeAmount": 1.1,
77       "householdAssetsAmount": 1.1,
78       "totalDeductionsAmount": 1.1,
79       "id": "id",
80       "readableId": "readableId",
81       "idempotencyId": "idempotencyId",
82       "createdAt": "2024-01-15T09:30:00Z",
83       "updatedAt": "2024-01-15T09:30:00Z",
84       "deletedAt": "2024-01-15T09:30:00Z",
85       "householdId": "householdId",
86       "unitId": "unitId",
87       "floorPlanId": "floorPlanId",
88       "propertyId": "propertyId",
89       "organizationId": "organizationId",
90       "housingPolicyId": "housingPolicyId",
91       "applicationId": "applicationId"
92     },
93     "currentCertificationId": "currentCertificationId",
94     "currentLeaseId": "currentLeaseId",
95     "currentUnitId": "currentUnitId",
96     "customers": [
97       {}
98     ],
99     "deletedAt": "2024-01-15T09:30:00Z",
100     "documents": [
101       {
102         "url": "url",
103         "id": "id",
104         "householdId": "householdId",
105         "propertyId": "propertyId"
106       }
107     ],
108     "glEntries": [
109       {}
110     ],
111     "id": "id",
112     "idempotencyId": "idempotencyId",
113     "isUnderEviction": true,
114     "lease": {
115       "startDate": "startDate",
116       "endDate": "endDate",
117       "moveInDate": "moveInDate",
118       "moveOutDate": "moveOutDate",
119       "rentAmount": 1.1,
120       "securityDepositAmount": 1.1,
121       "makeReadyDate": "makeReadyDate",
122       "turnMoveOutDays": 1,
123       "documentId": "documentId",
124       "moveOutId": "moveOutId",
125       "id": "id",
126       "readableId": "readableId",
127       "idempotencyId": "idempotencyId",
128       "createdAt": "2024-01-15T09:30:00Z",
129       "updatedAt": "2024-01-15T09:30:00Z",
130       "deletedAt": "2024-01-15T09:30:00Z",
131       "propertyId": "propertyId",
132       "unitId": "unitId",
133       "householdId": "householdId",
134       "organizationId": "organizationId"
135     },
136     "leases": [
137       {}
138     ],
139     "moveOuts": [
140       {}
141     ],
142     "organization": {
143       "key": "value"
144     },
145     "organizationId": "organizationId",
146     "primaryCustomer": {
147       "firstName": "firstName",
148       "middleName": "middleName",
149       "lastName": "lastName",
150       "preferredName": "preferredName",
151       "suffix": "suffix",
152       "birthDate": "birthDate",
153       "status": "APPLICANT",
154       "email": "email",
155       "phone": "phone",
156       "gender": "gender",
157       "headOfHousehold": true,
158       "relationship": "PARTNER",
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       "householdId": "householdId",
166       "propertyId": "propertyId",
167       "organizationId": "organizationId"
168     },
169     "primaryCustomerId": "primaryCustomerId",
170     "property": {
171       "name": "name",
172       "shortName": "shortName",
173       "email": "email",
174       "phone": "phone",
175       "physicalStreetAddress1": "physicalStreetAddress1",
176       "physicalStreetAddress2": "physicalStreetAddress2",
177       "physicalCity": "physicalCity",
178       "physicalState": "physicalState",
179       "physicalZip": "physicalZip",
180       "physicalCountry": "physicalCountry",
181       "mailingStreetAddress1": "mailingStreetAddress1",
182       "mailingStreetAddress2": "mailingStreetAddress2",
183       "mailingCity": "mailingCity",
184       "mailingState": "mailingState",
185       "mailingZip": "mailingZip",
186       "mailingCountry": "mailingCountry",
187       "phoneNumber": "phoneNumber",
188       "faxNumber": "faxNumber",
189       "timezone": "timezone",
190       "longitude": 1.1,
191       "latitude": 1.1,
192       "turnMoveOutDays": 1,
193       "organizationId": "organizationId",
194       "id": "id",
195       "readableId": "readableId",
196       "idempotencyId": "idempotencyId",
197       "createdAt": "2024-01-15T09:30:00Z",
198       "updatedAt": "2024-01-15T09:30:00Z",
199       "deletedAt": "2024-01-15T09:30:00Z",
200       "offboardedAt": "2024-01-15T09:30:00Z",
201       "countyName": "countyName",
202       "acquisitionDate": "2024-01-15T09:30:00Z"
203     },
204     "propertyId": "propertyId",
205     "prospect": {
206       "firstName": "firstName",
207       "middleName": "middleName",
208       "lastName": "lastName",
209       "phone": "phone",
210       "email": "email",
211       "referralSource": "referralSource",
212       "propertyId": "propertyId",
213       "organizationId": "organizationId",
214       "assignedUserId": "assignedUserId",
215       "id": "id",
216       "readableId": "readableId",
217       "idempotencyId": "idempotencyId",
218       "createdAt": "2024-01-15T09:30:00Z",
219       "updatedAt": "2024-01-15T09:30:00Z"
220     },
221     "prospectId": "prospectId",
222     "readableId": "readableId",
223     "reversals": [
224       {
225         "amount": 1.1,
226         "method": "method",
227         "householdId": "householdId",
228         "customerId": "customerId"
229       }
230     ],
231     "scheduledTransactions": [
232       {
233         "amount": 1.1,
234         "type": "PAYMENT",
235         "code": "code"
236       }
237     ],
238     "screenings": [
239       {}
240     ],
241     "status": "APPLICANT",
242     "totalActiveFeesAmount": 1.1,
243     "totalActiveRentAmount": 1.1,
244     "totalActiveSubsidyAmount": 1.1,
245     "transactions": [
246       {}
247     ],
248     "unit": {
249       "number": "number",
250       "floorLevel": "floorLevel",
251       "isADA": true,
252       "status": "VACANT_READY",
253       "floorPlanId": "floorPlanId",
254       "propertyId": "propertyId",
255       "organizationId": "organizationId",
256       "buildingId": "buildingId",
257       "currentHouseholdId": "currentHouseholdId",
258       "lastMoveOutId": "lastMoveOutId",
259       "priorLeaseId": "priorLeaseId",
260       "id": "id",
261       "readableId": "readableId",
262       "idempotencyId": "idempotencyId",
263       "createdAt": "2024-01-15T09:30:00Z",
264       "updatedAt": "2024-01-15T09:30:00Z",
265       "deletedAt": "2024-01-15T09:30:00Z",
266       "vacantSince": "2024-01-15T09:30:00Z",
267       "reportOrder": 1.1,
268       "makeReadyDate": "makeReadyDate",
269       "reportConfigurationValue": "Quoting Rent",
270       "lastVacancyStartDate": "lastVacancyStartDate",
271       "mostRecentApplicationId": "mostRecentApplicationId"
272     },
273     "updatedAt": "2024-01-15T09:30:00Z",
274     "workOrders": [
275       {}
276     ],
277     "unitId": "unitId"
278   }
279 ]

List all households

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 households

applicationobject

applicationIdstringformat: "uuid"

attachmentslist of objects

balanceobject

certificationslist of objects

claimslist of objects

configurationany

createdAtdatetime

currentCertificationobject

currentCertificationIdstringformat: "uuid"

currentLeaseIdstringformat: "uuid"

Current active lease for the household.

currentUnitIdstringformat: "uuid"

Current unit the household is associated with. Set only when the lease is active

customerslist of objects

deletedAtdatetime

documentslist of objects

glEntrieslist of objects

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

isUnderEvictionboolean

leaseobject

leaseslist of objects

moveOutslist of objects

organizationany

organizationIdstringformat: "uuid"

primaryCustomerobject

primaryCustomerIdstringformat: "uuid"

propertyobject

propertyIdstringformat: "uuid"

prospectobject

prospectIdstringformat: "uuid"

readableIdstring

reversalslist of objects

scheduledTransactionslist of objects

screeningslist of objects

statusenum

Allowed values:

totalActiveFeesAmountdouble

Sum of all active non-optional fee (charge) monthly lease transactions for the household

totalActiveRentAmountdouble

Sum of all active RENT monthly lease transactions for the household

totalActiveSubsidyAmountdouble

Sum of all active SUBRENT monthly lease transactions for the household

transactionslist of objects

unitobject

updatedAtdatetime

workOrderslist of objects

unitIdstringformat: "uuid"Deprecated

Deprecated, use currentUnitId instead