Leases

Get all leases

GET

Get all leases

Query parameters

order-bystringOptional

offsetintegerOptional

limitintegerOptional

x_idstringOptional

x_property_idstringOptional

x_unit_idstringOptional

location_idstringOptional

unit_idstringOptional

resident_idstringOptional

property_idstringOptional

integration_idstringOptional

integration_vendorenumOptional

The integration vendor for the lease.

Response

This endpoint returns an object

meta

object

results

list of objects

GET

1 curl https://api.propexo.com/v1/leases \
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       "x_property_id": "sample_value",
18       "property_id": "clwi5xiix000008l6ctdgafyh",
19       "integration_id": "clwh5u07w000508me66sfh3um",
20       "integration_vendor": "BUILDIUM",
21       "services": [
22         {
23           "id": "id",
24           "created_at": "created_at",
25           "updated_at": "updated_at",
26           "last_seen": "last_seen",
27           "name": "name",
28           "lease_id": "lease_id"
29         }
30       ],
31       "last_seen": "2024-03-22T10:59:45.119Z",
32       "x_resident_id": "sample_value",
33       "x_unit_id": "sample_value",
34       "residents_meta_data": [
35         {
36           "resident_id": "resident_id"
37         }
38       ],
39       "application_date": "null",
40       "deposit_amount": "null",
41       "deposit_amount_in_cents": 1.1,
42       "deposit_date": "null",
43       "end_date": "sample_value",
44       "realized_move_in_date": "null",
45       "realized_move_out_date": "null",
46       "rent_amount_in_cents": 1.1,
47       "rent_amount_market_in_cents": 350000,
48       "rent_due_day": 1,
49       "rent_due_date": "null",
50       "scheduled_move_in_date": "null",
51       "scheduled_move_out_date": "null",
52       "signature_date": "null",
53       "start_date": "sample_value",
54       "status": "sample_value",
55       "status_normalized": "ACTIVE",
56       "status_raw": "sample_value",
57       "term": "null",
58       "type": "sample_value",
59       "unit_number": "null",
60       "unit_id": "unit_id"
61     }
62   ]
63 }

Built with

1	curl https://api.propexo.com/v1/leases \
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	"x_property_id": "sample_value",
18	"property_id": "clwi5xiix000008l6ctdgafyh",
19	"integration_id": "clwh5u07w000508me66sfh3um",
20	"integration_vendor": "BUILDIUM",
21	"services": [
22	{
23	"id": "id",
24	"created_at": "created_at",
25	"updated_at": "updated_at",
26	"last_seen": "last_seen",
27	"name": "name",
28	"lease_id": "lease_id"
29	}
30	],
31	"last_seen": "2024-03-22T10:59:45.119Z",
32	"x_resident_id": "sample_value",
33	"x_unit_id": "sample_value",
34	"residents_meta_data": [
35	{
36	"resident_id": "resident_id"
37	}
38	],
39	"application_date": "null",
40	"deposit_amount": "null",
41	"deposit_amount_in_cents": 1.1,
42	"deposit_date": "null",
43	"end_date": "sample_value",
44	"realized_move_in_date": "null",
45	"realized_move_out_date": "null",
46	"rent_amount_in_cents": 1.1,
47	"rent_amount_market_in_cents": 350000,
48	"rent_due_day": 1,
49	"rent_due_date": "null",
50	"scheduled_move_in_date": "null",
51	"scheduled_move_out_date": "null",
52	"signature_date": "null",
53	"start_date": "sample_value",
54	"status": "sample_value",
55	"status_normalized": "ACTIVE",
56	"status_raw": "sample_value",
57	"term": "null",
58	"type": "sample_value",
59	"unit_number": "null",
60	"unit_id": "unit_id"
61	}
62	]
63	}