List applicants
buildium_list_applicantsList rental applicants with contact details, status and their applications. Filter by application status, unit, name, email, submission date or entity. Buildium: GET /v1/applicants.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Applicant name contains this value. | |
| No | Email contains this value. | ||
| limit | No | Max results, 1-1000 (Buildium default 50). | |
| 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. | |
| entity_id | No | Property or rental owner id (per entity_type). | |
| entity_type | No | Scope by entity type; required with entity_id. | |
| submitted_to | No | Application submitted on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ. | |
| submitted_from | No | Application submitted on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ. | |
| last_updated_to | No | Updated on or before — UTC, formatted YYYY-MM-DDTHH:MM:SSZ. | |
| last_updated_from | No | Updated on or after — UTC, formatted YYYY-MM-DDTHH:MM:SSZ. | |
| application_statuses | No | Application statuses. |