Method: otherContacts.search

  • This endpoint allows you to search for contacts within the authenticated user's other contacts using a plain-text query.

  • The search query matches on contact names, email addresses, and phone numbers from the OTHER_CONTACT source.

  • Results can be limited using the pageSize parameter, and specific fields can be selected using the readMask parameter.

  • A warmup request with an empty query should be sent before searching to update the cache for optimal performance.

  • Requires authorization with the https://www.googleapis.com/auth/contacts.other.readonly scope.

Provides a list of contacts in the authenticated user's other contacts that matches the search query. The query matches on a contact's names, emailAddresses, and phoneNumbers fields that are from the OTHER_CONTACT source.

IMPORTANT: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts

HTTP request

GET https://people.googleapis.com/v1/otherContacts:search

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
query

string

Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".
pageSize

integer

Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 30 will be capped to 30.
readMask

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:

  • emailAddresses
  • metadata
  • names
  • phoneNumbers

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/contacts.other.readonly

For more information, see the Authorization guide.