Skip to main content

outlook calendar get

Retrieves the calendar of a user or a group.

Usage​

m365 outlook calendar get [options]

Options​

-i, --id [id]

ID of the calendar. Specify either id or name, but not both.

-n, --name [name]

Name of the calendar. Specify either id or name, but not both.

--userId [userId]

ID of the user. Specify either userId or userName, but not both.

--userName [userName]

UPN of the user. Specify either userId or userName, but not both.

--calendarGroupId [calendarGroupId]

ID of the calendar group. Specify either calendarGroupId or calendarGroupName, but not both.

--calendarGroupName [calendarGroupName]

Name of the calendar group. Specify either calendarGroupId or calendarGroupName, but not both.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, permissions, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Permissions​

ResourcePermissions
Microsoft GraphCalendar.ReadBasic

Examples​

Get the calendar for the current signed-in user by id.

m365 outlook calendar get --userId "@meId" --id "AAMkAGI2TGuLAAA="

Get the calendar from a specific calendar group for the current signed-in user by name.

m365 outlook calendar get --userId "@meId" --calendarGroupName "Colleague calendars" --name "Calendar"

Get the calendar from a specific calendar group for a specific user by name.

m365 outlook calendar get --userId b743445a-112c-4fda-9afd-05943f9c7b36 --calendarGroupId "AAMkADIxYjJiYmIzLTFmNjYtNGNhMy0YOkcEEh3vhfAAAGgdFjAAA="  --name "Calendar"

Response​

{
  "id": "AQMkAGRAAAA==",
  "name": "Calendar",
  "color": "lightOrange",
  "hexColor": "#f7630c",
  "groupClassId": "0006f0b7-0000-0000-c000-000000000046",
  "isDefaultCalendar": true,
  "changeKey": "fJKVL07sbkmIfHqjbDnRgQAACWzbtQ==",
  "canShare": true,
  "canViewPrivateItems": true,
  "canEdit": true,
  "allowedOnlineMeetingProviders": [
    "teamsForBusiness"
  ],
  "defaultOnlineMeetingProvider": "teamsForBusiness",
  "isTallyingResponses": true,
  "isRemovable": false,
  "owner": {
    "name": "John Doe",
    "address": "john.doe@contoso.com"
  }
}