Get group

• 6/10/2019
• 3 minutes to read
• Contributors
  • 
  • 
  • 
  • 
  • 
  • all

Get the properties and relationships of a group object.

This operation returns by default only a subset of all the available properties, as noted in the Properties section. To get properties that are not returned by default, specify them in a $select OData query option. See an example of $select. An exception is the hasMembersWithLicenseErrors property. See an example of how to use this property.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

HTTP request

GET /groups/{id}

Optional query parameters

You can use $select to get specific group properties, including those that are not returned by default. See an example below.

For more information on OData query options, see OData Query Parameters.

Request headers

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. It returns the default properties unless you use $select to specify specific properties.

Example

Request 1

The following is an example of a GET request.

GET https://graph.microsoft.com/v1.0/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd

Response 1

The following is an example of the response. It includes only the default properties.

Note: The response object shown here might be shortened for readability. All the default properties are returned in an actual call.

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

{
    "id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
    "deletedDateTime": null,
    "classification": null,
    "createdDateTime": "2018-12-22T00:51:37Z",
    "creationOptions": [],
    "description": "Self help community for library",
    "displayName": "Library Assist",
    "groupTypes": [
        "Unified"
    ],
    "mail": "library2@contoso.com",
    "mailEnabled": true,
    "mailNickname": "library",
    "onPremisesLastSyncDateTime": null,
    "onPremisesSecurityIdentifier": null,
    "onPremisesSyncEnabled": null,
    "preferredDataLocation": "CAN",
    "proxyAddresses": [
        "smtp:library7423@contoso.com",
        "SMTP:library2@contoso.com"
    ],
    "renewedDateTime": "2018-12-22T00:51:37Z",
    "resourceBehaviorOptions": [],
    "resourceProvisioningOptions": [],
    "securityEnabled": false,
    "visibility": "Public",
    "onPremisesProvisioningErrors": []
}

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var group = await graphClient.Groups["b320ee12-b1cd-4cca-b648-a437be61c5cd"]
	.Request()
	.GetAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

let res = await client.api('/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd')
	.get();

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

Request 2

The next example uses a $select query option to get a few properties that are not returned by default.

GET https://graph.microsoft.com/v1.0/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd?$select=allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount

Response 2

The following is an example of the response which includes the requested non-default properties.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups(allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount)/$entity",
    "id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
    "allowExternalSenders": false,
    "autoSubscribeNewMembers": false,
    "isSubscribedByMail": false,
    "unseenCount": 0
}

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var group = await graphClient.Groups["b320ee12-b1cd-4cca-b648-a437be61c5cd"]
	.Request()
	.Select( e => new {
			 e.AllowExternalSenders,
			 e.AutoSubscribeNewMembers,
			 e.IsSubscribedByMail,
			 e.UnseenCount 
			 })
	.GetAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

let res = await client.api('/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd')
	.select('allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount')
	.get();

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.