list_tenants
Fetch tenant contact details from Rentvine, including name, email, phone, and address. Filter by search or active status, and include sensitive PII only when required.
Instructions
List all tenants from Rentvine (live data). Returns contact ID, full name and name components, email, phone, address, active status, linked applicant ID, and audit timestamps. Use this to look up a tenant's contact details or to get a contact_id for other calls. Filter with search (matches name, email, or phone) and active_only. By default this omits personally sensitive fields; set include_sensitive=true only when the task actually requires them — see that parameter's description.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, passed through to Rentvine. This endpoint's paging behavior is unverified. | |
| search | No | Case-insensitive substring filter matched against name, email, and phone. Applied client-side after fetching. | |
| page_size | No | Results per page, passed through to Rentvine as pageSize. This endpoint's paging behavior is unverified; if unsupported, Rentvine's default page size applies and results may be truncated. | |
| active_only | No | If true, return only tenants with isActive=1. Defaults to false (returns all tenants, active and inactive). | |
| include_sensitive | No | If true, additionally return date of birth, government identification number and type, tax/payee details, and payout/ACH banking fields. Defaults to false. Tenants share Rentvine's contact schema with vendors, so these fields exist on every tenant record — leave this off unless the task genuinely requires them, and treat any output as confidential PII. |