googleapis.com – people
Provides access to information about profiles and contacts.
- Homepage
- https://api.apis.guru/v2/specs/googleapis.com:people/v1.json
- Provider
- googleapis.com:people / people
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/googleapis.com/people/v1/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/googleapis.com/people/v1/openapi.yaml
Tools (25)
Extracted live via the executor SDK.
-
contactGroups.peopleContactGroupsBatchGetGet a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
-
contactGroups.peopleContactGroupsCreateCreate 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 with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
-
contactGroups.peopleContactGroupsDeleteDelete 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 sequentially to avoid increased latency and failures.
-
contactGroups.peopleContactGroupsListList all contact groups owned by the authenticated user. Members of the contact groups are not populated.
-
contactGroups.peopleContactGroupsMembersModifyModify the members of a contact group owned by the authenticated user. The only system contact groups that can have members added are
contactGroups/myContactsandcontactGroups/starred. Other system contact groups are deprecated and can only have contacts removed. -
contactGroups.peopleContactGroupsUpdateUpdate 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 to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
-
otherContacts.peopleOtherContactsCopyOtherContactToMyContactsGroupCopies 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.
-
otherContacts.peopleOtherContactsListList all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an with reason "EXPIRED_SYNC_TOKEN". In the case of such an error clients should make a full sync request without a
sync_token. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When thesync_tokenis specified, resources deleted since the last sync will be returned as a person withPersonMetadata.deletedset to true. When thepage_tokenorsync_tokenis specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at . -
otherContacts.peopleOtherContactsSearchProvides 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, andphoneNumbersfields that are from the OTHER_CONTACT source. IMPORTANT: Before searching, clients should send a warmup request with an empty query to update the cache. See -
people.peopleBatchCreateContactsCreate 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.
-
people.peopleBatchDeleteContactsDelete 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 and failures.
-
people.peopleBatchUpdateContactsUpdate 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 sequentially to avoid increased latency and failures.
-
people.peopleConnectionsListProvides 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 an with reason "EXPIRED_SYNC_TOKEN". In the case of such an error clients should make a full sync request without a
sync_token. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When thesync_tokenis specified, resources deleted since the last sync will be returned as a person withPersonMetadata.deletedset to true. When thepage_tokenorsync_tokenis specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at . -
people.peopleCreateContactCreate 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 singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
-
people.peopleDeleteContactDelete 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 failures.
-
people.peopleDeleteContactPhotoDelete a contact's photo. Mutate requests for the same user should be done sequentially to avoid // lock contention.
-
people.peopleGetProvides information about a person by specifying a resource name. Use
people/meto indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified. -
people.peopleGetBatchGetProvides information about a list of specific people by specifying a list of requested resource names. Use
people/meto indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified. -
people.peopleListDirectoryPeopleProvides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the
sync_tokenis specified, resources deleted since the last sync will be returned as a person withPersonMetadata.deletedset to true. When thepage_tokenorsync_tokenis specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at . -
people.peopleSearchContactsProvides 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,emailAddresses,phoneNumbers, andorganizationsfields that are from the CONTACT source. IMPORTANT: Before searching, clients should send a warmup request with an empty query to update the cache. See -
people.peopleSearchDirectoryPeopleProvides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.
-
people.peopleUpdateContactUpdate 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 fields specified in the
update_maskwill be replaced. The server returns a 400 error ifperson.metadata.sourcesis not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason"failedPrecondition"ifperson.metadata.sources.etagis different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. The server returns a 400 error ifmembershipsare being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures. -
people.peopleUpdateContactPhotoUpdate a contact's photo. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools