Stay organized with collections Save and categorize content based on your preferences.
Provides a list of domain profiles and domain contacts in the authenticated user's domain directory.
When the
is specified, resources deleted since the last sync will be returned as a person with syncToken
set to true.PersonMetadata.deleted
When the
or pageToken
is specified, all other request parameters must match the first call.syncToken
Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases.
See example usage at List the directory people that have changed.
HTTP requestGET https://people.googleapis.com/v1/people:listDirectoryPeople
The URL uses gRPC Transcoding syntax.
Query parameters ParametersreadMask
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:
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 1000, inclusive. Defaults to 100 if not set or set to 0.
pageToken
string
Optional. A page token, received from a previous response
. Provide this to retrieve the subsequent page.nextPageToken
When paginating, all other parameters provided to
must match the first call that provided the page token.people.listDirectoryPeople
requestSyncToken
boolean
Optional. Whether the response should return
. It can be used to get incremental changes since the last request by setting it on the request nextSyncToken
.syncToken
More details about sync behavior at
.people.listDirectoryPeople
syncToken
string
Optional. A sync token, received from a previous response
Provide this to retrieve only the resources changed since the last request.nextSyncToken
When syncing, all other parameters provided to
must match the first call that provided the sync token.people.listDirectoryPeople
More details about sync behavior at
.people.listDirectoryPeople
The request body must be empty.
Response bodyThe response to a request for the authenticated user's domain directory.
If successful, the response body contains data with the following structure:
JSON representation{
"people": [
{
object (Person
)
}
],
"nextPageToken": string,
"nextSyncToken": string
}
Fields people[]
object (
Person
)
The list of people in the domain directory.
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.
nextSyncToken
string
A token, which can be sent as syncToken
to retrieve changes since the last request. Request must set requestSyncToken
to return the sync token.
Requires the following OAuth scope:
https://www.googleapis.com/auth/directory.readonly
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-06 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-06 UTC."],[[["Lists domain profiles and contacts within the authenticated user's domain directory."],["Allows for filtering and pagination of results using query parameters like `readMask`, `sources`, `pageSize`, `pageToken`, and `syncToken`."],["Supports incremental synchronization to retrieve changes since the last request using the `syncToken` and `requestSyncToken` parameters."],["Returns a list of `Person` objects containing directory information, along with pagination and synchronization tokens."],["Requires the `https://www.googleapis.com/auth/directory.readonly` OAuth scope for authorization."]]],["This outlines how to list domain profiles and contacts via a `GET` request to `https://people.googleapis.com/v1/people:listDirectoryPeople`. Key actions include specifying `readMask`, `sources`, `mergeSources`, `pageSize`, `pageToken`, `requestSyncToken`, and `syncToken` as query parameters. An empty request body is required. The response, containing an array of `people`, `nextPageToken`, and `nextSyncToken` fields, allows for pagination and synchronization of changes. The `https://www.googleapis.com/auth/directory.readonly` authorization scope is required.\n"]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4