Events
Mar 17, 9 PM - Mar 21, 10 AM
Join the meetup series to build scalable AI solutions based on real-world use cases with fellow developers and experts.
Register nowThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Namespace: microsoft.graph
Get the instances (occurrences) of an event for a specified time range.
If the event is a seriesMaster
type, this API returns the
occurrences and exceptions of the event in the specified time range.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Calendars.ReadBasic | Calendars.Read |
Delegated (personal Microsoft account) | Calendars.ReadBasic | Calendars.Read |
Application | Calendars.ReadBasic | Calendars.Read |
GET /me/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /groups/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /groups/{id}/calendar/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /me/calendarGroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}
In the request URL, provide the following required query parameters with values.
Parameter | Type | Description |
---|---|---|
startDateTime | String | The start date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T19:00:00.0000000". |
endDateTime | String | The end date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T20:00:00.0000000". |
This method supports the OData Query Parameters to help customize the response.
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. Learn more about authentication and authorization. |
Prefer: outlook.timezone | string | Use this to specify the time zone for start and end times in the response. If not specified, those time values are returned in UTC. Optional. |
Don't supply a request body for this method.
If successful, this method returns a 200 OK
response code and collection of Event objects in the response body.
The following example gets the occurrences and exceptions of a master event for a recurring series, within a specified time range.
GET https://graph.microsoft.com/v1.0/me/events/AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAENAAAiIsqMbYjsT5e-T7KzowPTAAAa_WKzAAA=/instances?startDateTime=2019-04-08T09:00:00.0000000&endDateTime=2019-04-30T09:00:00.0000000&$select=subject,bodyPreview,seriesMasterId,type,recurrence,start,end
The following example shows the response.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('bb8775a4-4d8c-42cf-a1d4-4d58c2bb668f')/events('AAMkAGUzYRgWAAA%3D')/instances(subject,bodyPreview,seriesMasterId,type,recurrence,start,end)",
"value": [
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1sE1TatAAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "Changing meeting from 4/15 to 4/16.",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "exception",
"recurrence": null,
"start": {
"dateTime": "2019-04-16T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-16T21:00:00.0000000",
"timeZone": "UTC"
}
},
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1ru1JMcAAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "occurrence",
"recurrence": null,
"start": {
"dateTime": "2019-04-08T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-08T21:00:00.0000000",
"timeZone": "UTC"
}
},
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1sa1do_AAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "occurrence",
"recurrence": null,
"start": {
"dateTime": "2019-04-22T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-22T21:00:00.0000000",
"timeZone": "UTC"
}
},
{
"@odata.etag": "W/\"x3IAvB5fbUWf4XNcBFLNUwAAKuA3yQ==\"",
"id": "AAMkAGUzYAgI1sw1n3PAAEYAAAAAlNFb2CNPe0ucP9you",
"subject": "Review strategy for Q3",
"bodyPreview": "",
"seriesMasterId": "AAMkAGUzYRgWAAA=",
"type": "occurrence",
"recurrence": null,
"start": {
"dateTime": "2019-04-29T20:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2019-04-29T21:00:00.0000000",
"timeZone": "UTC"
}
}
]
}
Events
Mar 17, 9 PM - Mar 21, 10 AM
Join the meetup series to build scalable AI solutions based on real-world use cases with fellow developers and experts.
Register now