Read Application

GET

https://api.fortresstech.io/v1/applications/:applicationId

GET

/v1/applications/:applicationId

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

200Retrieved

1 {
2   "applicant": {
3     "firstName": "firstName",
4     "lastName": "lastName",
5     "fullName": "fullName",
6     "middleName": "middleName",
7     "preferredName": "preferredName",
8     "status": "status",
9     "email": "email",
10     "phone": "phone",
11     "householdId": "householdId",
12     "organizationId": "organizationId",
13     "propertyId": "propertyId",
14     "propertyName": "propertyName",
15     "applicantId": "applicantId",
16     "applicationId": "applicationId",
17     "residentId": "residentId",
18     "unitId": "unitId",
19     "unitNumber": "unitNumber",
20     "order": 1,
21     "source": "customer",
22     "id": "id",
23     "readableId": "readableId",
24     "idempotencyId": "idempotencyId",
25     "createdAt": "2024-01-15T09:30:00Z",
26     "updatedAt": "2024-01-15T09:30:00Z",
27     "deletedAt": "2024-01-15T09:30:00Z"
28   },
29   "applicantId": "applicantId",
30   "assignedUnitId": "assignedUnitId",
31   "assignedUserId": "assignedUserId",
32   "createdAt": "2024-01-15T09:30:00Z",
33   "deletedAt": "2024-01-15T09:30:00Z",
34   "household": {
35     "status": "APPLICANT",
36     "isUnderEviction": true,
37     "id": "id",
38     "readableId": "readableId",
39     "idempotencyId": "idempotencyId",
40     "createdAt": "2024-01-15T09:30:00Z",
41     "updatedAt": "2024-01-15T09:30:00Z",
42     "deletedAt": "2024-01-15T09:30:00Z",
43     "currentUnitId": "currentUnitId",
44     "currentLeaseId": "currentLeaseId",
45     "applicationId": "applicationId",
46     "organizationId": "organizationId",
47     "propertyId": "propertyId",
48     "currentCertificationId": "currentCertificationId",
49     "prospectId": "prospectId",
50     "primaryCustomerId": "primaryCustomerId",
51     "totalActiveRentAmount": 1.1,
52     "totalActiveSubsidyAmount": 1.1,
53     "totalActiveFeesAmount": 1.1,
54     "unitId": "unitId"
55   },
56   "householdId": "householdId",
57   "households": [
58     {
59       "status": "APPLICANT",
60       "isUnderEviction": true,
61       "id": "id",
62       "readableId": "readableId",
63       "idempotencyId": "idempotencyId",
64       "createdAt": "2024-01-15T09:30:00Z",
65       "updatedAt": "2024-01-15T09:30:00Z",
66       "deletedAt": "2024-01-15T09:30:00Z",
67       "currentUnitId": "currentUnitId",
68       "currentLeaseId": "currentLeaseId",
69       "applicationId": "applicationId",
70       "organizationId": "organizationId",
71       "propertyId": "propertyId",
72       "currentCertificationId": "currentCertificationId",
73       "prospectId": "prospectId",
74       "primaryCustomerId": "primaryCustomerId",
75       "totalActiveRentAmount": 1.1,
76       "totalActiveSubsidyAmount": 1.1,
77       "totalActiveFeesAmount": 1.1,
78       "unitId": "unitId"
79     }
80   ],
81   "id": "id",
82   "idempotencyId": "idempotencyId",
83   "lease": {
84     "startDate": "startDate",
85     "endDate": "endDate",
86     "moveInDate": "moveInDate",
87     "moveOutDate": "moveOutDate",
88     "rentAmount": 1.1,
89     "leasedRent": 1.1,
90     "securityDepositAmount": 1.1,
91     "makeReadyDate": "makeReadyDate",
92     "turnMoveOutDays": 1,
93     "documentId": "documentId",
94     "moveOutId": "moveOutId",
95     "id": "id",
96     "readableId": "readableId",
97     "idempotencyId": "idempotencyId",
98     "createdAt": "2024-01-15T09:30:00Z",
99     "updatedAt": "2024-01-15T09:30:00Z",
100     "deletedAt": "2024-01-15T09:30:00Z",
101     "propertyId": "propertyId",
102     "unitId": "unitId",
103     "householdId": "householdId",
104     "organizationId": "organizationId"
105   },
106   "leaseId": "leaseId",
107   "notes": "notes",
108   "organizationId": "organizationId",
109   "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
110   "property": {
111     "name": "name",
112     "shortName": "shortName",
113     "email": "email",
114     "phone": "phone",
115     "physicalStreetAddress1": "physicalStreetAddress1",
116     "physicalStreetAddress2": "physicalStreetAddress2",
117     "physicalCity": "physicalCity",
118     "physicalState": "physicalState",
119     "physicalZip": "physicalZip",
120     "physicalCountry": "physicalCountry",
121     "mailingStreetAddress1": "mailingStreetAddress1",
122     "mailingStreetAddress2": "mailingStreetAddress2",
123     "mailingCity": "mailingCity",
124     "mailingState": "mailingState",
125     "mailingZip": "mailingZip",
126     "mailingCountry": "mailingCountry",
127     "phoneNumber": "phoneNumber",
128     "faxNumber": "faxNumber",
129     "timezone": "timezone",
130     "longitude": 1.1,
131     "latitude": 1.1,
132     "turnMoveOutDays": 1,
133     "status": "ACTIVE",
134     "propertyClass": "Conventional",
135     "organizationId": "organizationId",
136     "id": "id",
137     "readableId": "readableId",
138     "idempotencyId": "idempotencyId",
139     "createdAt": "2024-01-15T09:30:00Z",
140     "updatedAt": "2024-01-15T09:30:00Z",
141     "deletedAt": "2024-01-15T09:30:00Z",
142     "offboardedAt": "2024-01-15T09:30:00Z",
143     "countyName": "countyName",
144     "acquisitionDate": "2024-01-15T09:30:00Z"
145   },
146   "propertyId": "propertyId",
147   "readableId": "readableId",
148   "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
149   "status": "APPROVED",
150   "submittedAt": "2024-01-15T09:30:00Z",
151   "unit": {
152     "number": "number",
153     "floorLevel": "floorLevel",
154     "isADA": true,
155     "streetAddress1": "streetAddress1",
156     "streetAddress2": "streetAddress2",
157     "city": "city",
158     "state": "state",
159     "zipCode": "zipCode",
160     "fullAddress": "fullAddress",
161     "status": "VACANT_READY",
162     "isOccupied": true,
163     "floorPlanId": "floorPlanId",
164     "propertyId": "propertyId",
165     "organizationId": "organizationId",
166     "buildingId": "buildingId",
167     "currentHouseholdId": "currentHouseholdId",
168     "lastMoveOutId": "lastMoveOutId",
169     "priorLeaseId": "priorLeaseId",
170     "id": "id",
171     "readableId": "readableId",
172     "idempotencyId": "idempotencyId",
173     "createdAt": "2024-01-15T09:30:00Z",
174     "updatedAt": "2024-01-15T09:30:00Z",
175     "deletedAt": "2024-01-15T09:30:00Z",
176     "vacantSince": "2024-01-15T09:30:00Z",
177     "reportOrder": 1.1,
178     "makeReadyDate": "makeReadyDate",
179     "reportConfigurationValue": "Quoting Rent",
180     "lastVacancyStartDate": "lastVacancyStartDate",
181     "mostRecentApplicationId": "mostRecentApplicationId"
182   },
183   "updatedAt": "2024-01-15T09:30:00Z",
184   "user": {
185     "firstName": "firstName",
186     "lastName": "lastName",
187     "email": "email",
188     "username": "username",
189     "status": "ACTIVE",
190     "hasAllProperties": true,
191     "id": "id",
192     "readableId": "readableId",
193     "idempotencyId": "idempotencyId",
194     "createdAt": "2024-01-15T09:30:00Z",
195     "updatedAt": "2024-01-15T09:30:00Z",
196     "deletedAt": "2024-01-15T09:30:00Z",
197     "organizationId": "organizationId",
198     "propertyIds": "propertyIds"
199   }
200 }

Info for a specific application

Path parameters

applicationIdstringRequired

The id of the application

Query parameters

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

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

Response

Expected response to a valid request

applicantobjectOptional

applicantIdstringOptionalformat: "uuid"

assignedUnitIdstringOptionalformat: "uuid"

assignedUserIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

deletedAtdatetimeOptional

householdobjectOptional

householdIdstringOptionalformat: "uuid"

householdslist of objectsOptional

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

leaseobjectOptional

leaseIdstringOptionalformat: "uuid"

notesstringOptional<=2000 characters

organizationIdstringOptionalformat: "uuid"

primaryFormCompletedAtdatetimeOptional

Timestamp of the last completed primary form for any applicant.

propertyobjectOptional

propertyIdstringOptionalformat: "uuid"

readableIdstringOptional

secondaryFormCompletedAtdatetimeOptional

Timestamp of the last completed secondary form for any applicant.

statusenumOptional

submittedAtdatetimeOptional

unitobjectOptional

updatedAtdatetimeOptional

userobjectOptional