user: reminderView
Namespace: microsoft.graph Return a list of event reminders in a user calendar within the specified start and end times.
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, Calendars.ReadWrite |
Delegated (personal Microsoft account) | Calendars.ReadBasic | Calendars.Read, Calendars.ReadWrite |
Application | Calendars.ReadBasic | Calendars.Read, Calendars.ReadWrite |
GET /users/{id | userPrincipalName}/reminderView(startDateTime={startDateTime-value},endDateTime={endDateTime-value})
In the request URL, provide the following function parameters with values.
Parameter | Type | Description |
---|---|---|
startDateTime | String | The start date and time of the event for which the reminder is set up. The value is represented in ISO 8601 format, for example, "2015-11-08T19:00:00.0000000". |
endDateTime | String | The end date and time of the event for which the reminder is set up. The value is represented in ISO 8601 format, for example, "2015-11-08T20:00:00.0000000". |
Header | Value |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json |
Prefer | {Time-zone}. Optional, UTC assumed if absent. |
Don't supply a request body for this method.
If successful, this method returns 200 OK
response code and reminder collection object in the response body.
Here is an example of how to call this API.
The following example shows a request.
GET https://graph.microsoft.com/v1.0/me/reminderView(startDateTime='2017-06-05T10:00:00.0000000',endDateTime='2017-06-11T11:00:00.0000000')
The following example shows the response. Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.reminder)",
"value": [
{
"eventId": "AAMkADNsvAAA=",
"changeKey": "SuFHwDRP1EeXJUopWbSLlgAAmBvk2g==",
"eventSubject": "Plan summer company picnic",
"eventWebLink": "https://outlook.office365.com/owa/?itemid=AAMkADNsvAAA%3D&exvsurl=1&path=/calendar/item",
"eventStartTime": {
"dateTime": "2017-06-09T18:00:00.0000000",
"timeZone": "UTC"
},
"eventEndTime": {
"dateTime": "2017-06-09T19:00:00.0000000",
"timeZone": "UTC"
},
"eventLocation": {
"displayName": "Conf Room 3"
},
"reminderFireTime": {
"dateTime": "2017-06-09T17:45:00.0000000",
"timeZone": "UTC"
}
}
]
}