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

1 curl 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       "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": "clwh5u07w000508me66sfh3um",
34       "integration_vendor": "BUILDIUM",
35       "property_id": "clwi5xiix000008l6ctdgafyh",
36       "last_seen": "2024-03-22T10:59:45.119Z",
37       "x_lease_id": "null",
38       "leases_meta_data": [
39         {
40           "lease_id": "lease_id"
41         }
42       ],
43       "address_1_alternate": "null",
44       "address_1": "123 Main St",
45       "address_2_alternate": "null",
46       "address_2": "sample_value",
47       "balance_in_cents": 1.1,
48       "city_alternate": "null",
49       "city": "Boston",
50       "country_alternate": "null",
51       "country": "null",
52       "date_of_birth": "null",
53       "email_1": "example_email_1@email.com",
54       "email_2": "sample_value",
55       "first_name": "Sally",
56       "is_employee": true,
57       "last_name": "Jones",
58       "late_balance_in_cents": 1.1,
59       "middle_name": "null",
60       "notes": "null",
61       "phone_1_type": "MOBILE",
62       "phone_1": "(123) 555-1234",
63       "phone_2_type": "FAX",
64       "phone_2": "sample_value",
65       "state_alternate": "null",
66       "state": "MA",
67       "zip_alternate": "null",
68       "zip": "02116"
69     }
70   ]
71 }

Built with

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

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	"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": "clwh5u07w000508me66sfh3um",
34	"integration_vendor": "BUILDIUM",
35	"property_id": "clwi5xiix000008l6ctdgafyh",
36	"last_seen": "2024-03-22T10:59:45.119Z",
37	"x_lease_id": "null",
38	"leases_meta_data": [
39	{
40	"lease_id": "lease_id"
41	}
42	],
43	"address_1_alternate": "null",
44	"address_1": "123 Main St",
45	"address_2_alternate": "null",
46	"address_2": "sample_value",
47	"balance_in_cents": 1.1,
48	"city_alternate": "null",
49	"city": "Boston",
50	"country_alternate": "null",
51	"country": "null",
52	"date_of_birth": "null",
53	"email_1": "example_email_1@email.com",
54	"email_2": "sample_value",
55	"first_name": "Sally",
56	"is_employee": true,
57	"last_name": "Jones",
58	"late_balance_in_cents": 1.1,
59	"middle_name": "null",
60	"notes": "null",
61	"phone_1_type": "MOBILE",
62	"phone_1": "(123) 555-1234",
63	"phone_2_type": "FAX",
64	"phone_2": "sample_value",
65	"state_alternate": "null",
66	"state": "MA",
67	"zip_alternate": "null",
68	"zip": "02116"
69	}
70	]
71	}