Members: list

Requires authorization

Retrieves a paginated list of all members in a group. Try it now.

Request

HTTP request

GET https://www.googleapis.com/admin/directory/v1/groups/groupKey/members

Parameters

Parameter name	Value	Description
Path 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.
Optional query parameters
includeDerivedMembership	boolean	Whether to list indirect memberships. Default: false.
maxResults	integer	Maximum number of results to return. Default is 200.
pageToken	string	Token to specify the next page in the list.
roles	string	The roles query parameter allows you to retrieve group members by role. Allowed values are OWNER, MANAGER, and MEMBER.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/admin.directory.group.member.readonly
https://www.googleapis.com/auth/admin.directory.group.member
https://www.googleapis.com/auth/admin.directory.group.readonly
https://www.googleapis.com/auth/admin.directory.group

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "admin#directory#members",
  "etag": etag,
  "members": [
    members Resource
  ],
  "nextPageToken": string
}

Property name	Value	Description	Notes
kind	string	The type of the API resource. For Members resources, this value is admin#directory#member.
members[]	list	List of member objects.
nextPageToken	string	Token used to access next page of this result.
etag	etag	ETag of the resource.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.