Buildium Lease Roster
buildium_lease_rosterGet the lease-to-tenant roster: list who is on a lease and count co-tenants, with optional filters for property and exclusion of test fixtures. Solves Buildium's missing tenant names in lease lists.
Instructions
Who is on which lease — the lease-to-tenant join, done in one call.
Use this for any "who lives in / who is on lease X" question, and for counting co-tenants.
Buildium makes this awkward: the lease list does not reliably populate tenant names, and the tenant endpoint has no lease filter — so answering it directly means pulling every lease one at a time. Tenant records do carry their lease membership, so this fetches them once and inverts the mapping locally.
lease_id: restrict to a single lease property_id: restrict to leases at one property exclude_fixtures: drop tenants created by test tooling (names starting with the fixture prefix — see buildium_health). This sandbox accumulates such records permanently, because Buildium offers DELETE on only 14 of its 462 operations. When any are present the response says so, so a count is never silently wrong.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| lease_id | No | ||
| property_id | No | ||
| exclude_fixtures | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||