Tree

A family tree as represented in the Family Graph API.

A family site can include several family trees, in which individuals and families are defined. A family tree includes a link to a root individual, who is the main person in the family tree. From this individual it is possible to reach other individuals in the tree via family connections.


Fields

The Tree object contains the following fields:

Name Description Type Access Mode

id

The tree's id

id

read

name

The tree's name

string

read, write

site

The family site the tree is part of

Site object: id and name fields

read

link

Link to tree on MyHeritage.com

string

read

data_languages

List of languages of data in the tree (ISO-639-1 codes)

array of strings

read

updated_time

The date and time when the tree was last updated

string (YYYY-MM-DD HH:MM:SS)

read

tree_source

The source application that created the tree

  • WEB - Online tree editor

  • FTB - Family Tree Builder software

  • GEDCOM - Imported from a GEDCOM file

string

read

root_individual

The root individual in the tree who is shown by default

Individual object: id and name fields

read, write

is_public

Indicates whether the tree is public so that individuals in this tree can be searched by other users (but living people will be hidden)

boolean

read, write

individual_count

The number of individuals in the tree

int

read

allow_download_by_site_members

Indicates whether the tree can be downloaded by users who are members of the site

boolean

read

allow_download_by_non_site_members

Indicates whether the tree can be downloaded by users who are not members of the site

boolean

read

is_smart_matching_enabled

Indicates whether Smart Matching is enabled for the tree, allowing individuals from this family tree to be matched with individuals from other family trees

boolean

read

allow_smart_matching_on_living_people

Indicates whether the Smart Matching is enabled on living people allowing, living individuals from this family tree to be matched with individuals from other family trees

boolean

read, write

allow_grabbing_photos

Indicates whether to allow users who are not members of the site and are viewing Smart Matches from their tree to this tree, to copy photos from this tree to their family tree

boolean

read

matches_count

List of matches count in the tree. In case matchescountfilter parameter is defined, returns array of matchescount objects

MatchesCount object: match_type, pending, confirmed, rejected, total, new, ignored_sources, ignored_individuals, aggregated_value_add and class_name fields

read

individual_with_matches_count

The number of individuals having matches for each of the following match statuses: new, confirmed, pending, rejected, all

array of Counter objects containing the id, name, value and class_name fields

read

discoveries_count

The number discoveries in the tree

int

read

matches_latest_marker

Marker of matches last update

int

read

is_auto_published

Indicates whether the tree should be auto published by FamilyTreeBuilder

boolean

read

project_guid

The tree's project guid

string

read

can_edit

If the current user can edit the tree or not

boolean

read

class_name

The object class name

string

read

Connections

The Tree object contains the following connections:
Name Description Type Access Mode

individuals

List of individuals in the tree, sorted by profile Id in ascending order by default (To sort the records in a descending order, you can use the sort_by=desc) . Set the query parameter to include individuals with a certain name. For example query=rick will include individuals with the name Rick, Patrick, etc.

array of Individual objects

read, write

recordmatches_counts

List of record match counts for individuals in the tree

array of RecordMatchesCount objects

read

sources

List of sources of citations in the tree

array of Source objects

read

exportgedcom

Exports GEDCOM (available only to applications that were granted the "ExportGedcom" scope)

ExportGEDCOM object

read

discoveries

List of discoveries available for this tree

array of DiscoveryBase objects

read

Example

https://familygraph.myheritage.com/tree-144530322-1 (open in browser)
{
"id": "tree-144530322-1",
"name": "jfk",
"site": {
"id": "site-144530322",
"name": "Demo Family Site"
},
"link": "https:\/\/www.myheritage.com\/site-family-tree-144530322\/demo-family-site?familyTreeID=1",
"data_languages": [
"EN"
],
"updated_time": "2012-03-20T13:10:16+0000",
"tree_source": "FTB",
"root_individual": {
"id": "individual-144530322-1000001",
"name": "John Fitzgerald Kennedy"
},
"is_public": true,
"individual_count": 167,
"allow_download_by_site_members": true,
"allow_download_by_non_site_members": false,
"is_smart_matching_enabled": true,
"allow_smart_matching_on_living_people": true,
"allow_grabbing_photos": true,
"discoveries_count": 0,
"matches_latest_marker": 1544493851,
"is_auto_published": false,
"project_guid": "7809B640-85F4-48F3-BEA5-7B4B433407BF",
"can_edit": false,
"class_name": "Tree"
}