Method: people.connections.list

Provides a list of the authenticated user's contacts.

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 contacts that have changed.

HTTP request

GET https://people.googleapis.com/v1/{resourceName=people/*}/connections

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resourceName
(deprecated)

string

Required. The resource name to return connections for. Only people/me is valid.

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 people.connections.list must match the first call that provided the page token.

pageSize

integer

Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.

sortOrder

enum (SortOrder)

Optional. The order in which the connections should be sorted. Defaults to LAST_MODIFIED_ASCENDING.

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 people.connections.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 people.connections.list must match the first call that provided the sync token.

More details about sync behavior at people.connections.list.

requestMask
(deprecated)

object (RequestMask)

Optional. DEPRECATED (Please use personFields instead)

A mask to restrict results to a subset of person fields.

personFields

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:

  • 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 and READ_SOURCE_TYPE_PROFILE 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 connections.

JSON representation
{
  "connections": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
Fields
connections[]

object (Person)

The list of people that the requestor is connected to.

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. When the response is paginated, only the last page will contain nextSyncToken.

totalPeople
(deprecated)

integer

DEPRECATED (Please use totalItems) The total number of people in the list without pagination.

totalItems

integer

The total number of items in the list without pagination.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authorization guide.

SortOrder

The order in which a list of connections should be sorted. This is only used if sync is not requested.

Enums
LAST_MODIFIED_ASCENDING Sort people by when they were changed; older entries first.
LAST_MODIFIED_DESCENDING Sort people by when they were changed; newer entries first.
FIRST_NAME_ASCENDING Sort people by first name.
LAST_NAME_ASCENDING Sort people by last name.