- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- SortOrder
- Try it!
Provides a list of the authenticated user's contacts merged with any connected profiles.
The request throws a 400 error if 'personFields' is not specified.
HTTP request
GET https://people.googleapis.com/v1/{resourceName=people/*}/connections
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
resourceName |
Required. The resource name to return connections for. Only |
Query parameters
Parameters | |
---|---|
pageToken |
The token of the page to be returned. |
pageSize |
Optional. The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100 if not set or set to 0. |
sortOrder |
The order in which the connections should be sorted. Defaults to |
requestSyncToken |
Whether the response should include a sync token, which can be used to get all changes since the last request. For subsequent sync requests use the |
syncToken |
A sync token returned by a previous call to |
requestMask |
DEPRECATED (Please use A mask to restrict results to a subset of person fields. |
personFields |
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:
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation | |
---|---|
{
"connections": [
{
object ( |
Fields | |
---|---|
connections[] |
The list of people that the requestor is connected to. |
nextPageToken |
The token that can be used to retrieve the next page of results. |
nextSyncToken |
The token that can be used to retrieve changes since the last request. |
totalPeople |
DEPRECATED (Please use totalItems) The total number of people in the list without pagination. |
totalItems |
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. |