user: reminderView
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.
Return a list of event reminders in a user calendar within the specified start and end times.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Calendars.Read, Calendars.ReadWrite |
Delegated (personal Microsoft account) | Calendars.Read, Calendars.ReadWrite |
Application | Calendars.Read, Calendars.ReadWrite |
HTTP request
GET /users/{id | userPrincipalName}/reminderView(startDateTime=startDateTime-value,endDateTime=endDateTime-value)
Function parameters
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". |
Request headers
Header | Value |
---|---|
Authorization | Bearer {token}. Required. |
Content-Type | application/json |
Prefer | {Time-zone}. Optional, UTC assumed if absent. |
Request body
Do not supply a request body for this method.
Response
If successful, this method returns 200 OK
response code and reminder collection object in the response body.
Example
Here is an example of how to call this API.
Request
Here is an example of the request.
GET https://graph.microsoft.com/beta/me/reminderView(startDateTime='2017-06-05T10:00:00.0000000',endDateTime='2017-06-11T11:00:00.0000000')
Response
Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
HTTP/1.1 200 OK
Content-type: application/json
Content-length: 673
{
"@odata.context": "https://graph.microsoft.com/beta/$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"
}
}
]
}
Feedback
Loading feedback...