Skip to main content

Get Group

Retrieves a group's properties.

Basic Parameters

ParameterDescription
Customer IDThe unique ID for the customer's Google Workspace account. As an account administrator, you can also use the 'my_customer' alias to represent your account's customer ID. The customer ID is also returned as part of the ListUsers action.
Group KeyIdentifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

Advanced Parameters

ParameterDescription
Delegated User OverridePerform the action on behalf of another user, overriding the delegated user defined in the connection.

If not specified, the delegated user is the one provided in the connection.

Has no effect when using an OAuth connection.

NOTE: the connection details are not edited by this input.

Example Output

{
"adminCreated": false,
"aliases": [
"string"
],
"description": "An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.",
"directMembersCount": "The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.",
"email": "The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.",
"etag": "ETag of the resource.",
"id": "The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.",
"kind": "admin#directory#group",
"name": "The group's display name.",
"nonEditableAliases": [
"string"
]
}

Workflow Library Example

Get Group with Google Workspace and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop