Method: people.getBatchGet

Provides information about a list of specific people by specifying a list of requested resource names. Use people/me to indicate the authenticated user.

The request returns a 400 error if 'personFields' is not specified.

HTTP request


The URL uses gRPC Transcoding syntax.

Query parameters



Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be


  • To get information about the authenticated user, specify people/me.
  • To get information about a google account, specify people/{account_id}.
  • To get information about a contact, specify the resource name that identifies the contact as returned by people.connections.list.

There is a maximum of 200 resource names.


object (RequestMask)

DEPRECATED (Please use personFields instead)

A mask to restrict results to a subset of person fields.


string (FieldMask format)

Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are:

  • addresses
  • ageRanges
  • biographies
  • birthdays
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • events
  • externalIds
  • genders
  • imClients
  • interests
  • locales
  • locations
  • memberships
  • metadata
  • miscKeywords
  • names
  • nicknames
  • occupations
  • organizations
  • phoneNumbers
  • photos
  • relations
  • sipAddresses
  • skills
  • urls
  • userDefined

enum (ReadSourceType)

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

Request body

The request body must be empty.

Response body

The response to a get request for a list of people by resource name.

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

JSON representation
  "responses": [
      object (PersonResponse)

object (PersonResponse)

The response for each requested resource name.

Authorization scopes

No authorization required to access public data. For private data, one of the following OAuth scopes is required:


For more information, see the Authorization guide.