Method: contactGroups.get

  • Retrieve a specific contact group owned by the authenticated user using its resource name.

  • Customize the request to limit returned members or specify fields using query parameters like maxMembers and groupFields.

  • The response will contain details of the specified contact group, including metadata, group type, and member count.

  • Requires authorization using scopes such as https://www.googleapis.com/auth/contacts or https://www.googleapis.com/auth/contacts.readonly.

Get a specific contact group owned by the authenticated user by specifying a contact group resource name.

HTTP request

GET https://people.googleapis.com/v1/{resourceName=contactGroups/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resourceName

string

Required. The resource name of the contact group to get.

Query parameters

Parameters
maxMembers

integer

Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.
groupFields

string (FieldMask format)

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 empty. Valid fields are:

  • clientData
  • groupType
  • memberCount
  • metadata
  • name

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ContactGroup.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly

For more information, see the Authorization guide.