List leases
buildium_list_leasesList leases with unit, dates, lease type/status, current tenants, rent/deposit account details and eviction flag. Filter by property, owner, unit number, tenant name, dates, lease type or status (Active/Past/Future). Buildium: GET /v1/leases.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max results, 1-1000 (Buildium default 50). | |
| offset | No | Zero-based record offset for paging (default 0). | |
| orderby | No | Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object. | |
| created_to | No | Created on or before — YYYY-MM-DD HH:MM:SS. | |
| lease_types | No | Lease types. | |
| tenant_name | No | A current tenant's name contains this value. | |
| unit_number | No | Unit number contains this value. | |
| created_from | No | Created on or after — YYYY-MM-DD HH:MM:SS. | |
| property_ids | No | Filter to these property ids. | |
| lease_date_to | No | Lease end date on or before — formatted YYYY-MM-DD. | |
| lease_statuses | No | Lease term statuses. | |
| last_updated_to | No | Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ. | |
| lease_date_from | No | Lease start date on or after — formatted YYYY-MM-DD. | |
| rental_owner_ids | No | Filter to these rental owner ids. | |
| last_updated_from | No | Updated on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ. |