Google People API

The Google People API provides access to information about profiles and contacts. It allows you to list, create, update, delete, and search contacts, as well as manage contact groups. It replaces the legacy Google Contacts API and provides access to user profiles and directory information.

1 APIs 0 Features

Address BookContactsDirectoryGooglePeopleProfiles

APIs

Google People API v1

The Google People API provides programmatic access to contacts and profile information. Manage contacts, contact groups, and access directory data for Google Workspace users.

Collections

Google People API (Contacts)

OPEN

Pricing Plans

Google Contacts Plans Pricing

3 plans

PLANS

Rate Limits

Google Contacts Rate Limits

5 limits

RATE LIMITS

FinOps

Google Contacts Finops

FINOPS

Semantic Vocabularies

Contacts Context

21 classes · 1 properties

JSON-LD

Resources

Sources

opencollection: 1.0.0
info:
  name: Google People API (Contacts)
  version: v1
request:
  auth:
    type: oauth2
    flow: authorization_code
    authorizationUrl: https://accounts.google.com/o/oauth2/auth
    accessTokenUrl: https://oauth2.googleapis.com/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Get a person
    type: http
  http:
    method: GET
    url: https://people.googleapis.com/v1/people/:resourceName
    params:
    - name: resourceName
      value: ''
      type: path
      description: The resource name of the person to provide information about.
    - name: personFields
      value: ''
      type: query
      description: A field mask to restrict which fields on the person are returned.
  docs: Provides information about a person by specifying a resource name.
- info:
    name: List contacts
    type: http
  http:
    method: GET
    url: https://people.googleapis.com/v1/people/:resourceName/connections
    params:
    - name: resourceName
      value: ''
      type: path
    - name: personFields
      value: ''
      type: query
    - name: pageSize
      value: ''
      type: query
    - name: pageToken
      value: ''
      type: query
    - name: sortOrder
      value: ''
      type: query
  docs: Provides a list of the authenticated user's contacts.
- info:
    name: Create a contact
    type: http
  http:
    method: POST
    url: https://people.googleapis.com/v1/people:createContact
    params:
    - name: personFields
      value: ''
      type: query
    body:
      type: json
      data: '{}'
  docs: Create a new contact and return the person resource for that contact.
- info:
    name: Update a contact
    type: http
  http:
    method: PATCH
    url: https://people.googleapis.com/v1/people/:resourceName:updateContact
    params:
    - name: resourceName
      value: ''
      type: path
    - name: updatePersonFields
      value: ''
      type: query
    - name: personFields
      value: ''
      type: query
    body:
      type: json
      data: '{}'
  docs: Update contact data for an existing contact person.
- info:
    name: Delete a contact
    type: http
  http:
    method: DELETE
    url: https://people.googleapis.com/v1/people/:resourceName:deleteContact
    params:
    - name: resourceName
      value: ''
      type: path
  docs: Delete a contact person.
- info:
    name: Search contacts
    type: http
  http:
    method: GET
    url: https://people.googleapis.com/v1/people:searchContacts
    params:
    - name: query
      value: ''
      type: query
    - name: readMask
      value: ''
      type: query
    - name: pageSize
      value: ''
      type: query
  docs: Provides a list of contacts in the authenticated user's grouped contacts that matches the search query.
- info:
    name: List contact groups
    type: http
  http:
    method: GET
    url: https://people.googleapis.com/v1/contactGroups
    params:
    - name: pageSize
      value: ''
      type: query
    - name: pageToken
      value: ''
      type: query
  docs: List all contact groups owned by the authenticated user.
- info:
    name: Create a contact group
    type: http
  http:
    method: POST
    url: https://people.googleapis.com/v1/contactGroups
    body:
      type: json
      data: '{}'
  docs: Create a new contact group.
- info:
    name: Get a contact group
    type: http
  http:
    method: GET
    url: https://people.googleapis.com/v1/contactGroups/:resourceName
    params:
    - name: resourceName
      value: ''
      type: path
    - name: maxMembers
      value: ''
      type: query
  docs: Get a specific contact group.
- info:
    name: Update a contact group
    type: http
  http:
    method: PUT
    url: https://people.googleapis.com/v1/contactGroups/:resourceName
    params:
    - name: resourceName
      value: ''
      type: path
    body:
      type: json
      data: '{}'
  docs: Update the name of an existing contact group.
- info:
    name: Delete a contact group
    type: http
  http:
    method: DELETE
    url: https://people.googleapis.com/v1/contactGroups/:resourceName
    params:
    - name: resourceName
      value: ''
      type: path
    - name: deleteContacts
      value: ''
      type: query
  docs: Delete an existing contact group.
bundled: true