Method: members.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see Troubleshoot error codes.
HTTP request
GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members
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.
|
Query parameters
| Parameters |
includeDerivedMembership |
boolean
Whether to list indirect memberships. Default: false.
|
maxResults |
integer
Maximum number of results to return. Max allowed value is 200.
|
pageToken |
string
Token to specify 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.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"kind": string,
"etag": string,
"members": [
{
object (Member)
}
],
"nextPageToken": string
} |
| Fields |
kind |
string
Kind of resource this is.
|
etag |
string
ETag of the resource.
|
members[] |
object (Member)
A list of member objects.
|
nextPageToken |
string
Token used to access next page of this result.
|
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.member
https://www.googleapis.com/auth/admin.directory.group.member.readonly
https://www.googleapis.com/auth/admin.directory.group.readonly
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Method: members.list\n\nRetrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n\n### Query parameters\n\n| Parameters ||\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| `includeDerivedMembership` | `boolean` Whether to list indirect memberships. Default: false. |\n| `maxResults` | `integer` Maximum number of results to return. Max allowed value is 200. |\n| `pageToken` | `string` Token to specify next page in the list. |\n| `roles` | `string` The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"members\": [ { object (/workspace/admin/directory/reference/rest/v1/members#Member) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `members[]` | `object (`[Member](/workspace/admin/directory/reference/rest/v1/members#Member)`)` A list of member objects. |\n| `nextPageToken` | `string` Token used to access next page of this result. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/groups/`\n- `\n https://www.googleapis.com/auth/admin.directory.group`\n- `\n https://www.googleapis.com/auth/admin.directory.group.member`\n- `\n https://www.googleapis.com/auth/admin.directory.group.member.readonly`\n- `\n https://www.googleapis.com/auth/admin.directory.group.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
