Method: otherContacts.list

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 result in a 410 error. 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 syncToken is specified, resources deleted since the last sync will be returned as a person with PersonMetadata.deleted set to true.

When the pageToken or syncToken is specified, all other request parameters must match the first call.

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

string

Optional. A page token, received from a previous response nextPageToken. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to otherContacts.list must match the first call that provided the page token.

pageSize

integer

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

boolean

Optional. Whether the response should return nextSyncToken on the last page of results. It can be used to get incremental changes since the last request by setting it on the request syncToken.

More details about sync behavior at otherContacts.list.

syncToken

string

Optional. A sync token, received from a previous response nextSyncToken Provide this to retrieve only the resources changed since the last request.

When syncing, all other parameters provided to otherContacts.list must match the first call that provided the sync token.

More details about sync behavior at otherContacts.list.

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. What values are valid depend on what ReadSourceType is used.

If READ_SOURCE_TYPE_CONTACT is used, valid values are:

  • emailAddresses
  • metadata
  • names
  • phoneNumbers
  • photos

If READ_SOURCE_TYPE_PROFILE is used, 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 (ReadSourceType)

Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set.

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 the authenticated user's "Other contacts".

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

object (Person)

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

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.

totalSize

integer

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.