List calendarGroups

Get the user's calendar groups.

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}/calendarGroups

Optional query parameters

This method supports the OData Query Parameters to help customize the response.

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and collection of CalendarGroup objects in the response body.

Example

Request

Here is an example of the request.

GET https://graph.microsoft.com/v1.0/me/calendarGroups
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: 155

{
  "value": [
    {
      "name": "name-value",
      "classId": "classId-value",
      "changeKey": "changeKey-value",
      "id": "id-value"
    }
  ]
}