Residents

Get a resident by ID

GET

Path parameters

idstringRequired

Query parameters

order-bystringOptional

offsetintegerOptional

limitintegerOptional

Response

This endpoint returns an object

meta

object

results

object

GET

1 curl https://api.propexo.com/v1/residents/id \
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     "id": "clwktsp9v000008l31iv218hn",
13     "created_at": "2024-03-21T15:38:08.337Z",
14     "updated_at": "2024-03-22T10:59:45.119Z",
15     "x_id": "sample_value",
16     "pets": [
17       {
18         "id": "id",
19         "created_at": "created_at",
20         "updated_at": "updated_at",
21         "x_id": "x_id"
22       }
23     ],
24     "vehicles": [
25       {
26         "id": "id",
27         "created_at": "created_at",
28         "updated_at": "updated_at",
29         "x_id": "x_id"
30       }
31     ],
32     "integration_id": "clwh5u07w000508me66sfh3um",
33     "integration_vendor": "BUILDIUM",
34     "property_id": "clwi5xiix000008l6ctdgafyh",
35     "last_seen": "2024-03-22T10:59:45.119Z",
36     "x_lease_id": "null",
37     "leases_meta_data": [
38       {
39         "lease_id": "lease_id"
40       }
41     ],
42     "address_1_alternate": "null",
43     "address_1": "123 Main St",
44     "address_2_alternate": "null",
45     "address_2": "sample_value",
46     "balance_in_cents": 1.1,
47     "city_alternate": "null",
48     "city": "Boston",
49     "country_alternate": "null",
50     "country": "null",
51     "date_of_birth": "null",
52     "email_1": "example_email_1@email.com",
53     "email_2": "sample_value",
54     "first_name": "Sally",
55     "is_employee": true,
56     "last_name": "Jones",
57     "late_balance_in_cents": 1.1,
58     "middle_name": "null",
59     "notes": "null",
60     "phone_1_type": "MOBILE",
61     "phone_1": "(123) 555-1234",
62     "phone_2_type": "FAX",
63     "phone_2": "sample_value",
64     "state_alternate": "null",
65     "state": "MA",
66     "zip_alternate": "null",
67     "zip": "02116"
68   }
69 }

Built with

1	curl https://api.propexo.com/v1/residents/id \
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	"id": "clwktsp9v000008l31iv218hn",
13	"created_at": "2024-03-21T15:38:08.337Z",
14	"updated_at": "2024-03-22T10:59:45.119Z",
15	"x_id": "sample_value",
16	"pets": [
17	{
18	"id": "id",
19	"created_at": "created_at",
20	"updated_at": "updated_at",
21	"x_id": "x_id"
22	}
23	],
24	"vehicles": [
25	{
26	"id": "id",
27	"created_at": "created_at",
28	"updated_at": "updated_at",
29	"x_id": "x_id"
30	}
31	],
32	"integration_id": "clwh5u07w000508me66sfh3um",
33	"integration_vendor": "BUILDIUM",
34	"property_id": "clwi5xiix000008l6ctdgafyh",
35	"last_seen": "2024-03-22T10:59:45.119Z",
36	"x_lease_id": "null",
37	"leases_meta_data": [
38	{
39	"lease_id": "lease_id"
40	}
41	],
42	"address_1_alternate": "null",
43	"address_1": "123 Main St",
44	"address_2_alternate": "null",
45	"address_2": "sample_value",
46	"balance_in_cents": 1.1,
47	"city_alternate": "null",
48	"city": "Boston",
49	"country_alternate": "null",
50	"country": "null",
51	"date_of_birth": "null",
52	"email_1": "example_email_1@email.com",
53	"email_2": "sample_value",
54	"first_name": "Sally",
55	"is_employee": true,
56	"last_name": "Jones",
57	"late_balance_in_cents": 1.1,
58	"middle_name": "null",
59	"notes": "null",
60	"phone_1_type": "MOBILE",
61	"phone_1": "(123) 555-1234",
62	"phone_2_type": "FAX",
63	"phone_2": "sample_value",
64	"state_alternate": "null",
65	"state": "MA",
66	"zip_alternate": "null",
67	"zip": "02116"
68	}
69	}