Google Groups

Use Google Groups to manage Google Workspace groups and membership through the Admin SDK Directory API. Create, read, update, or delete groups; manage aliases; add, remove, or update members with OWNER, MANAGER, or MEMBER roles; and check membership.

Connect an account with the required Workspace administrative permissions. Get Settings and Update Settings also use the Groups Settings API, which requires https://www.googleapis.com/auth/apps.groups.settings. Sim's current Google Groups OAuth connection requests Directory API scopes only, so it does not provide the scope needed for those settings actions.

OAuth scopes

Sim requests these scopes when someone connects a Google Groups account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.

Setting	Value
Redirect URI	`<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/google-groups`
Environment variables	`GOOGLE_CLIENT_ID`, `GOOGLE_CLIENT_SECRET`

Scope	Description
`https://www.googleapis.com/auth/userinfo.email`	View email address
`https://www.googleapis.com/auth/userinfo.profile`	View basic profile info
`https://www.googleapis.com/auth/admin.directory.group`	Manage Google Workspace groups
`https://www.googleapis.com/auth/admin.directory.group.member`	Manage Google Workspace group memberships

Use the block

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

Actions

Google Groups List Groups

List all groups in a Google Workspace domain

Inputs and outputs

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). Example: 50
`pageToken`	string	No	Token for fetching the next page of results
`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

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier. Can be the group email address (e.g., team@example.com) or the unique group ID

Output

Parameter	Type	Description
`group`	json	Group object

Google Groups Create Group

Create a new Google Group in the domain

Inputs and outputs

Input

Parameter	Type	Required	Description
`email`	string	Yes	Email address for the new group (e.g., team@example.com)
`name`	string	Yes	Display name for the group (e.g., Engineering Team)
`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

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier. Can be the group email address (e.g., team@example.com) or the unique group ID
`name`	string	No	New display name for the group (e.g., Engineering Team)
`description`	string	No	New description for the group
`email`	string	No	New email address for the group (e.g., newteam@example.com)

Output

Parameter	Type	Description
`group`	json	Updated group object

Google Groups Delete Group

Delete a Google Group

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier to delete. Can be the group email address (e.g., team@example.com) or the unique group ID

Output

Parameter	Type	Description
`message`	string	Success message

Google Groups List Members

List all members of a Google Group

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier. Can be the group email address (e.g., team@example.com) or the unique group ID
`maxResults`	number	No	Maximum number of results to return (1-200). Example: 50
`pageToken`	string	No	Token for fetching the next page of results
`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

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier. Can be the group email address (e.g., team@example.com) or the unique group ID
`memberKey`	string	Yes	Member identifier. Can be the member email address (e.g., user@example.com) or the unique member ID

Output

Parameter	Type	Description
`member`	json	Member object

Google Groups Add Member

Add a new member to a Google Group

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier. Can be the group email address (e.g., team@example.com) or the unique group ID
`email`	string	Yes	Email address of the member to add (e.g., user@example.com)
`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

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier. Can be the group email address (e.g., team@example.com) or the unique group ID
`memberKey`	string	Yes	Member identifier to remove. Can be the member email address (e.g., user@example.com) or the unique member ID

Output

Parameter	Type	Description
`message`	string	Success message

Google Groups Update Member

Update a member's role in a Google Group (promote or demote)

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier. Can be the group email address (e.g., team@example.com) or the unique group ID
`memberKey`	string	Yes	Member identifier. Can be the member email address (e.g., user@example.com) or the 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

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier. Can be the group email address (e.g., team@example.com) or the unique group ID
`memberKey`	string	Yes	Member identifier to check. Can be the member email address (e.g., user@example.com) or the unique member ID

Output

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

Google Groups List Aliases

List all email aliases for a Google Group

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier. Can be the group email address (e.g., team@example.com) or the unique group ID

Output

Parameter	Type	Description
`aliases`	array	List of email aliases for the group
↳ `id`	string	Unique group identifier
↳ `primaryEmail`	string	Group's primary email address
↳ `alias`	string	Alias email address
↳ `kind`	string	API resource type
↳ `etag`	string	Resource version identifier

Google Groups Add Alias

Add an email alias to a Google Group

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier. Can be the group email address (e.g., team@example.com) or the unique group ID
`alias`	string	Yes	The email alias to add to the group

Output

Parameter	Type	Description
`id`	string	Unique group identifier
`primaryEmail`	string	Group's primary email address
`alias`	string	The alias that was added
`kind`	string	API resource type
`etag`	string	Resource version identifier

Google Groups Remove Alias

Remove an email alias from a Google Group

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupKey`	string	Yes	Group identifier. Can be the group email address (e.g., team@example.com) or the unique group ID
`alias`	string	Yes	The email alias to remove from the group

Output

Parameter	Type	Description
`deleted`	boolean	Whether the alias was successfully deleted

Google Groups Get Settings

Get the settings for a Google Group including access permissions, moderation, and posting options

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupEmail`	string	Yes	The email address of the group (e.g., team@example.com)

Output

Parameter	Type	Description
`email`	string	The group's email address
`name`	string	The group name (max 75 characters)
`description`	string	The group description (max 4096 characters)
`whoCanJoin`	string	Who can join the group (ANYONE_CAN_JOIN, ALL_IN_DOMAIN_CAN_JOIN, INVITED_CAN_JOIN, CAN_REQUEST_TO_JOIN)
`whoCanViewMembership`	string	Who can view group membership
`whoCanViewGroup`	string	Who can view group messages
`whoCanPostMessage`	string	Who can post messages to the group
`allowExternalMembers`	string	Whether external users can be members
`allowWebPosting`	string	Whether web posting is allowed
`primaryLanguage`	string	The group's primary language
`isArchived`	string	Whether messages are archived
`archiveOnly`	string	Whether the group is archive-only (inactive)
`messageModerationLevel`	string	Message moderation level
`spamModerationLevel`	string	Spam handling level (ALLOW, MODERATE, SILENTLY_MODERATE, REJECT)
`replyTo`	string	Default reply destination
`customReplyTo`	string	Custom email for replies
`includeCustomFooter`	string	Whether to include custom footer
`customFooterText`	string	Custom footer text (max 1000 characters)
`sendMessageDenyNotification`	string	Whether to send rejection notifications
`defaultMessageDenyNotificationText`	string	Default rejection message text
`membersCanPostAsTheGroup`	string	Whether members can post as the group
`includeInGlobalAddressList`	string	Whether included in Global Address List
`whoCanLeaveGroup`	string	Who can leave the group
`whoCanContactOwner`	string	Who can contact the group owner
`favoriteRepliesOnTop`	string	Whether favorite replies appear at top
`whoCanApproveMembers`	string	Who can approve new members
`whoCanBanUsers`	string	Who can ban users
`whoCanModerateMembers`	string	Who can manage members
`whoCanModerateContent`	string	Who can moderate content
`whoCanAssistContent`	string	Who can assist with content metadata
`enableCollaborativeInbox`	string	Whether collaborative inbox is enabled
`whoCanDiscoverGroup`	string	Who can discover the group
`defaultSender`	string	Default sender identity (DEFAULT_SELF or GROUP)

Google Groups Update Settings

Update the settings for a Google Group including access permissions, moderation, and posting options

Inputs and outputs

Input

Parameter	Type	Required	Description
`groupEmail`	string	Yes	The email address of the group (e.g., team@example.com)
`name`	string	No	The group name (max 75 characters)
`description`	string	No	The group description (max 4096 characters)
`whoCanJoin`	string	No	Who can join: ANYONE_CAN_JOIN, ALL_IN_DOMAIN_CAN_JOIN, INVITED_CAN_JOIN, CAN_REQUEST_TO_JOIN
`whoCanViewMembership`	string	No	Who can view membership: ALL_IN_DOMAIN_CAN_VIEW, ALL_MEMBERS_CAN_VIEW, ALL_MANAGERS_CAN_VIEW
`whoCanViewGroup`	string	No	Who can view group messages: ANYONE_CAN_VIEW, ALL_IN_DOMAIN_CAN_VIEW, ALL_MEMBERS_CAN_VIEW, ALL_MANAGERS_CAN_VIEW, ALL_OWNERS_CAN_VIEW
`whoCanPostMessage`	string	No	Who can post: NONE_CAN_POST, ALL_MANAGERS_CAN_POST, ALL_MEMBERS_CAN_POST, ALL_OWNERS_CAN_POST, ALL_IN_DOMAIN_CAN_POST, ANYONE_CAN_POST
`allowExternalMembers`	string	No	Whether external users can be members: true or false
`allowWebPosting`	string	No	Whether web posting is allowed: true or false
`primaryLanguage`	string	No	The group's primary language (e.g., en)
`isArchived`	string	No	Whether messages are archived: true or false
`archiveOnly`	string	No	Whether the group is archive-only (inactive): true or false
`messageModerationLevel`	string	No	Message moderation: MODERATE_ALL_MESSAGES, MODERATE_NON_MEMBERS, MODERATE_NEW_MEMBERS, MODERATE_NONE
`spamModerationLevel`	string	No	Spam handling: ALLOW, MODERATE, SILENTLY_MODERATE, REJECT
`replyTo`	string	No	Default reply: REPLY_TO_CUSTOM, REPLY_TO_SENDER, REPLY_TO_LIST, REPLY_TO_OWNER, REPLY_TO_IGNORE, REPLY_TO_MANAGERS
`customReplyTo`	string	No	Custom email for replies (when replyTo is REPLY_TO_CUSTOM)
`includeCustomFooter`	string	No	Whether to include custom footer: true or false
`customFooterText`	string	No	Custom footer text (max 1000 characters)
`sendMessageDenyNotification`	string	No	Whether to send rejection notifications: true or false
`defaultMessageDenyNotificationText`	string	No	Default rejection message text
`membersCanPostAsTheGroup`	string	No	Whether members can post as the group: true or false
`includeInGlobalAddressList`	string	No	Whether included in Global Address List: true or false
`whoCanLeaveGroup`	string	No	Who can leave: ALL_MANAGERS_CAN_LEAVE, ALL_MEMBERS_CAN_LEAVE, NONE_CAN_LEAVE
`whoCanContactOwner`	string	No	Who can contact owner: ALL_IN_DOMAIN_CAN_CONTACT, ALL_MANAGERS_CAN_CONTACT, ALL_MEMBERS_CAN_CONTACT, ANYONE_CAN_CONTACT
`favoriteRepliesOnTop`	string	No	Whether favorite replies appear at top: true or false
`whoCanApproveMembers`	string	No	Who can approve members: ALL_OWNERS_CAN_APPROVE, ALL_MANAGERS_CAN_APPROVE, ALL_MEMBERS_CAN_APPROVE, NONE_CAN_APPROVE
`whoCanBanUsers`	string	No	Who can ban users: ALL_MEMBERS, OWNERS_AND_MANAGERS, OWNERS_ONLY, NONE
`whoCanModerateMembers`	string	No	Who can manage members: OWNERS_ONLY, OWNERS_AND_MANAGERS, ALL_MEMBERS, NONE
`whoCanModerateContent`	string	No	Who can moderate content: OWNERS_ONLY, OWNERS_AND_MANAGERS, ALL_MEMBERS, NONE
`whoCanAssistContent`	string	No	Who can assist with content metadata: OWNERS_ONLY, OWNERS_AND_MANAGERS, ALL_MEMBERS, NONE
`enableCollaborativeInbox`	string	No	Whether collaborative inbox is enabled: true or false
`whoCanDiscoverGroup`	string	No	Who can discover: ANYONE_CAN_DISCOVER, ALL_IN_DOMAIN_CAN_DISCOVER, ALL_MEMBERS_CAN_DISCOVER
`defaultSender`	string	No	Default sender: DEFAULT_SELF or GROUP

Output

Parameter	Type	Description
`email`	string	The group's email address
`name`	string	The group name
`description`	string	The group description
`whoCanJoin`	string	Who can join the group
`whoCanViewMembership`	string	Who can view group membership
`whoCanViewGroup`	string	Who can view group messages
`whoCanPostMessage`	string	Who can post messages to the group
`allowExternalMembers`	string	Whether external users can be members
`allowWebPosting`	string	Whether web posting is allowed
`primaryLanguage`	string	The group's primary language
`isArchived`	string	Whether messages are archived
`archiveOnly`	string	Whether the group is archive-only
`messageModerationLevel`	string	Message moderation level
`spamModerationLevel`	string	Spam handling level
`replyTo`	string	Default reply destination
`customReplyTo`	string	Custom email for replies
`includeCustomFooter`	string	Whether to include custom footer
`customFooterText`	string	Custom footer text
`sendMessageDenyNotification`	string	Whether to send rejection notifications
`defaultMessageDenyNotificationText`	string	Default rejection message text
`membersCanPostAsTheGroup`	string	Whether members can post as the group
`includeInGlobalAddressList`	string	Whether included in Global Address List
`whoCanLeaveGroup`	string	Who can leave the group
`whoCanContactOwner`	string	Who can contact the group owner
`favoriteRepliesOnTop`	string	Whether favorite replies appear at top
`whoCanApproveMembers`	string	Who can approve new members
`whoCanBanUsers`	string	Who can ban users
`whoCanModerateMembers`	string	Who can manage members
`whoCanModerateContent`	string	Who can moderate content
`whoCanAssistContent`	string	Who can assist with content metadata
`enableCollaborativeInbox`	string	Whether collaborative inbox is enabled
`whoCanDiscoverGroup`	string	Who can discover the group
`defaultSender`	string	Default sender identity