Integrate FamilySearch Tree Data and Features in your App

What is [CET]?

[CET] is a new FamilySearch product that allows users to create and maintain a family tree and to choose if other users can view and edit it. It offers most of the same features as the FamilySearch global family tree, including record hints, photo upload, and source documentation. For example, third-party products can sync with [CET] trees and receive record hints, helping users make new discoveries in their research.

[CET] and Global Family Tree: Similarities and Differences

The user and developer experience in [CET] will be familiar to those already using the FamilySearch global tree. The [CET] API also uses the same endpoints that are used for the global family tree, with a few extra endpoints to cover the differences. Detailed descriptions of the differences can be found in the guide Comparison of Family Tree and [CET].

[CET] API Features

The FamilySearch API offers the following [CET] features:

Tree Sync. The API enables data to be synced between trees . The API provides a change history, enabling a synced client to stay up to date with tree data changes made on FamilySearch.org. Clients can likewise update the tree on FamilySearch.org to reflect changes that were made in the user’s local tree copy.
Research Hints. The API enables access to historical record and family tree hints on FamilySearch that match information in your users’ trees. Users can view records on FamilySearch.org, attach a record as a source, add facts about their ancestors, and sync the changes back to their client.
Publication. The API enables a user to publish a tree on FamilySearch. By publishing the tree on FamilySearch, users can be assured that the data published will remain available and accessible for generations to come. It also enables a researcher to be discovered by other researchers who may have more information about a particular family line.

[CET] Key Concepts

[CET] and the FamilySearch global tree share a common underlying FamilySearch tree system. Therefore, many of the same API endpoints are used for both types of trees. It is helpful when working with [CET] to understand the following concepts:

FamilySearch Tree System. FamilySearch provides API access to [CET] trees and the global family tree. Each of these functions differently. Refer to the FamilySearch Tree System document for details on data organization and functionality.
[CET] Access Model. [CET] introduces the ability to specify different access privileges for different users in a family tree. Additionally, developers can configure which clients can have API access to the trees created by their client. See the [CET] Access Model document to learn more about these access controls.
[CET] Privacy Settings. Users can set the privacy of a family tree to be either private or public. See the [CET] Privacy Settings document to learn more about how privacy settings work in a family tree.
Tree Selection. The API enables users to select which tree to work with during their session. See the Current Tree Selection document to learn more about how family tree selection affects the behavior of the API.
Early Access to [CET]. During the time in which [CET] is in invite-only beta testing, you will need to request access. Apply for access from the FamilySearch Labs page, and send a message to [email protected].

[CET] Integration Guides

There are guides available with information about integrating an application with [CET]. Depending upon the type of integration desired, a developer may implement one or more of these into an application.

Uploading a Tree to [CET]

Uploading a tree to [CET] via the FamilySearch API enables users to maintain connectivity between their trees and the application that performed the upload. The process of uploading a tree through the API involves several steps which are explained in the Uploading a Tree to [CET] document.

Downloading a [CET] Family Tree

For trees accessible through the FamilySearch API, users can download data to their chosen application while maintaining connectivity to the data online. To learn more about the process of downloading a tree through the API, see the document Downloading a [CET] Tree.

Syncing Family Trees

Once a family tree on FamilySearch is connected to a third-party application, users may wish to keep that data in sync. This means changes in one tree are reflected on the other tree. See the guide Syncing Family Trees to learn more about strategies for keeping data in sync.

Integrating Research Hints

One of the primary benefits of integrating with [CET] is the ability for users to receive research hints. Family trees in [CET] are matched with other FamilySearch data, including family trees and historical records. Integrated applications can access these hints, providing valuable research opportunities for their users. To learn more about integrating research hints, see the guide Integrating Hints.

Deleting [CET] Family Trees

There may be times where a user desires to delete a family tree from [CET]. The guide Deleting [CET] Family Trees describes this process.