NYnylas
Group Events

Get all group events

Changed on

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

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

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    HTTP bearer

Query parameters

calendar_idstring required

Filter for the specified calendar ID.

(Not supported for iCloud) You can use primary to query the user's primary calendar.

For an Agent Account, you can also pass the account's own email address, in any letter case, to query its primary calendar. Any other email address returns a 400 error.

start_timeinteger required

Filter for events that start at or after the specified time, in seconds using the Unix timestamp format. For example, if you filter for events that start at 9:00a.m. and the calendar includes an event that runs from 8:30–9:30a.m., Nylas returns that event.

end_timeinteger required

Filter for events that end at or before the specified time, in seconds using the Unix timestamp format. For example, if you filter for events that end at 5:00p.m. and the calendar includes an event that runs from 4:30–5:30p.m., Nylas returns that event.

Response

Group events returned

request_idstring

The request ID.

next_cursorstring nullable

A cursor pointing to the next page of results for the request.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
  "next_cursor": "CigKGjRlaDdyNGQydTFqbWJ0bGo5a2QxdWJtdDZnGAEggIDAu7fw7bEYGg8IABIAGPjh2PGEi_0CIAEiBwgCEOqs6i4="
}

Changes

  • a669a04b02baRevision changes
    • breaking

      the //// response's property type changed from object to array for status

    • breaking

      the /// response's property type changed from array to object for status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added subschema #1: Auto-conferencing subschema #2: Google Meet subschema #3: Zoom Meeting subschema #4: Microsoft Teams subschema #5: Teams for Business subschema #6: Skype for Consumer subschema #7: Skype for Business subschema #8: WebEx subschema #9: GoToMeeting subschema #10: Remove conferencing to the /// response property anyOf list for the response status

    • info

      removed subschema #1: Auto-conferencing subschema #2: Google Meet subschema #3: Zoom Meeting subschema #4: Microsoft Teams subschema #5: Teams for Business subschema #6: Skype for Consumer subschema #7: Skype for Business subschema #8: WebEx subschema #9: GoToMeeting from the /// response property oneOf list for the response status

  • 763d6b969cd7Revision changes
    • info

      added the optional property / to the response with the status