List Group Members

Retrieves a paginated list of all members in a group.

Basic Parameters

Parameter	Description
Customer ID	The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the 'my_customer' alias to represent your account's customer ID. The customer ID is also returned as part of the ListUsers action.
Group Key	Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
Include Derived Membership	Whether to list indirect memberships. Default: false.
Max Results	Maximum number of results to return. Max allowed value is 200.
Page Token	Token to specify next page in the list.
Roles	The roles query parameter allows you to retrieve group members by role. Allowed values are OWNER, MANAGER, and MEMBER.

Advanced Parameters

Parameter	Description
Delegated User Override	Perform the action on behalf of another user, overriding the delegated user defined in the connection. If not specified, the delegated user is the one provided in the connection. Has no effect when using an OAuth connection. NOTE: the connection details are not edited by this input.

Example Output

{
    "etag": "ETag of the resource.",
    "kind": "admin#directory#members",
    "members": [
        {
            "delivery_settings": "Defines mail delivery preferences of member. This is only supported by create/update/get.",
            "email": "The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.",
            "etag": "ETag of the resource.",
            "id": "The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.",
            "kind": "admin#directory#member",
            "role": "The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).",
            "status": "Status of member (Immutable)",
            "type": "The type of group member."
        }
    ],
    "nextPageToken": "Token used to access next page of this result."
}

Workflow Library Example

List Group Members with Google Workspace and Send Results Via Email

Preview this Workflow on desktop