Buildium List Leases
buildium_list_leasesRetrieve leases filtered by status, property, or pagination. Each lease shows monthly rent and lease dates directly, so you can get lease terms without transaction lookups.
Instructions
List leases. lease_status is one of Active, Future, Past, Expired.
Each row already carries the rent terms under AccountDetails (including
AccountDetails.Rent, the recurring monthly amount) and the lease dates.
You do NOT need to open the transaction ledger to read a lease's rent —
buildium_list_lease_transactions is for actual posted charges and payments,
which is a different question.
For who is on each lease, use buildium_lease_roster.
Set all_pages=true when counting or aggregating across every lease.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| fields | No | ||
| offset | No | ||
| all_pages | No | ||
| property_id | No | ||
| lease_status | No | ||
| exclude_fixtures | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||