Method: people.getBatchGet
Stay organized with collections
Save and categorize content based on your preferences.
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:
| 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/contactshttps://www.googleapis.com/auth/contacts.readonlyhttps://www.googleapis.com/auth/contacts.other.readonlyhttps://www.googleapis.com/auth/directory.readonlyhttps://www.googleapis.com/auth/profile.agerange.readhttps://www.googleapis.com/auth/profile.emails.readhttps://www.googleapis.com/auth/profile.language.readhttps://www.googleapis.com/auth/user.addresses.readhttps://www.googleapis.com/auth/user.birthday.readhttps://www.googleapis.com/auth/user.emails.readhttps://www.googleapis.com/auth/user.gender.readhttps://www.googleapis.com/auth/user.organization.readhttps://www.googleapis.com/auth/user.phonenumbers.readhttps://www.googleapis.com/auth/userinfo.emailhttps://www.googleapis.com/auth/userinfo.profilehttps://www.googleapis.com/auth/profile.language.read
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-06 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-06 UTC."],[[["Retrieves information about a list of specific people, including the authenticated user, by specifying resource names."],["Requires the `personFields` query parameter to specify desired data fields and returns a 400 error if it's missing."],["Supports various authorization scopes for accessing private data, although public data requires no authorization."],["Returns a JSON response containing an array of `PersonResponse` objects, each corresponding to a requested resource name."],["Uses the `GET` HTTP method and the `https://people.googleapis.com/v1/people:batchGet` endpoint with gRPC Transcoding syntax."]]],["This outlines how to retrieve information about specific people using the `people:batchGet` endpoint via a `GET` HTTP request. You must provide `resourceNames` (up to 200) in the query, identifying each person (e.g., `people/me` or `people/{account_id}`). The `personFields` parameter is required to specify which person attributes to include. The request body is empty. The response returns an array of `PersonResponse` objects, one for each requested resource name, and requires authorization scopes for private data. A 400 error is returned if 'personFields' are not provided.\n"]]