---
title: Google Groups
description: Manage Google Workspace Groups and their members
---

import { BlockInfoCard } from "@/components/ui/block-info-card"

<BlockInfoCard 
  type="google_groups"
  color="#E8F0FE"
/>

## Usage Instructions

Connect to Google Workspace to create, update, and manage groups and their members using the Admin SDK Directory API.



## Tools

### `google_groups_list_groups`

List all groups in a Google Workspace domain

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `customer` | string | No | Customer ID or "my_customer" for the authenticated user\'s domain |
| `domain` | string | No | Domain name to filter groups by |
| `maxResults` | number | No | Maximum number of results to return \(1-200\) |
| `pageToken` | string | No | Token for pagination |
| `query` | string | No | Search query to filter groups \(e.g., "email:admin*"\) |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `groups` | json | Array of group objects |
| `nextPageToken` | string | Token for fetching next page of results |

### `google_groups_get_group`

Get details of a specific Google Group by email or group ID

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group email address or unique group ID |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `group` | json | Group object |

### `google_groups_create_group`

Create a new Google Group in the domain

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `email` | string | Yes | Email address for the new group \(e.g., team@yourdomain.com\) |
| `name` | string | Yes | Display name for the group |
| `description` | string | No | Description of the group |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `group` | json | Created group object |

### `google_groups_update_group`

Update an existing Google Group

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group email address or unique group ID |
| `name` | string | No | New display name for the group |
| `description` | string | No | New description for the group |
| `email` | string | No | New email address for the group |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `group` | json | Updated group object |

### `google_groups_delete_group`

Delete a Google Group

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group email address or unique group ID to delete |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success message |

### `google_groups_list_members`

List all members of a Google Group

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group email address or unique group ID |
| `maxResults` | number | No | Maximum number of results to return \(1-200\) |
| `pageToken` | string | No | Token for pagination |
| `roles` | string | No | Filter by roles \(comma-separated: OWNER, MANAGER, MEMBER\) |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `members` | json | Array of member objects |
| `nextPageToken` | string | Token for fetching next page of results |

### `google_groups_get_member`

Get details of a specific member in a Google Group

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group email address or unique group ID |
| `memberKey` | string | Yes | Member email address or unique member ID |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `member` | json | Member object |

### `google_groups_add_member`

Add a new member to a Google Group

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group email address or unique group ID |
| `email` | string | Yes | Email address of the member to add |
| `role` | string | No | Role for the member \(MEMBER, MANAGER, or OWNER\). Defaults to MEMBER. |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `member` | json | Added member object |

### `google_groups_remove_member`

Remove a member from a Google Group

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group email address or unique group ID |
| `memberKey` | string | Yes | Email address or unique ID of the member to remove |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success message |

### `google_groups_update_member`

Update a member

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group email address or unique group ID |
| `memberKey` | string | Yes | Member email address or unique member ID |
| `role` | string | Yes | New role for the member \(MEMBER, MANAGER, or OWNER\) |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `member` | json | Updated member object |

### `google_groups_has_member`

Check if a user is a member of a Google Group

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group email address or unique group ID |
| `memberKey` | string | Yes | Member email address or unique member ID to check |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `isMember` | boolean | Whether the user is a member of the group |



## Notes

- Category: `tools`
- Type: `google_groups`
