Property events
get_property_eventsRetrieve a property's event timeline—viewings, offers, notes, appointments—and filter by date range, event type, branch, and cancelled status.
Instructions
The timeline of one property: viewings, offers, notes, appointments and other events, newest to oldest as the API returns them, with dates, status, prices, the groups and people attending (names only by default), notes and negotiators. Filter by date range, event type(s), category, branch, and whether cancelled events are included. Uses GET /api/property/{id}/events.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Only events up to this date/time (API parameter `to`, ISO 8601). A date alone means the end of that day, UTC (2026-09-30 is sent as 2026-09-30T23:59:59Z). | |
| from | No | Only events from this date/time (API parameter `from`, ISO 8601). A date alone means the start of that day, UTC (2026-09-01 is sent as 2026-09-01T00:00:00Z). | |
| page | No | API page number to start from (1-based, as this server assumes; use next_page from a previous call) | |
| types | No | Only these event types, as Rezi system names (API parameter `type`, repeated). The swagger does not list the values. | |
| branch_id | No | Only events in this branch (API parameter `branchId`) | |
| 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 | |
| property_id | Yes | Property ID (a positive whole number) | |
| excluded_types | No | Every type except these (API parameter `excludedTypes`, repeated) | |
| show_cancelled | No | Include cancelled events (API parameter `showCancelled`; the API's default is false) | |
| event_category_type | No | Only this event category (API parameter `eventCategoryType`) | |
| include_contact_details | No | Include attendees' and negotiators' email addresses and phone numbers, and stop redacting emails and phone numbers from notes, names and descriptions. Off by default. | |
| include_only_original_notes | No | Skip note editions and return only original notes (API parameter `includeOnlyOriginalNotes`; the API's default is true) |