Google Groups

Create and manage Google Groups and their members in your Google Workspace organization.

Actions

Action	What it does
Add member	Add a person to a Google Group.
Check if member	Check whether a person is a member of a Google Group.
Create group	Create a new Google Group.
Delete group	Permanently delete a Google Group.
Get group	Get the details of a specific Google Group.
Get member	Get the details of one person who belongs to a Google Group.
List groups	List all Google Groups in your Google Workspace organization.
List members	List everyone who belongs to a Google Group.
Remove member	Remove a person from a Google Group.
Update group	Update a Google Group's name, description, or email address.

Add member

Add a person to a Google Group.

Inputs

Groupgroup_keytextRequired: The group's email address (or its unique ID).
Member emailmember_emailtextRequired: The email address of the person to add.
Roleroletext: 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.One of: MEMBER, MANAGER, OWNER. Default: MEMBER.

Outputs

Response envelope; the payload is in the "member_id" field.

member_idtext: ID or email of the added member

Example output

{
  "member_id": "user@example.com"
}

Check if member

Check whether a person is a member of a Google Group. Counts both direct members and members inherited from nested groups.

Inputs

Groupgroup_keytextRequired: The group's email address (or its unique ID).
Member emailmember_emailtextRequired: The email address of the person to check.

Outputs

Response envelope; the payload is in the "is_member" field.

is_membertrue/false: Whether the person is a member of the group

Example output

{
  "is_member": true
}

Create group

Create a new Google Group.

Inputs

Group emailemailtextRequired: The email address for the new group.
Group namenametextRequired: The display name for the group.
Descriptiondescriptiontext: An optional description of what the group is for.

Outputs

Response envelope; the payload is in the "group_id" field.

group_idtext: ID of the created group

Example output

{
  "group_id": "01abc234def56789"
}

Delete group

Permanently delete a Google Group.

Inputs

Groupgroup_keytextRequired: The group's email address (or its unique ID).

Outputs

Response envelope; the payload is in the "deleted" field.

deletedtrue/false: Whether the group was deleted

Example output

{
  "deleted": true
}

Get group

Get the details of a specific Google Group.

Inputs

Groupgroup_keytextRequired: The group's email address (or its unique ID).

Outputs

Response envelope; the payload is in the "group" field.

groupobject

Example output

{
  "group": {
    "description": "All engineering staff",
    "email": "engineering@example.com",
    "id": "01abc234def56789",
    "name": "Engineering Team"
  }
}

Get member

Get the details of one person who belongs to a Google Group.

Inputs

Groupgroup_keytextRequired: The group's email address (or its unique ID).
Member emailmember_emailtextRequired: The email address of the person to look up.

Outputs

Response envelope; the payload is in the "member" field.

memberobject

Example output

{
  "member": {
    "email": "user@example.com",
    "id": "112233445566778899",
    "role": "MEMBER",
    "status": "ACTIVE",
    "type": "USER"
  }
}

List groups

List all Google Groups in your Google Workspace organization.

Inputs

Maximum resultspage_sizenumber: The maximum number of groups to return (1-200).

Outputs

Response envelope; the payload is in the "groups" field.

groupslist: List of groups

Example output

{
  "groups": [
    {
      "directMembersCount": "15",
      "email": "engineering@example.com",
      "id": "01abc234def56789",
      "name": "Engineering Team"
    }
  ]
}

List members

List everyone who belongs to a Google Group.

Inputs

Groupgroup_keytextRequired: The group's email address (or its unique ID).
Maximum resultspage_sizenumber: The maximum number of members to return (1-200).

Outputs

Response envelope; the payload is in the "members" field.

memberslist: List of group members

Example output

{
  "members": [
    {
      "email": "user@example.com",
      "id": "112233445566778899",
      "role": "MEMBER",
      "type": "USER"
    }
  ]
}

Remove member

Remove a person from a Google Group.

Inputs

Groupgroup_keytextRequired: The group's email address (or its unique ID).
Member emailmember_emailtextRequired: The email address of the person to remove.

Outputs

Response envelope; the payload is in the "removed" field.

removedtrue/false: Whether the member was removed

Example output

{
  "removed": true
}

Update group

Update a Google Group's name, description, or email address.

Inputs

Groupgroup_keytextRequired: The group's email address (or its unique ID).
New namenametext: A new display name for the group.
New descriptiondescriptiontext: A new description for the group.
New emailnew_emailtext: A new email address for the group.

Outputs

Response envelope; the payload is in the "group_id" field.

group_idtext: ID of the updated group

Example output

{
  "group_id": "01abc234def56789"
}

ActionsCopy Anchor Link

Add memberCopy Anchor Link

Inputs

Outputs

Check if memberCopy Anchor Link

Inputs

Outputs

Create groupCopy Anchor Link

Inputs

Outputs

Delete groupCopy Anchor Link

Inputs

Outputs

Get groupCopy Anchor Link

Inputs

Outputs

Get memberCopy Anchor Link

Inputs

Outputs

List groupsCopy Anchor Link

Inputs

Outputs

List membersCopy Anchor Link

Inputs

Outputs

Remove memberCopy Anchor Link

Inputs

Outputs

Update groupCopy Anchor Link

Inputs

Outputs

On this page

Actions

Add member

Check if member

Create group

Delete group

Get group

Get member

List groups

List members

Remove member

Update group