Method: people.searchDirectoryPeople

Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.

HTTP request

GET https://people.googleapis.com/v1/people:searchDirectoryPeople

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
query

string

Required. Prefix query that matches fields in the person. Does NOT use the readMask for determining what fields to match.

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:

  • 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 (DirectorySourceType)

Required. Directory sources to return.

mergeSources

enum (DirectoryMergeSourceType)

Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.

pageSize

integer

Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.

pageToken

string

Optional. A page token, received from a previous people.searchDirectoryPeople call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to people.searchDirectoryPeople must match the call that provided the page token.

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 request for people in the authenticated user's domain directory that match the specified query.

JSON representation
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
people[]

object (Person)

The list of people in the domain directory that match the query.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSize

integer

The total number of items in the list without pagination.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/directory.readonly

For more information, see the Authorization guide.