grr

Overview Schema Source Related Servers Discussions Admin

people.people.getBatchGet

Retrieve details for a list of specified people by resource name; requires personFields to return requested profile and contact data as JSON.

Instructions

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 GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchCreateContacts, batchDeleteContacts, batchUpdateContacts, createContact, deleteContact, deleteContactPhoto, get, listDirectoryPeople, searchContacts, searchDirectoryPeople, updateContact, updateContactPhoto.

Input Schema

Name	Required	Description
`query`	No	Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
`params`	No	Parameter map merged into the request; typed parameters win.
`dry_run`	No	Return the request that would be sent, without sending it.
`sources`	No
`body_file`	No	Read the request body from this file ('-' for stdin) instead of building one from the parameters.
`personFields`	No	[query parameter] 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:
`resourceNames`	No
`requestMask.includeField`	No	[query parameter] Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.ph

Output Schema

Name	Required	Description	Default
`responses`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed7 schema fields changedOct 26, 2026

changedInput schema / properties / personFields / description

Previous value: -"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: "New value: +"[query parameter] 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: "

addedInput schema / properties / personFields / format
```
Added value: +"google-fieldmask"
```

changedInput schema / properties / requestMask.includeField / description

Previous value: -"Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.ph"New value: +"[query parameter] Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.ph"

addedInput schema / properties / requestMask.includeField / format
```
Added value: +"google-fieldmask"
```

changedInput schema / properties / resourceNames / items / description

Previous value: -"Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=<name1>&resourceNames="New value: +"[query parameter] Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=<name1>&resourceNames="

changedInput schema / properties / sources / items / description

Previous value: -"Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set."New value: +"[query parameter] Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. Values: `READ_SOURCE_TYPE_UNSPECIFIED` = Unspecified.; `READ_SOURCE_TYPE_PROFILE` = Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.; `READ_SOURCE_TYPE_CONTACT` = Returns SourceType.CONTACT.; `READ_SOURCE_TYPE_DOMAIN_CONTACT` = Returns SourceType.DOMAIN_CONTACT.; `READ_SOURCE_TYPE_OTHER_CONTACT` = Returns SourceType.OTHER_CONTACT.."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "responses": {
+      "items": {
+        "properties": {
+          "httpStatusCode": {
+            "type": "integer"
+          },
+          "person": {
+            "properties": {
+              "addresses": {
+                "items": {
+                  "properties": {
+                    "city": {
+                      "type": "string"
+                    },
+                    "country": {
+                      "type": "string"
+                    },
+                    "countryCode": {
+                      "type": "string"
+                    },
+                    "extendedAddress": {
+                      "type": "string"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "formattedValue": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "poBox": {
+                      "type": "string"
+                    },
+                    "postalCode": {
+                      "type": "string"
+                    },
+                    "region": {
+                      "type": "string"
+                    },
+                    "streetAddress": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "ageRange": {
+                "enum": [
+                  "AGE_RANGE_UNSPECIFIED",
+                  "LESS_THAN_EIGHTEEN",
+                  "EIGHTEEN_TO_TWENTY",
+                  "TWENTY_ONE_OR_OLDER"
+                ],
+                "type": "string"
+              },
+              "ageRanges": {
+                "items": {
+                  "properties": {
+                    "ageRange": {
+                      "enum": [
+                        "AGE_RANGE_UNSPECIFIED",
+                        "LESS_THAN_EIGHTEEN",
+                        "EIGHTEEN_TO_TWENTY",
+                        "TWENTY_ONE_OR_OLDER"
+                      ],
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "biographies": {
+                "items": {
+                  "properties": {
+                    "contentType": {
+                      "enum": [
+                        "CONTENT_TYPE_UNSPECIFIED",
+                        "TEXT_PLAIN",
+                        "TEXT_HTML"
+                      ],
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "birthdays": {
+                "items": {
+                  "properties": {
+                    "date": {
+                      "type": "object"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "text": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "braggingRights": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "calendarUrls": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "url": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "clientData": {
+                "items": {
+                  "properties": {
+                    "key": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "coverPhotos": {
+                "items": {
+                  "properties": {
+                    "default": {
+                      "type": "boolean"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "url": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "emailAddresses": {
+                "items": {
+                  "properties": {
+                    "displayName": {
+                      "type": "string"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "etag": {
+                "type": "string"
+              },
+              "events": {
+                "items": {
+                  "properties": {
+                    "date": {
+                      "type": "object"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "externalIds": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "fileAses": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "genders": {
+                "items": {
+                  "properties": {
+                    "addressMeAs": {
+                      "type": "string"
+                    },
+                    "formattedValue": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "imClients": {
+                "items": {
+                  "properties": {
+                    "formattedProtocol": {
+                      "type": "string"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "protocol": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "username": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "interests": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "locales": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "locations": {
+                "items": {
+                  "properties": {
+                    "buildingId": {
+                      "type": "string"
+                    },
+                    "current": {
+                      "type": "boolean"
+                    },
+                    "deskCode": {
+                      "type": "string"
+                    },
+                    "floor": {
+                      "type": "string"
+                    },
+                    "floorSection": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "memberships": {
+                "items": {
+                  "properties": {
+                    "contactGroupMembership": {
+                      "type": "object"
+                    },
+                    "domainMembership": {
+                      "type": "object"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "metadata": {
+                "properties": {
+                  "deleted": {
+                    "type": "boolean"
+                  },
+                  "linkedPeopleResourceNames": {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  },
+                  "objectType": {
+                    "enum": [
+                      "OBJECT_TYPE_UNSPECIFIED",
+                      "PERSON",
+                      "PAGE"
+                    ],
+                    "type": "string"
+                  },
+                  "previousResourceNames": {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  },
+                  "sources": {
+                    "items": {
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                },
+                "type": "object"
+              },
+              "miscKeywords": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "enum": [
+                        "TYPE_UNSPECIFIED",
+                        "OUTLOOK_BILLING_INFORMATION",
+                        "OUTLOOK_DIRECTORY_SERVER",
+                        "OUTLOOK_KEYWORD",
+                        "OUTLOOK_MILEAGE",
+                        "OUTLOOK_PRIORITY",
+                        "OUTLOOK_SENSITIVITY",
+                        "OUTLOOK_SUBJECT",
+                        "OUTLOOK_USER",
+                        "HOME",
+                        "WORK",
+                        "OTHER"
+                      ],
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "names": {
+                "items": {
+                  "properties": {
+                    "displayName": {
+                      "type": "string"
+                    },
+                    "displayNameLastFirst": {
+                      "type": "string"
+                    },
+                    "familyName": {
+                      "type": "string"
+                    },
+                    "givenName": {
+                      "type": "string"
+                    },
+                    "honorificPrefix": {
+                      "type": "string"
+                    },
+                    "honorificSuffix": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "middleName": {
+                      "type": "string"
+                    },
+                    "phoneticFamilyName": {
+                      "type": "string"
+                    },
+                    "phoneticFullName": {
+                      "type": "string"
+                    },
+                    "phoneticGivenName": {
+                      "type": "string"
+                    },
+                    "phoneticHonorificPrefix": {
+                      "type": "string"
+                    },
+                    "phoneticHonorificSuffix": {
+                      "type": "string"
+                    },
+                    "phoneticMiddleName": {
+                      "type": "string"
+                    },
+                    "unstructuredName": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "nicknames": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "enum": [
+                        "DEFAULT",
+                        "MAIDEN_NAME",
+                        "INITIALS",
+                        "GPLUS",
+                        "OTHER_NAME",
+                        "ALTERNATE_NAME",
+                        "SHORT_NAME"
+                      ],
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "occupations": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "organizations": {
+                "items": {
+                  "properties": {
+                    "costCenter": {
+                      "type": "string"
+                    },
+                    "current": {
+                      "type": "boolean"
+                    },
+                    "department": {
+                      "type": "string"
+                    },
+                    "domain": {
+                      "type": "string"
+                    },
+                    "endDate": {
+                      "type": "object"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "fullTimeEquivalentMillipercent": {
+                      "type": "integer"
+                    },
+                    "jobDescription": {
+                      "type": "string"
+                    },
+                    "location": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "phoneticName": {
+                      "type": "string"
+                    },
+                    "startDate": {
+                      "type": "object"
+                    },
+                    "symbol": {
+                      "type": "string"
+                    },
+                    "title": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "phoneNumbers": {
+                "items": {
+                  "properties": {
+                    "canonicalForm": {
+                      "type": "string"
+                    },
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "photos": {
+                "items": {
+                  "properties": {
+                    "default": {
+                      "type": "boolean"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "url": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "relations": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "person": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "relationshipInterests": {
+                "items": {
+                  "properties": {
+                    "formattedValue": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "relationshipStatuses": {
+                "items": {
+                  "properties": {
+                    "formattedValue": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "residences": {
+                "items": {
+                  "properties": {
+                    "current": {
+                      "type": "boolean"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "resourceName": {
+                "type": "string"
+              },
+              "sipAddresses": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "skills": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "taglines": {
+                "items": {
+                  "properties": {
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "urls": {
+                "items": {
+                  "properties": {
+                    "formattedType": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "userDefined": {
+                "items": {
+                  "properties": {
+                    "key": {
+                      "type": "string"
+                    },
+                    "metadata": {
+                      "type": "object"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              }
+            },
+            "type": "object"
+          },
+          "requestedResourceName": {
+            "type": "string"
+          },
+          "status": {
+            "properties": {
+              "code": {
+                "type": "integer"
+              },
+              "details": {
+                "items": {
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "message": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}

First observedOct 26, 2026

TDQS

B3.3/5.0

Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations exist, so the description carries the full load. It discloses the 400 error on missing personFields, the HTTP GET verb, and that the response is JSON, but omits auth/scope requirements, any cap on the number of resource names per call, and rate-limit behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The opening sentence is well front-loaded, but the middle sentence about request bodies built from typed parameters or `body_file` is generic wrapper boilerplate that is irrelevant/misleading for a GET, and the trailing sibling dump is long with no explanatory value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists so return values needn't be explained, and the core contract is present. Still missing for an 8-parameter, annotation-free tool: the resource-name format, any batch size limit, and what happens when some requested names are invalid.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 75% and already marks `personFields` and `resourceNames` as required. The description adds one genuine convention not in the schema — the `people/me` alias — but says nothing about the expected format of a resource name (e.g. `people/{id}`) or how `sources` interacts with the returned data.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence names a specific verb and resource (fetch information for a *list* of people by resource name), which distinguishes it from the singular `get` sibling. However, the sibling list at the end is just an enumeration without saying how batchGet differs from `searchContacts` or `get`, so the differentiation is implicit rather than stated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives one useful usage rule — use `people/me` for the authenticated user — and a precondition (personFields required or 400). It never says when to choose this over `get` for a single person or `searchContacts`/`listDirectoryPeople` for discovery, so the when-to-use guidance is only partial.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server