Find people
find_peopleSearch a Dezrez Rezi estate agency CRM for people by surname, postcode, email, telephone, or mobile number; at least one field is required. Returns names by default, contact details optional.
Instructions
Search people by surname, postcode, email address, telephone and/or mobile number, exactly the fields GET /api/people/findbydetails accepts; at least one is required. Results are returned as get_person returns them: names by default, contact details only with include_contact_details. Note that searching by an email or number and getting a match confirms that detail exists on the account even when it is not returned.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Email address (API parameter `email`) | ||
| mobile | No | Mobile number (API parameter `mobile`) | |
| surname | No | Surname (API parameter `surname`) | |
| postcode | No | Postcode (API parameter `postcode`) | |
| telephone | No | Main telephone number (API parameter `telephone`) | |
| max_results | No | Most people to return; the API has no paging on this endpoint, so the rest are dropped and reported | |
| include_contact_details | No | Include email addresses, phone numbers, postal addresses, notes and identity details. Off by default. |