Method: people.get

Provides information about a person by specifying a resource name. Use people/me to indicate the authenticated user.
The request throws a 400 error if 'personFields' is not specified.

HTTP request

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

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
resourceName

string

The resource name of the person to provide information about.

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

Query parameters

Parameters
requestMask

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 the person are returned. Valid values are:

  • addresses
  • ageRanges
  • biographies
  • birthdays
  • braggingRights
  • coverPhotos
  • emailAddresses
  • events
  • genders
  • imClients
  • interests
  • locales
  • memberships
  • metadata
  • names
  • nicknames
  • occupations
  • organizations
  • phoneNumbers
  • photos
  • relations
  • relationshipInterests
  • relationshipStatuses
  • residences
  • skills
  • taglines
  • urls

Request body

The request body must be empty.

Response body

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

Authorization

See Profile scopes for more information.

Try it!