Get all leases

Query parameters

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 lease id

x_property_idstringOptional

Deprecated: Use the Propexo property_id instead

x_unit_idstringOptional

Deprecated: Use the Propexo unit_id instead

location_idstringOptional

The Propexo unique identifier for the location associated with the property. This is the location specified in RentManager

unit_idstringOptional

The Propexo unique identifier for the unit

resident_idstringOptional

The Propexo unique identifier for the resident. If you use this filter in conjunction with one of the move-in/move-out date filters, it will not be honored and will be overridden by the date filter.

property_idstringOptional

The Propexo unique identifier for the property

integration_idstringOptional

The Propexo unique identifier for the integration

before_move_in_datestringOptional

Filter to residents moving in before this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record.

after_move_in_datestringOptional

Filter to residents moving in after this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record.

before_move_out_datestringOptional

Filter to residents moving out before this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record.

after_move_out_datestringOptional

Filter to residents moving out after this date. Format: YYYY-MM-DD. Date filter combinations will act with AND logic on a single record.

integration_vendorenumOptional

The property management system of record

status_normalizedenumOptional

The normalized status for the lease

Allowed values: ACTIVEINACTIVEOTHERPENDINGEVICTED

status_rawstringOptional

The raw status associated with the lease

unit_numberstringOptional

The unit number of the lease. When using this, the Propexo property_id filter must be added as well.

Response

This endpoint returns an object.

metaobject

resultslist of objects

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	"x_property_id": "x_property_id",
18	"property_id": "property_id",
19	"integration_id": "integration_id",
20	"integration_vendor": "SAMPLE2",
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": "last_seen",
32	"x_unit_id": "x_unit_id",
33	"residents_meta_data": [
34	{
35	"resident_id": "resident_id",
36	"move_in_date": "2024-01-01"
37	}
38	],
39	"application_date": "application_date",
40	"deposit_amount": "deposit_amount",
41	"deposit_amount_in_cents": 1.1,
42	"deposit_date": "deposit_date",
43	"end_date": "end_date",
44	"rent_amount_in_cents": 1.1,
45	"rent_amount_market_in_cents": 1.1,
46	"rent_due_day": 1,
47	"rent_due_date": "rent_due_date",
48	"signature_date": "signature_date",
49	"start_date": "start_date",
50	"status_normalized": "ACTIVE",
51	"status_raw": "status_raw",
52	"term": "term",
53	"type": "type",
54	"unit_number": "unit_number",
55	"write_off_amount_in_cents": "write_off_amount_in_cents",
56	"write_off_amount_raw": "write_off_amount_raw",
57	"balance_amount_in_cents": "balance_amount_in_cents",
58	"balance_amount_raw": "balance_amount_raw",
59	"past_due_balance_in_cents": "past_due_balance_in_cents",
60	"past_due_balance_raw": "past_due_balance_raw",
61	"unit_id": "unit_id",
62	"x_resident_id": "x_resident_id",
63	"realized_move_in_date": "realized_move_in_date",
64	"realized_move_out_date": "realized_move_out_date",
65	"scheduled_move_in_date": "scheduled_move_in_date",
66	"scheduled_move_out_date": "scheduled_move_out_date",
67	"status": "status"
68	}
69	]
70	}

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

Query parameters

Response

Errors