Buildium Lease Roster
buildium_lease_rosterList tenants on each lease and count co-tenants. Avoids Buildium's missing lease-tenant filter by inverting tenant records.
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 reads them and inverts the mapping locally.
Every matching tenant is read, following pagination; complete says
whether that covered them all. Above 300 leases only the counts are
returned (multi_tenant_lease_count and friends); narrow with property_id
or lease_id for lease ids and names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Page size used while reading tenants, 1-1000. It does not cap the roster. | |
| lease_id | No | Only this lease. Reads just that lease's unit: two requests however large the account. | |
| property_id | No | Only this rental property. | |
| lease_status | No | Active, Past or Future: only tenants with a lease term in that state. Active is usually what "who lives here" means, and skips years of past tenants. | |
| exclude_fixtures | No | Leave out tenants created by test tooling, 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 | |||