List tenants
buildium_list_tenantsList rental tenants with contact details, emergency contact, address and leases. Filter by name, email, phone, unit number, property, owner, unit ids or lease term status. Buildium: GET /v1/leases/tenants.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Tenant name contains this value. | |
| No | Email contains this value. | ||
| limit | No | Max results, 1-1000 (Buildium default 50). | |
| phone | No | Phone number contains this value. | |
| offset | No | Zero-based record offset for paging (default 0). | |
| orderby | No | Sort, e.g. "Name", "LeaseToDate desc" or "Rent desc,City asc". Any field of the returned object. | |
| unit_ids | No | Filter to these unit ids. | |
| unit_number | No | Unit number contains this value. | |
| property_ids | No | Filter to these property ids. | |
| last_updated_to | No | Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ. | |
| rental_owner_ids | No | Filter to these rental owner ids. | |
| building_statuses | No | Status of the tenant's property. | |
| last_updated_from | No | Updated on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ. | |
| lease_term_statuses | No | Lease term statuses. |