List properties
street_list_propertiesList properties (sales and lettings listings, with address, status, price, bedrooms and the owner link). Newest first as Street orders them; page with page and page_size. GET /properties.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| tags | No | Agent-entered tag in lowercase; separate several with a semicolon for any of them. | |
| branch | No | Only properties of this branch (branch UUID, see street_list_branches). | |
| status | No | Property statuses to include. | |
| address | No | Fuzzy match on the full address text. | |
| include | No | Related records to embed in "included". Allowed: activeTenancy, branch, brochure, epc, floorplans, followUp, interestedApplicants, invoices, lettingsApplications, lettingsListing, lettingsOffers, media, negotiator, notes, outsideSpaces, owner, owner.company, owner.people, parking, propertyKeys, rooms, rooms.media, sales, salesListing, salesOffers, tenancies, valuations, viewings. | |
| trashed | No | with = include deleted records, only = only deleted ones (default: not deleted). | |
| bedrooms | No | Exact number of bedrooms. | |
| category | No | sales or lettings. | |
| postcode | No | First or partial postcode: M, M1 1JU or the sector M28 2. | |
| page_size | No | Results per page, 1-100 (default 25). | |
| created_to | No | Only records created before this date-time. | |
| updated_to | No | Only records updated before this date-time. | |
| created_from | No | Only records created after this date-time. | |
| min_bedrooms | No | Minimum number of bedrooms. | |
| updated_from | No | Only records updated after this date-time (use it to sync changes). | |
| max_price_sales | No | Maximum sales listing price. | |
| min_price_sales | No | Minimum sales listing price. | |
| include_archived | No | Include archived properties. | |
| max_price_lettings | No | Maximum lettings listing price. | |
| min_price_lettings | No | Minimum lettings listing price. |