List Tenants
list_tenantsList tenants for a property or portfolio.
status filter: 'Current' | 'Past' | 'All'. include_contacts embeds contact records (slower; surfaces primary email/phone).
location (optional): a Rent Manager Location ID, a comma-separated list,
or "all" to run across every Location on this connection (see
list_locations). Blank = all Locations if the connection has several, else its only Location. Output
is labelled per Location; a Location that can't be reached is listed as
skipped.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | All | |
| location | No | ||
| portfolio | No | ||
| shortname | No | ||
| property_id | No | ||
| property_ids | No | ||
| include_contacts | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |