Skip to content
OpenParablePublic APIs

People API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Provides access to information about profiles and contacts.

People API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 23 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://people.googleapis.com/
Version
v1
Endpoints
23
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://people.googleapis.com/v1/contactGroups" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://people.googleapis.com/v1/contactGroups", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://people.googleapis.com/v1/contactGroups",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v1/contactGroupsList all contact groups owned by the authenticated user. Members of the contact groups are not populated.
POST/v1/contactGroupsCreate a new contact group owned by the authenticated user. Created contact group names must be unique to the users contact groups. Attempting to create a group
GET/v1/contactGroups:batchGetGet a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
GET/v1/otherContactsList all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions. Sync tokens
GET/v1/otherContacts:searchProvides a list of contacts in the authenticated user's other contacts that matches the search query. The query matches on a contact's `names`, `emailAddresses`
POST/v1/people:batchCreateContactsCreate a batch of new contacts and return the PersonResponses for the newly Mutate requests for the same user should be sent sequentially to avoid increased lat
POST/v1/people:batchDeleteContactsDelete a batch of contacts. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency a
GET/v1/people:batchGetProvides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The r
POST/v1/people:batchUpdateContactsUpdate a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Mutate requests for the same user should be sent sequ
POST/v1/people:createContactCreate a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a s
GET/v1/people:listDirectoryPeopleProvides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the `sync_token` is specified, resources deleted since
GET/v1/people:searchContactsProvides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `
GET/v1/people:searchDirectoryPeopleProvides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.
GET/v1/{resourceName}Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'perso
PUT/v1/{resourceName}Update the name of an existing contact group owned by the authenticated user. Updated contact group names must be unique to the users contact groups. Attempting
DELETE/v1/{resourceName}Delete an existing contact group owned by the authenticated user by specifying a contact group resource name. Mutate requests for the same user should be sent s
GET/v1/{resourceName}/connectionsProvides 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 get an error with
POST/v1/{resourceName}/members:modifyModify the members of a contact group owned by the authenticated user. The only system contact groups that can have members added are `contactGroups/myContacts`
POST/v1/{resourceName}:copyOtherContactToMyContactsGroupCopies an "Other contact" to a new contact in the user's "myContacts" group Mutate requests for the same user should be sent sequentially to avoid increased lat
DELETE/v1/{resourceName}:deleteContactDelete a contact person. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and
DELETE/v1/{resourceName}:deleteContactPhotoDelete a contact's photo. Mutate requests for the same user should be done sequentially to avoid // lock contention.
PATCH/v1/{resourceName}:updateContactUpdate contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All
PATCH/v1/{resourceName}:updateContactPhotoUpdate a contact's photo. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.

Questions

Does the People API API need an API key?

Yes. The People API API uses OAuth authentication; the documentation explains how to get credentials.

Does the People API API support HTTPS?

Yes, the People API API is served over HTTPS.

How many endpoints does the People API API have?

Its OpenAPI description lists 23 endpoints in version v1. All of them are shown on this page.

What are alternatives to the People API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).