Search properties
search_propertiesSearch property marketing roles by address or postcode with filters for on-market, role type, and role status. Returns property ID, address, prices, and owning group.
Instructions
Search the agency's property marketing roles (a property being sold or let) by free text such as an address fragment or postcode, optionally only those on the market, of one role type (documented examples: Sales, Letting) or in one role status (documented examples: OfferAccepted, Exchanged). Each result carries the property ID, address, the role with its status, prices, a summary line and the owning group. Uses GET /api/role/suggest; the role type and status values are system names the swagger does not enumerate.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | API page number to start from (1-based, as this server assumes; use next_page from a previous call) | |
| query | No | Free-text search (API parameter `dataContract.query`) | |
| role_type | No | Role type system name, e.g. Sales or Letting (`dataContract.roleType`) | |
| max_results | No | Most records to return in this call; whole API pages only, so fewer may come back with a next_page to continue from | |
| role_status | No | Role status system name, e.g. OfferAccepted (`dataContract.roleStatus`) | |
| is_on_market | No | Only roles currently on the market (`dataContract.isOnMarket`) | |
| suggest_type | No | The two values the spec documents for `dataContract.suggestType` | |
| include_contact_details | No | Include the owning group's members' email addresses, phone numbers and postal addresses, and stop redacting emails and phone numbers from names and summary text. Off by default. |