Get all residents

Query parameters

order-bystringOptional

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

offsetintegerOptional

Can be used for paginating results

limitintegerOptional

A number between 1 and 250 to determine the number of results to return in a single query

x_idstringOptional

The external resident id

x_property_idstringOptional

Deprecated: Use Propexo property_id instead

location_idstringOptional

The Propexo unique identifier for the location associated with the property. This is the location specified in RentManager

property_idstringOptional

The Propexo property id

lease_idstringOptional

The Propexo lease id

integration_idstringOptional

The Propexo integration id

integration_vendorenumOptional

The integration vendor for the resident.

Response

This endpoint returns an object.

metaobject

resultslist of objects

Errors

1 curl https://api.propexo.com/v1/residents/ \ 2 -H "Authorization: Bearer <token>"

1 { 2 "meta": { 3 "orderBy": [ 4 {} 5 ], 6 "offset": 42, 7 "limit": 42, 8 "hasMore": true, 9 "total": 42 10 }, 11 "results": [ 12 { 13 "id": "sample_value", 14 "created_at": "2024-07-01T00:00:00.000Z", 15 "updated_at": "2024-07-01T00:00:00.000Z", 16 "x_id": "sample_value", 17 "pets": [ 18 { 19 "id": "sample_value", 20 "created_at": "2024-07-01T00:00:00.000Z", 21 "updated_at": "2024-07-01T00:00:00.000Z", 22 "x_id": "sample_value", 23 "last_seen": "2024-07-01T00:00:00.000Z", 24 "name": "sample_value", 25 "type": "sample_value", 26 "breed": "sample_value", 27 "gender_raw": "sample_value", 28 "age_in_years": 42, 29 "weight_in_pounds": 42, 30 "is_fixed": true, 31 "is_service_animal": true, 32 "notes": "null" 33 } 34 ], 35 "vehicles": [ 36 { 37 "id": "sample_value", 38 "created_at": "2024-07-01T00:00:00.000Z", 39 "updated_at": "2024-07-01T00:00:00.000Z", 40 "x_id": "sample_value", 41 "last_seen": "2024-07-01T00:00:00.000Z", 42 "make": "sample_value", 43 "model": "sample_value", 44 "color": "sample_value", 45 "year": "sample_value", 46 "license_plate_number": "sample_value", 47 "license_plate_state": "sample_value", 48 "notes": "null" 49 } 50 ], 51 "integration_id": "sample_value", 52 "integration_vendor": "sample_value", 53 "property_id": "sample_value", 54 "last_seen": "2024-07-01T00:00:00.000Z", 55 "leases_meta_data": [ 56 { 57 "lease_id": "sample_value", 58 "x_resident_type": "sample_value", 59 "resident_type_normalized": "sample_value", 60 "move_in_date": "2024-07-01T00:00:00.000Z", 61 "move_out_date": "2024-07-01T00:00:00.000Z", 62 "notice_date": "2024-07-01T00:00:00.000Z" 63 } 64 ], 65 "address_1_alternate": "sample_value", 66 "address_1": "sample_value", 67 "address_2_alternate": "sample_value", 68 "address_2": "sample_value", 69 "balance_in_cents": 1.1, 70 "city_alternate": "sample_value", 71 "city": "sample_value", 72 "country_alternate": "sample_value", 73 "country": "sample_value", 74 "date_of_birth": "null", 75 "email_1": "sample_value", 76 "email_2": "sample_value", 77 "first_name": "sample_value", 78 "is_employee": true, 79 "last_name": "sample_value", 80 "late_balance_in_cents": 1.1, 81 "middle_name": "null", 82 "notes": "null", 83 "phone_1_type": "FAX", 84 "phone_1": "sample_value", 85 "phone_2_type": "FAX", 86 "phone_2": "sample_value", 87 "state_alternate": "sample_value", 88 "state": "sample_value", 89 "zip_alternate": "sample_value", 90 "zip": "sample_value", 91 "x_lease_id": "sample_value" 92 } 93 ] 94 }

1	curl https://api.propexo.com/v1/residents/ \
2	-H "Authorization: Bearer <token>"

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 42,
7	"limit": 42,
8	"hasMore": true,
9	"total": 42
10	},
11	"results": [
12	{
13	"id": "sample_value",
14	"created_at": "2024-07-01T00:00:00.000Z",
15	"updated_at": "2024-07-01T00:00:00.000Z",
16	"x_id": "sample_value",
17	"pets": [
18	{
19	"id": "sample_value",
20	"created_at": "2024-07-01T00:00:00.000Z",
21	"updated_at": "2024-07-01T00:00:00.000Z",
22	"x_id": "sample_value",
23	"last_seen": "2024-07-01T00:00:00.000Z",
24	"name": "sample_value",
25	"type": "sample_value",
26	"breed": "sample_value",
27	"gender_raw": "sample_value",
28	"age_in_years": 42,
29	"weight_in_pounds": 42,
30	"is_fixed": true,
31	"is_service_animal": true,
32	"notes": "null"
33	}
34	],
35	"vehicles": [
36	{
37	"id": "sample_value",
38	"created_at": "2024-07-01T00:00:00.000Z",
39	"updated_at": "2024-07-01T00:00:00.000Z",
40	"x_id": "sample_value",
41	"last_seen": "2024-07-01T00:00:00.000Z",
42	"make": "sample_value",
43	"model": "sample_value",
44	"color": "sample_value",
45	"year": "sample_value",
46	"license_plate_number": "sample_value",
47	"license_plate_state": "sample_value",
48	"notes": "null"
49	}
50	],
51	"integration_id": "sample_value",
52	"integration_vendor": "sample_value",
53	"property_id": "sample_value",
54	"last_seen": "2024-07-01T00:00:00.000Z",
55	"leases_meta_data": [
56	{
57	"lease_id": "sample_value",
58	"x_resident_type": "sample_value",
59	"resident_type_normalized": "sample_value",
60	"move_in_date": "2024-07-01T00:00:00.000Z",
61	"move_out_date": "2024-07-01T00:00:00.000Z",
62	"notice_date": "2024-07-01T00:00:00.000Z"
63	}
64	],
65	"address_1_alternate": "sample_value",
66	"address_1": "sample_value",
67	"address_2_alternate": "sample_value",
68	"address_2": "sample_value",
69	"balance_in_cents": 1.1,
70	"city_alternate": "sample_value",
71	"city": "sample_value",
72	"country_alternate": "sample_value",
73	"country": "sample_value",
74	"date_of_birth": "null",
75	"email_1": "sample_value",
76	"email_2": "sample_value",
77	"first_name": "sample_value",
78	"is_employee": true,
79	"last_name": "sample_value",
80	"late_balance_in_cents": 1.1,
81	"middle_name": "null",
82	"notes": "null",
83	"phone_1_type": "FAX",
84	"phone_1": "sample_value",
85	"phone_2_type": "FAX",
86	"phone_2": "sample_value",
87	"state_alternate": "sample_value",
88	"state": "sample_value",
89	"zip_alternate": "sample_value",
90	"zip": "sample_value",
91	"x_lease_id": "sample_value"
92	}
93	]
94	}