Method: groups.get

Retrieves a group's properties.

HTTP request

GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
groupKey

string

Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Group.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.readonly

For more information, see the OAuth 2.0 Overview.