Retrieve multiple Calendar events.

The start time as a UNIX timestamp to use as a beginning bound. Pagination for this endpoint is handled via the start_time parameter. The API will return the next 50 events, in addition to all events on the first and last day of the range.

A search string.

The group ID to limit results by.

To search for events a particular guest is on, include a string in the format [object_type_id]_[object_id].

The staff ID of the event owner to limit events by.

The collection mode.

Options include:

events: This is the default option. This mode's pagination is controlled by the start_time parameter, and will return 50 events per page, plus all of the other events on the first and last day of the page. Events spanning multiple days will be represented by an event on each day of the date range.

subcollection: This option mimics the subcollection in the Ontraport app. This mode's pagination is controlled by start_time and the relative_paginate parameter, and will return 25 events per page, plus all of the other events on the first and last day of the page. Events spanning multiple days will be represented by a single event record.

bullets: This mode's pagination is controlled by the start_time parameter, and will return for the entire relevant month the day numbers that have existing events. No other event data is returned for this option.

submenu: This option does not allow for pagination and will return a list of event IDs from the context of today, with all events up to one month in the past and six months in the future. No other filter applies to the submenu.

recents: Returns the ten most recently edited events.

Used in conjunction with the start_time parameter in subcollection mode.