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

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
resourceNames[]

string

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

resourceNames=<name1>&resourceNames=<name2>&...

  • 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.

requestMask
(deprecated)

object (RequestMask)

DEPRECATED (Please use personFields instead)

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

personFields

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
sources[]

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)
    }
  ]
}
Fields
responses[]

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:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/contacts.other.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/profile.agerange.read
  • https://www.googleapis.com/auth/profile.emails.read
  • https://www.googleapis.com/auth/profile.language.read
  • https://www.googleapis.com/auth/user.addresses.read
  • https://www.googleapis.com/auth/user.birthday.read
  • https://www.googleapis.com/auth/user.emails.read
  • https://www.googleapis.com/auth/user.gender.read
  • https://www.googleapis.com/auth/user.organization.read
  • https://www.googleapis.com/auth/user.phonenumbers.read
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/userinfo.profile

For more information, see the Authorization guide.