Google

People API

Provides access to information about profiles and contacts.

Productivity & workspace#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Provides access to information about profiles and contacts.

Endpoints 23

contactGroups

  • GETGet a list of contact groups owned by the authenticated user by specifying a list of contact group resource names./v1/contactGroups:batchGet?groupFields=string&maxMembers=0&resourceNames=stringGet a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
  • GETList all contact groups owned by the authenticated user/v1/contactGroups?groupFields=string&pageSize=0&pageToken=string&syncToken=stringList all contact groups owned by the authenticated user. Members of the contact groups are not populated.
  • POSTCreate a new contact group owned by the authenticated user/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…
  • PUTUpdate the name of an existing contact group owned by the authenticated user/v1/:resourceNameUpdate the name of an existing contact group owned by the authenticated user. Updated contact group names must be unique to the users contact groups.…
  • DELETEDelete an existing contact group owned by the authenticated user by specifying a contact group resource name/v1/:resourceName?deleteContacts=trueDelete 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…

people

  • GETProvides information about a person by specifying a resource name/v1/:resourceName?personFields=string&requestMask.includeField=string&sources=READ_SOURCE_TYPE_UNSPECIFIEDProvides information about a person by specifying a resource name. Use people/me to indicate the authenticated user. The request returns a 400 error if…
  • POSTCreate a batch of new contacts and return the PersonResponses for the newly Mutate requests for the same user should…/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…
  • POSTDelete a batch of contacts/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…
  • POSTUpdate a batch of contacts and return a map of resource names to PersonResponses for the updated contacts/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…
  • POSTCreate a new contact and return the person resource for that contact/v1/people:createContact?personFields=string&sources=READ_SOURCE_TYPE_UNSPECIFIEDCreate 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…
  • DELETEDelete a contact person/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…
  • DELETEDelete a contact's photo/v1/:resourceName:deleteContactPhoto?personFields=string&sources=READ_SOURCE_TYPE_UNSPECIFIEDDelete a contact's photo. Mutate requests for the same user should be done sequentially to avoid // lock contention.
  • GETProvides information about a list of specific people by specifying a list of requested resource names/v1/people:batchGet?personFields=string&requestMask.includeField=string&resourceNames=string&sources=READ_SOURCE_TYPE_UNSPECIFIEDProvides information about a list of specific people by specifying a list of requested resource names. Use people/me to indicate the authenticated user. The…
  • GETProvides a list of domain profiles and domain contacts in the authenticated user's domain directory/v1/people:listDirectoryPeople?mergeSources=DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED&pageSize=0&pageToken=string&readMask=string&requestSyncToken=true&sources=DIRECTORY_SOURCE_TYPE_UNSPECIFIED&syncToken=stringProvides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the sync_token is specified, resources deleted since…
  • GETProvides a list of contacts in the authenticated user's grouped contacts that matches the search query/v1/people:searchContacts?pageSize=0&query=string&readMask=string&sources=READ_SOURCE_TYPE_UNSPECIFIEDProvides 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,…
  • GETProvides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the…/v1/people:searchDirectoryPeople?mergeSources=DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED&pageSize=0&pageToken=string&query=string&readMask=string&sources=DIRECTORY_SOURCE_TYPE_UNSPECIFIEDProvides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.
  • PATCHUpdate contact data for an existing contact person/v1/:resourceName:updateContact?personFields=string&sources=READ_SOURCE_TYPE_UNSPECIFIED&updatePersonFields=stringUpdate 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.…
  • PATCHUpdate a contact's photo/v1/:resourceName:updateContactPhotoUpdate a contact's photo. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.

contactGroups.members

  • POSTModify the members of a contact group owned by the authenticated user/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…

otherContacts

  • POSTCopies an "Other contact" to a new contact in the user's "myContacts" group Mutate requests for the same user should…/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…
  • GETList all "Other contacts", that is contacts that are not in a contact group/v1/otherContacts?pageSize=0&pageToken=string&readMask=string&requestSyncToken=true&sources=READ_SOURCE_TYPE_UNSPECIFIED&syncToken=stringList all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions. Sync…
  • GETProvides a list of contacts in the authenticated user's other contacts that matches the search query/v1/otherContacts:search?pageSize=0&query=string&readMask=stringProvides 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,…

people.connections

  • GETProvides a list of the authenticated user's contacts/v1/:resourceName/connections?pageSize=0&pageToken=string&personFields=string&requestMask.includeField=string&requestSyncToken=true&sortOrder=LAST_MODIFIED_ASCENDING&sources=READ_SOURCE_TYPE_UNSPECIFIED&syncToken=stringProvides 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…

API details

Base URL
https://people.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 12 scopes
An API key in the key query parameter
Operations
23 operations on 20 pathsGET 10POST 7DELETE 3PATCH 2PUT 1
Main resources
people 13contactGroups 5otherContacts 3contactGroups.members 1people.connections 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the People API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the People API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 12 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.” (GET /v1/contactGroups:batchGet?groupFields=string&maxMembers=0&resourceNames=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the People API?

Provides access to information about profiles and contacts. It is listed under Productivity & workspace and has 23 endpoints.

Who publishes the People API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the People API?

Requests go to https://people.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the People API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 12 scopes; an API key in the key query parameter.

How many endpoints does the People API have?

23 operations on 20 paths (10 GET, 7 POST, 3 DELETE, 2 PATCH, 1 PUT). The largest groups are people, contactGroups, otherContacts, contactGroups.members.

Is forking the People API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.