List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions.
Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an google.rpc.ErrorInfo with reason "EXPIRED_SYNC_TOKEN". In the case of such an error clients should make a full sync request without a
.syncToken
The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased.
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 user's other contacts that have changed.
HTTP request
GET https://people.googleapis.com/v1/otherContacts
The URL uses gRPC Transcoding syntax.
Query parameters
Parameters | |
---|---|
pageToken |
Optional. A page token, received from a previous response When paginating, all other parameters provided to |
pageSize |
Optional. The number of "Other contacts" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. |
requestSyncToken |
Optional. Whether the response should return More details about sync behavior at |
syncToken |
Optional. A sync token, received from a previous response When syncing, all other parameters provided to More details about sync behavior at |
readMask |
Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. What values are valid depend on what ReadSourceType is used. If READ_SOURCE_TYPE_CONTACT is used, valid values are:
If READ_SOURCE_TYPE_PROFILE is used, valid values are:
|
sources[] |
Optional. A mask of what source types to return. Defaults to Possible values for this field are: Specifying |
Request body
The request body must be empty.
Response body
The response to a request for the authenticated user's "Other contacts".
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"otherContacts": [
{
object ( |
Fields | |
---|---|
otherContacts[] |
The list of "Other contacts" returned as Person resources. "Other contacts" support a limited subset of fields. See ListOtherContactsRequest.request_mask for more detailed information. |
nextPageToken |
A token, which can be sent as |
nextSyncToken |
A token, which can be sent as |
totalSize |
The total number of other contacts in the list without pagination. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/contacts.other.readonly
For more information, see the Authorization guide.