Residents

Get all residents

GET
Get all residents

Query parameters

order-bystringOptional
offsetintegerOptional
limitintegerOptional
x_idstringOptional
x_property_idstringOptional
location_idstringOptional
property_idstringOptional
lease_idstringOptional
integration_idstringOptional
integration_vendorenumOptional
The integration vendor for the resident.

Response

This endpoint returns an object
meta
object
results
list of objects
GET
1curl https://api.propexo.com/v1/residents \
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 "integration_id": "clwh5u07w000508me66sfh3um",
18 "integration_vendor": "(PMS ENUM VALUE)",
19 "property_id": "clwi5xiix000008l6ctdgafyh",
20 "last_seen": "2024-03-22T10:59:45.119Z",
21 "x_lease_id": "null",
22 "leases_meta_data": [
23 {
24 "lease_id": "lease_id"
25 }
26 ],
27 "address_1_alternate": "null",
28 "address_1": "123 Main St",
29 "address_2_alternate": "null",
30 "address_2": "sample_value",
31 "balance_in_cents": 1.1,
32 "city_alternate": "null",
33 "city": "Boston",
34 "country_alternate": "null",
35 "country": "null",
36 "date_of_birth": "null",
37 "email_1": "example_email_1@email.com",
38 "email_2": "sample_value",
39 "first_name": "Sally",
40 "is_employee": true,
41 "last_name": "Jones",
42 "late_balance_in_cents": 1.1,
43 "middle_name": "null",
44 "notes": "null",
45 "phone_1_type": "MOBILE",
46 "phone_1": "(123) 555-1234",
47 "phone_2_type": "FAX",
48 "phone_2": "sample_value",
49 "state_alternate": "null",
50 "state": "MA",
51 "zip_alternate": "null",
52 "zip": "02116"
53 }
54 ]
55}