Google Groups
API actions for the Google Groups integration.
Google Groups
Create and manage Google Groups and their members in your Google Workspace organization.
Add member
Add a person to a Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | The group's email address (or its unique ID). |
member_email | string | Yes | The email address of the person to add. |
role | string | No | The person's role in the group. Owners and managers can manage the group and its members; members can only take part in the group. |
Response
"user@example.com"Create group
Create a new Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | The email address for the new group. |
name | string | Yes | The display name for the group. |
description | string | No | An optional description of what the group is for. |
Response
"01abc234def56789"Delete group
Permanently delete a Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | The group's email address (or its unique ID). |
Response
trueGet group
Get the details of a specific Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | The group's email address (or its unique ID). |
Response
{
"description": "All engineering staff",
"email": "engineering@example.com",
"id": "01abc234def56789",
"name": "Engineering Team"
}List groups
List all Google Groups in your Google Workspace organization.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page_size | number | No | The maximum number of groups to return (1-200). |
Response
[
{
"directMembersCount": "15",
"email": "engineering@example.com",
"id": "01abc234def56789",
"name": "Engineering Team"
}
]List members
List everyone who belongs to a Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | The group's email address (or its unique ID). |
page_size | number | No | The maximum number of members to return (1-200). |
Response
[
{
"email": "user@example.com",
"id": "112233445566778899",
"role": "MEMBER",
"type": "USER"
}
]Remove member
Remove a person from a Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | The group's email address (or its unique ID). |
member_email | string | Yes | The email address of the person to remove. |
Response
trueUpdate group
Update a Google Group's name, description, or email address.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | The group's email address (or its unique ID). |
name | string | No | A new display name for the group. |
description | string | No | A new description for the group. |
new_email | string | No | A new email address for the group. |
Response
"01abc234def56789"