Buildium List Rentals
buildium_list_rentalsList rental properties from Buildium by selecting fields, counting records, or fetching all pages for totals.
Instructions
List rental properties. Pass fields to narrow large records.
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. | |
| 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 | |||