Search Groups
Search for a group in Google Workspace.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
| Result Set | Choose from First Matching Record and All Matching Records First Matching Record: Returns the first group that matches your search. Use this option when you're looking for a specific group. All matching Records: Returns a collection of groups that match your search. Use this option when you're looking for a filtered set of groups. |
Dropdown |
TRUE |
Input
| Field | Definition | Type | Required |
|---|---|---|---|
|
Group |
|||
| Name |
Name of the group. |
Text |
FALSE |
| Email associated with the group. |
Text |
FALSE |
|
You can use single words or a combination of words and spaces in your group search.
A search using single words will return all groups with partial matches. For example, to find the group "All Remote Users", you can use All or Remote or Users in your query.
If you use a combination of words and spaces in your group search, the query results will show only the group names that match this combination exactly. For example, to find the group "All Remote Users", you can only use All Remote Users in your query. Any other combination (for example, All Remote) will return null.
If you use only a space in your group search, the query results will also be null.
As a general guidance, don't add a space to the Name field in your group search unless you are performing an exact match search.
Output
| Field | Definition | Type |
|---|---|---|
|
Groups |
||
| ID | Group's unique identifier. |
Text |
| Name |
Name of the group. |
Text |
| Group's email address. |
Text |
|
| Description | Detailed description of the group's purpose. |
Text |
| Direct Members Count | Number of users that are direct members of the group; if a group is a member (a child) of this group (the parent), then members of the child group are not counted. |
Text |
| Admin Created | Value is true if this group was created by an administrator rather than a user; otherwise, false. |
Text |
| Kind | Type of the API resource; for Groups resources, the value is admin#directory#group |
Text |
| Etag | ETag of the resource. |
Text |
| Aliases | List of the group's alias email addresses. |
List of Text |
| Noneditable Aliases | List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. |
List of Text |