List lettings applicants
street_list_lettings_applicantsList lettings applicants (prospective tenants: budget, bedrooms, areas, furnished, lead rating). Newest first as Street orders them; page with page and page_size. GET /lettings-applicants.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| areas | No | Area names (see street_list_areas). | |
| branch | No | Only applicants of this branch (branch UUID, see street_list_branches). | |
| include | No | Related records to embed in "included". Allowed: branch, offers, viewings, people, company, notes, applications, followUps, negotiator. | |
| trashed | No | with = include deleted records, only = only deleted ones (default: not deleted). | |
| price_to | No | Maximum budget. | |
| furnished | No | Only applicants who do (true) or do not (false) require furnished. | |
| page_size | No | Results per page, 1-100 (default 25). | |
| created_to | No | Only records created before this date-time. | |
| price_from | No | Minimum budget. | |
| updated_to | No | Only records updated before this date-time. | |
| lead_rating | No | Lead ratings to include (hot, warm, cold). | |
| created_from | No | Only records created after this date-time. | |
| min_bedrooms | No | Minimum bedrooms they need. | |
| updated_from | No | Only records updated after this date-time (use it to sync changes). | |
| follow_ups_due_to | No | Only applicants with a follow-up due before this date. | |
| follow_ups_due_from | No | Only applicants with a follow-up due after this date. |