v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132372111.9 KB
people

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

get/v1/people:searchDirectoryPeople

Query parameters

mergeSourcesstring[]

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

pageSizeinteger

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.

pageTokenstring

Optional. A page token, received from a previous response next_page_token. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchDirectoryPeople must match the first call that provided the page token.

querystring

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

readMaskstring

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

sourcesstring[]

Required. Directory sources to return.

Response

Successful response