Group events
get_group_eventsRetrieve a household or company group's CRM timeline of viewings, offers, notes, appointments, and other events, filtered by date, type, property, role, drafts, and cancellations.
Instructions
The timeline of one group (household or company): viewings, offers, notes, appointments and other events, with the same filters as get_property_events plus the group-only ones: only active roles, one property, one role, and drafts. Uses GET /api/group/{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. | |
| role_id | No | Only events on this role (API parameter `roleId`) | |
| group_id | Yes | Group ID (a positive whole number) | |
| 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 | No | Only events relating to this property (API parameter `propertyId`) | |
| excluded_types | No | Every type except these (API parameter `excludedTypes`, repeated) | |
| include_drafts | No | Include draft events (API parameter `includeDrafts`) | |
| show_cancelled | No | Include cancelled events (API parameter `showCancelled`; the API's default is false) | |
| active_roles_only | No | Only events on the group's active roles (API parameter `activeRolesOnly`) | |
| 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) |