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     "securityDepositAmount": 1.1,
90     "makeReadyDate": "makeReadyDate",
91     "turnMoveOutDays": 1,
92     "documentId": "documentId",
93     "moveOutId": "moveOutId",
94     "id": "id",
95     "readableId": "readableId",
96     "idempotencyId": "idempotencyId",
97     "createdAt": "2024-01-15T09:30:00Z",
98     "updatedAt": "2024-01-15T09:30:00Z",
99     "deletedAt": "2024-01-15T09:30:00Z",
100     "propertyId": "propertyId",
101     "unitId": "unitId",
102     "householdId": "householdId",
103     "organizationId": "organizationId"
104   },
105   "leaseId": "leaseId",
106   "notes": "notes",
107   "organizationId": "organizationId",
108   "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
109   "property": {
110     "name": "name",
111     "shortName": "shortName",
112     "email": "email",
113     "phone": "phone",
114     "physicalStreetAddress1": "physicalStreetAddress1",
115     "physicalStreetAddress2": "physicalStreetAddress2",
116     "physicalCity": "physicalCity",
117     "physicalState": "physicalState",
118     "physicalZip": "physicalZip",
119     "physicalCountry": "physicalCountry",
120     "mailingStreetAddress1": "mailingStreetAddress1",
121     "mailingStreetAddress2": "mailingStreetAddress2",
122     "mailingCity": "mailingCity",
123     "mailingState": "mailingState",
124     "mailingZip": "mailingZip",
125     "mailingCountry": "mailingCountry",
126     "phoneNumber": "phoneNumber",
127     "faxNumber": "faxNumber",
128     "timezone": "timezone",
129     "longitude": 1.1,
130     "latitude": 1.1,
131     "turnMoveOutDays": 1,
132     "organizationId": "organizationId",
133     "id": "id",
134     "readableId": "readableId",
135     "idempotencyId": "idempotencyId",
136     "createdAt": "2024-01-15T09:30:00Z",
137     "updatedAt": "2024-01-15T09:30:00Z",
138     "deletedAt": "2024-01-15T09:30:00Z",
139     "offboardedAt": "2024-01-15T09:30:00Z",
140     "countyName": "countyName",
141     "acquisitionDate": "2024-01-15T09:30:00Z"
142   },
143   "propertyId": "propertyId",
144   "readableId": "readableId",
145   "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
146   "status": "APPROVED",
147   "submittedAt": "2024-01-15T09:30:00Z",
148   "unit": {
149     "number": "number",
150     "floorLevel": "floorLevel",
151     "isADA": true,
152     "status": "VACANT_READY",
153     "floorPlanId": "floorPlanId",
154     "propertyId": "propertyId",
155     "organizationId": "organizationId",
156     "buildingId": "buildingId",
157     "currentHouseholdId": "currentHouseholdId",
158     "lastMoveOutId": "lastMoveOutId",
159     "priorLeaseId": "priorLeaseId",
160     "id": "id",
161     "readableId": "readableId",
162     "idempotencyId": "idempotencyId",
163     "createdAt": "2024-01-15T09:30:00Z",
164     "updatedAt": "2024-01-15T09:30:00Z",
165     "deletedAt": "2024-01-15T09:30:00Z",
166     "vacantSince": "2024-01-15T09:30:00Z",
167     "reportOrder": 1.1,
168     "makeReadyDate": "makeReadyDate",
169     "reportConfigurationValue": "Quoting Rent",
170     "lastVacancyStartDate": "lastVacancyStartDate",
171     "mostRecentApplicationId": "mostRecentApplicationId"
172   },
173   "updatedAt": "2024-01-15T09:30:00Z",
174   "user": {
175     "firstName": "firstName",
176     "lastName": "lastName",
177     "email": "email",
178     "username": "username",
179     "status": "ACTIVE",
180     "hasAllProperties": true,
181     "id": "id",
182     "readableId": "readableId",
183     "idempotencyId": "idempotencyId",
184     "createdAt": "2024-01-15T09:30:00Z",
185     "updatedAt": "2024-01-15T09:30:00Z",
186     "deletedAt": "2024-01-15T09:30:00Z",
187     "organizationId": "organizationId",
188     "propertyIds": "propertyIds"
189   }
190 }

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

applicantobject

applicantIdstringformat: "uuid"

assignedUnitIdstringformat: "uuid"

assignedUserIdstringformat: "uuid"

createdAtdatetime

deletedAtdatetime

householdobject

householdIdstringformat: "uuid"

householdslist of objects

idstringformat: "uuid"

idempotencyIdstringformat: "uuid"

leaseobject

leaseIdstringformat: "uuid"

notesstring<=2000 characters

organizationIdstringformat: "uuid"

primaryFormCompletedAtdatetime

Timestamp of the last completed primary form for any applicant.

propertyobject

propertyIdstringformat: "uuid"

readableIdstring

secondaryFormCompletedAtdatetime

Timestamp of the last completed secondary form for any applicant.

statusenum

submittedAtdatetime

unitobject

updatedAtdatetime

userobject