Applicants

Get all applicants

GET
Get all applicants

Query parameters

order-bystringOptional
offsetintegerOptional
limitintegerOptional
x_idstringOptional
location_idstringOptional
property_idstringOptional
integration_idstringOptional
integration_vendorenumOptional
The property management system of record

Response

This endpoint returns an object
meta
object
results
list of objects
GET
1curl https://api.propexo.com/v1/applicants \
2 -H "Authorization: Bearer <token>"
200Retrieved
1{
2 "meta": {
3 "orderBy": [
4 {}
5 ],
6 "offset": 1,
7 "limit": 1,
8 "hasMore": true,
9 "total": 1
10 },
11 "results": [
12 {
13 "id": "clwktsp9v000008l31iv218hn",
14 "created_at": "2024-03-21T15:38:08.337Z",
15 "updated_at": "2024-03-22T10:59:45.119Z",
16 "x_id": "sample_value",
17 "x_property_id": "sample_value",
18 "applications": [
19 {
20 "applicant_id": "applicant_id",
21 "application_id": "application_id"
22 }
23 ],
24 "integration_id": "clwh5u07w000508me66sfh3um",
25 "integration_vendor": "(PMS ENUM VALUE)",
26 "property_id": "clwi5xiix000008l6ctdgafyh",
27 "screenings": [
28 {
29 "id": "id",
30 "created_at": "created_at",
31 "last_seen": "last_seen",
32 "x_id": "x_id"
33 }
34 ],
35 "last_seen": "2024-03-22T10:59:45.119Z",
36 "x_unit_id": "sample_value",
37 "x_lease_id": "null",
38 "x_lead_id": "null",
39 "address_1_alternate": "null",
40 "address_1": "null",
41 "address_2_alternate": "null",
42 "address_2": "null",
43 "city_alternate": "null",
44 "city": "null",
45 "country_alternate": "null",
46 "country": "null",
47 "date_of_birth": "null",
48 "email_1": "example_email_1@email.com",
49 "email_2": "email_2",
50 "first_name": "Sally",
51 "last_name": "Jones",
52 "middle_name": "null",
53 "notes": "null",
54 "phone_1_type": "MOBILE",
55 "phone_1": "(123) 555-1234",
56 "phone_2_type": "FAX",
57 "phone_2": "sample_value",
58 "state_alternate": "null",
59 "state": "null",
60 "zip_alternate": "null",
61 "zip": "null"
62 }
63 ]
64}