People API

    Provides access to information about profiles and contacts.

    Service: people.googleapis.com

    To call this service, we recommend that you use the Google-provided client libraries . If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

    Discovery document

    A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

    Service endpoint

    A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

    • https://people.googleapis.com

    REST Resource: v1.contactGroups

    Methods
    batchGet GET /v1/contactGroups:batchGet
    Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
    create POST /v1/contactGroups
    Create a new contact group owned by the authenticated user.
    delete DELETE /v1/{resourceName=contactGroups/*}
    Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.
    get GET /v1/{resourceName=contactGroups/*}
    Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
    list GET /v1/contactGroups
    List all contact groups owned by the authenticated user.
    update PUT /v1/{contactGroup.resourceName=contactGroups/*}
    Update the name of an existing contact group owned by the authenticated user.

    REST Resource: v1.contactGroups.members

    Methods
    modify POST /v1/{resourceName=contactGroups/*}/members:modify
    Modify the members of a contact group owned by the authenticated user.

    REST Resource: v1.otherContacts

    Methods
    copyOtherContactToMyContactsGroup POST /v1/{resourceName=otherContacts/*}:copyOtherContactToMyContactsGroup

    Copies 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 latency and failures.
    list GET /v1/otherContacts
    List all "Other contacts", that is contacts that are not in a contact group.
    search GET /v1/otherContacts:search
    Provides a list of contacts in the authenticated user's other contacts that matches the search query.

    REST Resource: v1.people

    Methods
    batchCreateContacts POST /v1/people:batchCreateContacts

    Create 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 latency and failures.
    batchDeleteContacts POST /v1/people:batchDeleteContacts
    Delete a batch of contacts.
    batchUpdateContacts POST /v1/people:batchUpdateContacts
    Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts.
    createContact POST /v1/people:createContact
    Create a new contact and return the person resource for that contact.
    deleteContact DELETE /v1/{resourceName=people/*}:deleteContact
    Delete a contact person.
    deleteContactPhoto DELETE /v1/{resourceName=people/*}:deleteContactPhoto
    Delete a contact's photo.
    get GET /v1/{resourceName=people/*}
    Provides information about a person by specifying a resource name.
    getBatchGet GET /v1/people:batchGet
    Provides information about a list of specific people by specifying a list of requested resource names.
    listDirectoryPeople GET /v1/people:listDirectoryPeople
    Provides a list of domain profiles and domain contacts in the authenticated user's domain directory.
    searchContacts GET /v1/people:searchContacts
    Provides a list of contacts in the authenticated user's grouped contacts that matches the search query.
    searchDirectoryPeople GET /v1/people:searchDirectoryPeople
    Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.
    updateContact PATCH /v1/{person.resourceName=people/*}:updateContact
    Update contact data for an existing contact person.
    updateContactPhoto PATCH /v1/{resourceName=people/*}:updateContactPhoto
    Update a contact's photo.

    REST Resource: v1.people.connections

    Methods
    list GET /v1/{resourceName=people/*}/connections
    Provides a list of the authenticated user's contacts.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: