Method: contactGroups.batchGet

  • Retrieves a list of contact groups owned by the authenticated user using their resource names.

  • Allows specifying the maximum number of members to return for each group and the fields to include in the response.

  • Requires authorization with either https://www.googleapis.com/auth/contacts or https://www.googleapis.com/auth/contacts.readonly scope.

  • Returns a list of responses, each containing the requested resource name, status, and the contact group details if successful.

  • Uses a batch get request to the endpoint https://people.googleapis.com/v1/contactGroups:batchGet.

Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.

HTTP request

GET https://people.googleapis.com/v1/contactGroups:batchGet

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
resourceNames[]

string

Required. The resource names of the contact groups to get.

There is a maximum of 200 resource names.
maxMembers

integer

Optional. Specifies the maximum number of members to return for each group. 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

The response to a batch get contact groups request.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "responses": [
    {
      object (ContactGroupResponse)
    }
  ]
}
Fields
responses[]

object (ContactGroupResponse)

The list of responses for each requested contact group resource.

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.

ContactGroupResponse

The response for a specific contact group.

JSON representation 
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
Fields
requestedResourceName

string

The original requested resource name.
status

object (Status)

The status of the response.
contactGroup

object (ContactGroup)

The contact group.