Google Groups
Manage Google Workspace Groups and their members
Connect to Google Workspace to create, update, and manage groups and their members using the Admin SDK Directory API.
List all groups in a Google Workspace domain
| 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*") |
| Parameter | Type | Description |
|---|
groups | json | Array of group objects |
nextPageToken | string | Token for fetching next page of results |
Get details of a specific Google Group by email or group ID
| Parameter | Type | Required | Description |
|---|
groupKey | string | Yes | Group email address or unique group ID |
| Parameter | Type | Description |
|---|
group | json | Group object |
Create a new Google Group in the domain
| 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 |
| Parameter | Type | Description |
|---|
group | json | Created group object |
Update an existing Google Group
| 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 |
| Parameter | Type | Description |
|---|
group | json | Updated group object |
Delete a Google Group
| Parameter | Type | Required | Description |
|---|
groupKey | string | Yes | Group email address or unique group ID to delete |
| Parameter | Type | Description |
|---|
message | string | Success message |
List all members of a Google Group
| 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) |
| Parameter | Type | Description |
|---|
members | json | Array of member objects |
nextPageToken | string | Token for fetching next page of results |
Get details of a specific member in a Google Group
| Parameter | Type | Required | Description |
|---|
groupKey | string | Yes | Group email address or unique group ID |
memberKey | string | Yes | Member email address or unique member ID |
| Parameter | Type | Description |
|---|
member | json | Member object |
Add a new member to a Google Group
| 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. |
| Parameter | Type | Description |
|---|
member | json | Added member object |
Remove a member from a Google Group
| 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 |
| Parameter | Type | Description |
|---|
message | string | Success message |
Update a member
| 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) |
| Parameter | Type | Description |
|---|
member | json | Updated member object |
Check if a user is a member of a Google Group
| 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 |
| Parameter | Type | Description |
|---|
isMember | boolean | Whether the user is a member of the group |
- Category:
tools
- Type:
google_groups
