Leases

Get all leases

GET
https://api.propexo.com/v1/leases
Get all leases

Query parameters

order-by
optional string
offset
optional integer
limit
optional integer
x_id
optional string
x_property_id
optional string
x_unit_id
optional string
location_id
optional string
unit_id
optional string
resident_id
optional string
property_id
optional string
integration_id
optional string
integration_vendor
optional enum

Response

This endpoint return an object.
meta
object
results
list of objects
GET
/v1/leases
curl https://api.propexo.com/v1/leases \
-H "Authorization: Bearer <token>"
Response
{
"meta": {
"orderBy": [
{}
],
"offset": 1,
"limit": 1,
"hasMore": true,
"total": 1
},
"results": [
{
"id": "id",
"created_at": "created_at",
"updated_at": "updated_at",
"x_id": "x_id",
"x_property_id": "x_property_id",
"property_id": "property_id",
"integration_id": "integration_id",
"integration_vendor": "BUILDIUM",
"last_seen": "last_seen",
"x_resident_id": "x_resident_id",
"x_unit_id": "x_unit_id",
"residents_meta_data": [
{
"resident_id": "resident_id"
}
],
"application_date": "application_date",
"deposit_amount": "deposit_amount",
"deposit_amount_in_cents": 1.1,
"deposit_date": "deposit_date",
"end_date": "end_date",
"realized_move_in_date": "realized_move_in_date",
"realized_move_out_date": "realized_move_out_date",
"rent_amount_in_cents": 1.1,
"rent_amount_market_in_cents": 1.1,
"rent_due_day": 1,
"rent_due_date": "rent_due_date",
"scheduled_move_in_date": "scheduled_move_in_date",
"scheduled_move_out_date": "scheduled_move_out_date",
"signature_date": "signature_date",
"start_date": "start_date",
"status": "status",
"status_normalized": "ACTIVE",
"status_raw": "status_raw",
"term": "term",
"type": "type",
"unit_number": "unit_number",
"unit_id": "unit_id"
}
]
}