Buildium List Leases
buildium_list_leasesList rental leases with rent amounts and lease dates. Filter by property or status, count records, or fetch all pages for totals.
Instructions
List leases.
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.
To count, use count_only; for totals, all_pages.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Records per page, 1-1000. | |
| fields | No | Keep only these top-level fields in each record, e.g. ["Id", "Name"]. Buildium records are large and carry tax IDs and addresses you may not need. | |
| offset | No | How many records to skip. Use next_offset from the previous page. | |
| all_pages | No | Follow pagination and return the records, up to 1000. Use it for totals and other aggregates; a figure from one page is wrong whenever there is more than one page. | |
| count_only | No | Follow every page, up to 100,000 records, and return only how many there are. Use it for "how many" questions. | |
| property_id | No | Only this rental property. | |
| lease_status | No | Active, Future, Past or Expired. | |
| exclude_fixtures | No | Leave out test records, whose names start with the fixture prefix (see buildium_health). When any are present the response says so either way. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||