Get group

Get the properties and relationships of a group object.

Default properties

The following represent the default set of properties that are returned when getting or listing groups. These are a subset of all available properties.

  • description
  • displayName
  • groupTypes
  • id
  • mail
  • mailEnabled
  • mailNickname
  • onPremisesLastSyncDateTime
  • onPremisesSecurityIdentifier
  • onPremisesSyncEnabled
  • proxyAddresses
  • securityEnabled
  • visibility

The following group properties are not returned by default:

  • allowExternalSenders
  • autoSubscribeNewMembers
  • isSubscribedByMail
  • unseenCount

To get these properties, use the $select query parameter. The following are examples:

GET https://graph.microsoft.com/v1.0/groups/c28c1cc9-e1ab-4c4d-98d1-d8fdf128b60f?$select=allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount

GET https://graph.microsoft.com/v1.0/groups/c28c1cc9-e1ab-4c4d-98d1-d8fdf128b60f?$select=description,allowExternalSenders

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) Group.Read.All, Group.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Group.Read.All, Group.ReadWrite.All

HTTP request

GET /groups/{id}

Optional query parameters

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

Request headers

Name Type Description
Authorization string Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and group object in the response body.

Example

Request

Here is an example of the request.

GET https://graph.microsoft.com/v1.0/groups/{id}
Response

Here is an example of the response.

Note: The response object shown here may be truncated for brevity. The default properties will be returned from an actual call, as described above.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: xxx

{
  "id": "id-value",
  "description": "description-value",
  "displayName": "displayName-value",
  "groupTypes": [
    "groupTypes-value"
  ],
  "mail": "mail-value",
  "mailEnabled": true,
  "mailNickname": "mailNickname-value",
  "onPremisesLastSyncDateTime": "onPremisesLastSyncDateTime-value",
  "onPremisesSecurityIdentifier": "onPremisesSecurityIdentifier-value",
  "onPremisesSyncEnabled": true,
  "proxyAddresses": [
    "proxyAddresses-value"
   ],
   "securityEnabled": true,
   "visibility": "visibility-value"
}