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.

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 otherContacts.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to otherContacts.list must match the 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 include nextSyncToken, which can be used to get all changes since the last request. For subsequent sync requests use the syncToken param instead. Initial sync requests that specify requestSyncToken have an additional rate limit.

syncToken

string

Optional. A sync token, received from a previous otherContacts.list call. Provide this to retrieve only the resources changed since the last request. Sync requests that specify syncToken have an additional rate limit.

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

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:

  • emailAddresses
  • names
  • phoneNumbers

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
}
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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/contacts.other.readonly

For more information, see the Authorization guide.