---
title: "Get all group events"
method: GET
path: "/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}/group-events"
tags: ["Group Events"]
---

# Get all group events

`GET /v3/grants/{grant_id}/scheduling/configurations/{configuration_id}/group-events`

## Request

- Base URL: `https://api.us.nylas.com`
- URL: `https://api.us.nylas.com/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}/group-events`
- Auth: HTTP bearer

Returns all group events within the given time range, from the specified Configuration.

## Query parameters

- `calendar_id` string, required
- `start_time` integer, required
- `end_time` integer, required

## Response `200`

Group events returned

- object
  - `request_id` string: The request ID.
  - `data` object[]: The list of objects returned by the request.
    - `capacity` integer: (Not supported for EWS events) The maximum number of attendees allowed in the event.
    - `conferencing` union: An object that lets you automatically create a conference, or enter conferencing details manually. You can't use `autocreate` and `details` in the same request. If you do, Nylas returns an error. Nylas stores conference information in the event description. To remove conference details, set `conferencing` to `{}` and remove the corresponding conference information from the description in the same request.
      - object: Let Nylas autocreate the conference link.
        - `provider` 'Google Meet' | 'Zoom Meeting' | 'Microsoft Teams' | 'Teams for Business', required: The conferencing provider that Nylas uses to create the conference. `Teams for Business` is available for Microsoft grants only.
        - `autocreate` object, required: When you include `autocreate` in your request, Nylas automatically creates the conference for the event and appends the conferencing details to the event description. If the `provider` is `Zoom Meeting`, your Zoom OAuth app must include the following [granular scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-granular/) for Nylas to manage meetings on behalf of the user: - `meeting:write:meeting` — required to **create** Zoom meetings. - `meeting:update:meeting` — required to **update** Zoom meetings (for example, when event time or title changes). - `meeting:delete:meeting` — required to **delete** Zoom meetings (when events are removed). If any of these scopes are missing, the Zoom API rejects the request. After adding scopes to your Zoom app, affected users must re-authenticate their grant so their access tokens include the new scopes.
          - `conf_grant_id` string: The grant ID of the account that hosts the conference. The user that belongs to this grant acts as the conference host: they join the conference at the scheduled time and admit other participants during the meeting. Include `conf_grant_id` when the conferencing `provider` isn't available on the user's own account — for example, when the `provider` is `Google Meet` but the user authenticated with a Microsoft account (cross-provider autocreation). When the `provider` is `Zoom Meeting`, `conf_grant_id` is always required.
          - `conf_settings` object: Optional provider-specific settings that Nylas passes through when it creates the conference. For `Zoom Meeting`, each key is sent as a top-level parameter to [Zoom's Create a Meeting API](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetingCreate) — for example, `agenda`, `password`, or Zoom's own `settings` object. Nylas does _not_ validate these values. They can make your Zoom integration more accessible but potentially less secure, so review your organization's security requirements.
      - object: Manually attach Google Meet details to the event.
        - `provider` 'Google Meet': The conferencing provider for the event.
        - `details` object, required: An object that contains Google Meet conferencing details.
          - `url` string, required: The URL for the Google Meet conference.
          - `phone` string[]: The phone number associated with the Google Meet conference. This array accepts only one phone number.
          - `pin` string: The PIN associated with the Google Meet conference, if applicable.
      - object: Manually attach Zoom Meeting details to the event.
        - `provider` 'Zoom Meeting': The conferencing provider for the event.
        - `details` object, required: An object that contains Zoom conferencing details.
          - `url` string, required: The URL for the Zoom conference.
          - `meeting_code` string, nullable: A unique ID associated with the Zoom conference.
          - `password` string, nullable: The password for the Zoom conference, if applicable.
      - object: Manually attach Microsoft Teams details to the event.
        - `provider` 'Microsoft Teams': The conferencing provider for the event.
        - `details` object, required: An object that contains Microsoft Teams conferencing details.
          - `url` string, required: The URL for the Microsoft Teams conference.
      - object: Manually attach Teams for Business details to the event.
        - `provider` 'Teams for Business': The conferencing provider for the event.
        - `details` object, required: An object that contains Microsoft Teams for Enterprise conferencing details.
          - `url` string, required: The URL for the Microsoft Teams for Enterprise conference.
      - object: Manually attach Skype for Consumer details to the event.
        - `provider` 'Skype for Consumer': The conferencing provider for the event.
        - `details` object, required: An object that contains Skype for Consumer conferencing details.
          - `url` string, required: The URL for the Skype for Consumer conference.
      - object: Manually attach Skype for Business details to the event.
        - `provider` 'Skype for Business': The conferencing provider for the event.
        - `details` object, required: An object that contains Skype for Business conferencing details.
          - `url` string, required: The URL for the Skype for Business conference.
      - object: Manually attach WebEx details to the event.
        - `provider` 'WebEx': The conferencing provider for the event.
        - `details` object, required: An object that contains WebEx conferencing details.
          - `url` string, required: The URL for the WebEx conference.
          - `password` string: The password for the WebEx conference, if applicable.
          - `pin` string: The PIN for the WebEx conference, if applicable.
          - `phone` string[]: The phone number associated with the WebEx conference.
      - object: Manually attach GoToMeeting details to the event.
        - `provider` 'GoToMeeting': The conferencing provider for the event.
        - `details` object, required: An object that contains GoToMeeting conferencing details.
          - `url` string, required: The URL for the GoToMeeting conference.
          - `meeting_code` string: A unique ID associated with the GoToMeeting conference.
          - `password` string: The password for the GoToMeeting conference, if applicable.
          - `phone` string[]: The phone number associated with the GoToMeeting conference.
      - object: An empty object (`{}`). Removes the conferencing details from the event. You must also remove the corresponding conference information from the event `description` in the same request.
    - `description` string: A brief description of the group event (for example, its agenda). Nylas might return the description as an HTML string, depending on how the provider formats it. For Google accounts, this field accepts a maximum of 8,192 characters.
    - `location` string: The location of the group event (for example, a physical address or the name of a meeting room).
    - `participants` GroupEventParticipants[], required
      - `name` string: The participant's name.
      - `email` string, required: The participant's email address.
      - `is_organizer` boolean: When `true`, indicates that the participant is the event organizer.
    - `recurrence` string[]: An array of `RRULE` and `EXDATE` strings. Nylas includes this field only if the event is the main (master) event. See [RFC-5545](https://tools.ietf.org/html/rfc5545#section-3.8.5) for more details. You can use [this tool](https://jkbrzt.github.io/rrule/) to learn more about the `RRULE` spec. Events inherit their timezone from the `when` object. Nylas recommends that you use the `when` object to specify the event's start and end time. Provider specifics: - Agent Accounts and virtual calendars don't support `DTSTART` or `TZID`. Nylas uses the event's `when` values as the start of the series instead. - iCloud accounts do _not_ support recurring events for group events - Microsoft Graph adds one day to the `UNTIL` date.
    - `reminders` EventReminders: A list of reminders to generate for the event. If not defined, Nylas uses the provider's default settings.
      - `use_default` boolean, nullable: When `true`, the event uses the calendar's default reminder settings. This field may be `null` if reminders are not explicitly configured. - **Google**: Generates a `popup`-style reminder 10 minutes before the event begins. - **Microsoft**: Generates a reminder 15 minutes before the event begins. - **iCloud**: Does not generate a reminder. - **EWS**: Generates a `display`-style reminder 15 minutes before the event begins.
      - `overrides` object[], nullable: A list of reminders for the event to use when `use_default` is `false`. If this field is empty or omitted, and `use_default` is `false`, the event does not send reminders. If `true`, Nylas generates both the default event reminder and any reminders in the `overrides` list. You cannot set reminder overrides if `use_default` is `true`. For Microsoft Graph, EWS, and iCloud, you can set only one reminder per event. This field may be `null` if no reminder overrides have been set. Treat `null` the same as an empty array.
        - `reminder_minutes` integer: The number of minutes before the event to display a reminder.
        - `reminder_method` 'popup' | 'email' | 'display' | 'sound': (Google and iCloud only) The method used to notify the user about the event, with separate options and default settings for each provider. - **Google**: - Default: `popup` - Options: `popup`, `email` - **iCloud**: - Default: `display` - Options: `display`, `sound`
    - `title` string: The name of the event.
    - `when` union, required: The time and duration of the event.
      - object: A period of time with a specified beginning and end (for example, an hour-long lunch meeting).
        - `start_time` integer: The event's start time, in seconds using the Unix timestamp format.
        - `end_time` integer: The event's end time, in seconds using the Unix timestamp format.
        - `start_timezone` string, nullable: The timezone of the event's `start_time` as an [IANA-formatted](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) string. If you define `start_timezone` in your request, you must also define `end_timezone`.
        - `end_timezone` string, nullable: The timezone of the event's `end_time` as an [IANA-formatted](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) string. If you define `end_timezone` in your request, you must also define `start_timezone`.
      - object: Read-only placeholder. Returned only in responses.
  - `next_cursor` string, nullable: A cursor pointing to the next page of results for the request.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `429`: Rate limited. The provider or Nylas throttled the request. If a provider throttles a request and says how long to wait, the `Retry-After` header gives that number of seconds. When the header is missing, retry with exponential backoff. See [429 rate limit errors by provider](/docs/api/errors/400-response/#429-rate-limit-errors-by-provider).
- `504`: Provider Failure

## Changes

- **2026-09-29** `a669a04b02ba`: 2 breaking, 4 info
  - the `allOf[#/components/schemas/common_response_with_cursor]/data` response's property type changed from `object` to `array` for status `200`
  - the `allOf[subschema #2]/data/items/reminders` response's property type changed from `array` to `object` for status `200`
  - added the optional property `allOf[subschema #2]/data/items/reminders/overrides` to the response with the `200` status
  - added the optional property `allOf[subschema #2]/data/items/reminders/use_default` to the response with the `200` status
  - …2 more
- **2026-09-26** `763d6b969cd7`: 1 info
  - added the optional property `error/provider_error` to the response with the `429` status

[Operation history](https://skmtc.dev/nylas/apis/nylas-api/changes/v3/grants/:grant_id/scheduling/configurations/:configuration_id/group-events/get.md)

---

[API](https://skmtc.dev/nylas/apis/nylas-api.md) - [All operations](https://skmtc.dev/nylas/apis/nylas-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nylas/apis/nylas-api/revisions/7782a3e3ab70?raw)