Leases

Get a lease by ID

GET

Get a lease by ID

Path parameters

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

Built with

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