- HTTP request
- Query parameters
- Request body
- Response body
- Authorization Scopes
- PersonResponse
- Try it!
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 |
Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be
You can include up to 50 resource names in one request. |
requestMask |
DEPRECATED (Please use A mask to restrict results to a subset of person fields. |
personFields |
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:
|
sources |
Optional. A mask of what source types to return. Defaults to |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
The response to a get request for a list of people by resource name.
JSON representation | |
---|---|
{
"responses": [
{
object ( |
Fields | |
---|---|
responses[] |
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/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.
PersonResponse
The response for a single person
JSON representation | |
---|---|
{ "httpStatusCode": integer, "person": { object ( |
Fields | |
---|---|
httpStatusCode |
DEPRECATED (Please use status instead) |
person |
The person. |
requestedResourceName |
The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL. |
status |
The status of the response. |