Use wide People API integration

With Ants & Apps platform you can connect People API with more than 30 available apps, 600+ functional formulas to boost your productivity

Reference

  • contactGroups

    • Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names

      This action get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.

      GETPeopleContactGroupsBatchGet

      Request parameters

      • resourceNamesstring

        The resource names of the contact groups to get.

      • maxMembersinteger

        Specifies the maximum number of members to return for each group.

    • List all contact groups owned by the authenticated user

      This action list all contact groups owned by the authenticated user. Members of the contact groups are not populated.

      GETPeopleContactGroupsList

      Request parameters

      • syncTokenstring

        A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.

      • pageTokenstring

        The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.

      • pageSizeinteger

        The maximum number of resources to return.

    • Get a specific contact group owned by the authenticated user by specifying a contact group resource name

      This action get a specific contact group owned by the authenticated user by specifying a contact group resource name.

      GETPeopleContactGroupsGet

      Request parameters

      • resourceName*string

        The resource name of the contact group to get.

      • maxMembersinteger

        Specifies the maximum number of members to return.

    • Create a new contact group owned by the authenticated user

      This action create a new contact group owned by the authenticated user.

      POSTPeopleContactGroupsCreate

      Request body

      • contactGroupobject

        The contact group to create.

    • Update the name of an existing contact group owned by the authenticated user

      This action update the name of an existing contact group owned by the authenticated user.

      PUTPeopleContactGroupsUpdate

      Request parameters

      • resourceName*string

        The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`contact_group_id.

      Request body

      • contactGroupobject

        The contact group to update.

    • Delete an existing contact group owned by the authenticated user by specifying a contact group resource name

      This action delete an existing contact group owned by the authenticated user by specifying a contact group resource name.

      DELETEPeopleContactGroupsDelete

      Request parameters

      • resourceName*string

        The resource name of the contact group to delete.

      • deleteContactsboolean

        Set to true to also delete the contacts in the specified group.

  • contactGroups.members

    • Modify the members of a contact group owned by the authenticated user

      This action modify the members of a contact group owned by the authenticated user.
      The only system contact groups that can have members added are `contactGroups/myContacts` and `contactGroups/starred`. Other system contact groups are deprecated and can only have contacts removed.

      POSTPeopleContactGroupsMembersModify

      Request parameters

      • resourceName*string

        The resource name of the contact group to modify.

      Request body

      • resourceNamesToRemovearray

        The resource names of the contact people to remove in the form of in the form of `people/`person_id.

      • resourceNamesToAddarray

        The resource names of the contact people to add in the form of in the form `people/`person_id.

  • people.connections

    • Provide a list of the authenticated user's contacts merged with any connected profiles

      This action 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.

      GETPeoplePeopleConnectionsList

      Request parameters

      • resourceName*string

        The resource name to return connections for. Only `people/me` is valid.

      • personFields*string

        **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: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined

      • sortOrderstring

        The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.

      • requestSyncTokenboolean

        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 `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit.

      • pageTokenstring

        The token of the page to be returned.

      • requestMask.includeFieldstring

        **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.

      • pageSizeinteger

        The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100.

      • syncTokenstring

        A sync token returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned. Sync requests that specify `sync_token` have an additional rate limit.

  • people

    • Provide information about a person by specifying a resource name

      This action provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user.
      The request throws a 400 error if 'personFields' is not specified.

      GETPeoplePeopleGet

      Request parameters

      • resourceName*string

        The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`account_id. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list).

      • personFields*string

        **Required.** A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined

      • requestMask.includeFieldstring

        **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.

    • Provide information about a list of specific people by specifying a list of requested resource names

      This action provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.
      The request throws a 400 error if 'personFields' is not specified.

      GETPeoplePeopleGetBatchGet

      Request parameters

      • personFields*string

        **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: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined

      • resourceNamesstring

        The resource names of the people to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`account_id. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request.

      • requestMask.includeFieldstring

        **Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.

    • Create a new contact and return the person resource for that contact

      This action create a new contact and return the person resource for that contact.

      POSTPeoplePeopleCreateContact

      Request parameters

      • parentstring

        The resource name of the owning person resource.

      Request body

      • etagstring

        The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

      • braggingRightsarray

        The person's bragging rights.

      • metadataobject

        Read-only metadata about the person.

      • residencesarray

        The person's residences.

      • gendersarray

        The person's genders.

      • interestsarray

        The person's interests.

      • resourceNamestring

        The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/`person_id.

      • biographiesarray

        The person's biographies.

      • skillsarray

        The person's skills.

      • relationshipStatusesarray

        The person's read-only relationship statuses.

      • photosarray

        The person's read-only photos.

      • ageRangestring

        **DEPRECATED** (Please use `person.ageRanges` instead)** The person's read-only age range.

      • taglinesarray

        The person's read-only taglines.

      • ageRangesarray

        The person's read-only age ranges.

      • sipAddressesarray

        The person's SIP addresses.

      • addressesarray

        The person's street addresses.

      • eventsarray

        The person's events.

      • membershipsarray

        The person's group memberships.

      • phoneNumbersarray

        The person's phone numbers.

      • coverPhotosarray

        The person's read-only cover photos.

      • imClientsarray

        The person's instant messaging clients.

      • birthdaysarray

        The person's birthdays.

      • userDefinedarray

        The person's user defined data.

      • localesarray

        The person's locale preferences.

      • relationshipInterestsarray

        The person's read-only relationship interests.

      • urlsarray

        The person's associated URLs.

      • nicknamesarray

        The person's nicknames.

      • relationsarray

        The person's relations.

      • namesarray

        The person's names.

      • occupationsarray

        The person's occupations.

      • emailAddressesarray

        The person's email addresses.

      • organizationsarray

        The person's past or current organizations.

    • Update a contact's photo

      This action update a contact's photo.

      PATCHPeoplePeopleUpdateContactPhoto

      Request parameters

      • resourceName*string

        Person resource name

      Request body

      • photoBytesstring

        Raw photo bytes

      • personFieldsstring

        **Optional.** Not specifying any fields will skip the post mutate read. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined

    • Update contact data for an existing contact person

      This action update contact data for an existing contact person. Any non-contact data will not be modified. The request throws a 400 error if `updatePersonFields` is not specified.
      The request throws a 400 error if `person.metadata.sources` is not specified for the contact to be updated.
      The request throws a 400 error with an error with reason `"failedPrecondition"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and re-apply their updates to the latest person.

      PATCHPeoplePeopleUpdateContact

      Request parameters

      • resourceName*string

        The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/`person_id.

      • updatePersonFieldsstring

        **Required.** A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * emailAddresses * events * genders * imClients * interests * locales * memberships * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined

      Request body

      • etagstring

        The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

      • braggingRightsarray

        The person's bragging rights.

      • metadataobject

        Read-only metadata about the person.

      • residencesarray

        The person's residences.

      • gendersarray

        The person's genders.

      • interestsarray

        The person's interests.

      • resourceNamestring

        The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/`person_id.

      • biographiesarray

        The person's biographies.

      • skillsarray

        The person's skills.

      • relationshipStatusesarray

        The person's read-only relationship statuses.

      • photosarray

        The person's read-only photos.

      • ageRangestring

        **DEPRECATED** (Please use `person.ageRanges` instead)** The person's read-only age range.

      • taglinesarray

        The person's read-only taglines.

      • ageRangesarray

        The person's read-only age ranges.

      • sipAddressesarray

        The person's SIP addresses.

      • addressesarray

        The person's street addresses.

      • eventsarray

        The person's events.

      • membershipsarray

        The person's group memberships.

      • phoneNumbersarray

        The person's phone numbers.

      • coverPhotosarray

        The person's read-only cover photos.

      • imClientsarray

        The person's instant messaging clients.

      • birthdaysarray

        The person's birthdays.

      • userDefinedarray

        The person's user defined data.

      • localesarray

        The person's locale preferences.

      • relationshipInterestsarray

        The person's read-only relationship interests.

      • urlsarray

        The person's associated URLs.

      • nicknamesarray

        The person's nicknames.

      • relationsarray

        The person's relations.

      • namesarray

        The person's names.

      • occupationsarray

        The person's occupations.

      • emailAddressesarray

        The person's email addresses.

      • organizationsarray

        The person's past or current organizations.

    • Delete a contact person

      This action delete a contact person. Any non-contact data will not be deleted.

      DELETEPeoplePeopleDeleteContact

      Request parameters

      • resourceName*string

        The resource name of the contact to delete.

    • Delete a contact's photo

      This action delete a contact's photo.

      DELETEPeoplePeopleDeleteContactPhoto

      Request parameters

      • resourceName*string

        The resource name of the contact whose photo will be deleted.

      • personFieldsstring

        **Optional.** Not specifying any fields will skip the post mutate read. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined