people.contactGroups.list
List all contact groups owned by the authenticated user to review group names, metadata, and member counts without fetching members. Supports pagination and sync tokens for retrieving changed groups.
Instructions
List all contact groups owned by the authenticated user. Members of the contact groups are not populated [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchGet, create, delete, get, update.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| dry_run | No | Return the request that would be sent, without sending it. | |
| pageSize | No | [query parameter] Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. | |
| pageToken | No | [query parameter] Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of reso | |
| syncToken | No | [query parameter] Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned. | |
| groupFields | No | [query parameter] Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to e |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| totalItems | No | ||
| contactGroups | No | ||
| nextPageToken | No | ||
| nextSyncToken | No |