Get all residents

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.

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

1 { 2 "meta": { 3 "orderBy": [ 4 {} 5 ], 6 "offset": 0, 7 "limit": 100, 8 "hasMore": true, 9 "total": 1000 10 }, 11 "results": [ 12 { 13 "id": "id", 14 "created_at": "created_at", 15 "updated_at": "updated_at", 16 "x_id": "x_id", 17 "pets": [ 18 { 19 "id": "id", 20 "created_at": "created_at", 21 "updated_at": "updated_at", 22 "x_id": "x_id" 23 } 24 ], 25 "vehicles": [ 26 { 27 "id": "id", 28 "created_at": "created_at", 29 "updated_at": "updated_at", 30 "x_id": "x_id" 31 } 32 ], 33 "integration_id": "integration_id", 34 "integration_vendor": "SAMPLE2", 35 "property_id": "property_id", 36 "last_seen": "last_seen", 37 "leases_meta_data": [ 38 { 39 "lease_id": "lease_id" 40 } 41 ], 42 "address_1_alternate": "address_1_alternate", 43 "address_1": "address_1", 44 "address_2_alternate": "address_2_alternate", 45 "address_2": "address_2", 46 "balance_in_cents": 1.1, 47 "city_alternate": "city_alternate", 48 "city": "city", 49 "country_alternate": "country_alternate", 50 "country": "country", 51 "date_of_birth": "date_of_birth", 52 "email_1": "email_1", 53 "email_2": "email_2", 54 "first_name": "first_name", 55 "is_employee": true, 56 "last_name": "last_name", 57 "late_balance_in_cents": 1.1, 58 "middle_name": "middle_name", 59 "notes": "notes", 60 "phone_1_type": "FAX", 61 "phone_1": "phone_1", 62 "phone_2_type": "FAX", 63 "phone_2": "phone_2", 64 "state_alternate": "state_alternate", 65 "state": "state", 66 "zip_alternate": "zip_alternate", 67 "zip": "zip", 68 "x_lease_id": "x_lease_id" 69 } 70 ] 71 }

Query parameters

Response

Errors

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

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 0,
7	"limit": 100,
8	"hasMore": true,
9	"total": 1000
10	},
11	"results": [
12	{
13	"id": "id",
14	"created_at": "created_at",
15	"updated_at": "updated_at",
16	"x_id": "x_id",
17	"pets": [
18	{
19	"id": "id",
20	"created_at": "created_at",
21	"updated_at": "updated_at",
22	"x_id": "x_id"
23	}
24	],
25	"vehicles": [
26	{
27	"id": "id",
28	"created_at": "created_at",
29	"updated_at": "updated_at",
30	"x_id": "x_id"
31	}
32	],
33	"integration_id": "integration_id",
34	"integration_vendor": "SAMPLE2",
35	"property_id": "property_id",
36	"last_seen": "last_seen",
37	"leases_meta_data": [
38	{
39	"lease_id": "lease_id"
40	}
41	],
42	"address_1_alternate": "address_1_alternate",
43	"address_1": "address_1",
44	"address_2_alternate": "address_2_alternate",
45	"address_2": "address_2",
46	"balance_in_cents": 1.1,
47	"city_alternate": "city_alternate",
48	"city": "city",
49	"country_alternate": "country_alternate",
50	"country": "country",
51	"date_of_birth": "date_of_birth",
52	"email_1": "email_1",
53	"email_2": "email_2",
54	"first_name": "first_name",
55	"is_employee": true,
56	"last_name": "last_name",
57	"late_balance_in_cents": 1.1,
58	"middle_name": "middle_name",
59	"notes": "notes",
60	"phone_1_type": "FAX",
61	"phone_1": "phone_1",
62	"phone_2_type": "FAX",
63	"phone_2": "phone_2",
64	"state_alternate": "state_alternate",
65	"state": "state",
66	"zip_alternate": "zip_alternate",
67	"zip": "zip",
68	"x_lease_id": "x_lease_id"
69	}
70	]
71	}