Family

A family in a family tree as represented in the Family Graph API.

A family can have a husband and a wife (not necessarily married and not necessarily male and female) and a list of children. Families have several properties and connections.

Fields

The Family object contains the following fields:

Name	Description	Type	Access Mode
id	The family's id	id	read
status	The family's relationship status unknown - Unknown friends - Friends partners - Partner engaged - Engaged married - Married separated - Separated annulled - Annulment divorced - Divorced other - Other widowed - Widowed	string	read, write
husband	The husband in the family	Individual object: id and name fields	read, write
wife	The wife in the family	Individual object: id and name fields	read, write
link	Link to family on MyHeritage.com	string	read
marriage_date	The family's marriage date	EventDate object: gedcom, text, date, structured_date and class_name fields	read, write
children	List of the children in the family	array of ChildInFamily objects containing the child, family, child_type and class_name fields	read, write
tree	The family tree the family is part of	Tree object: id and name fields	read
site	The family site of family's tree	Site object: id and name fields	read
class_name	The object class name	string	read

Connections

The Family object contains the following connections:

Name	Description	Type	Access Mode
children_connection	List of the children in the family	array of ChildInFamily objects	read, write
media	List of media items of the family, including photos, videos, documents and audios	array of MediaItem objects	read
events	List of family events of the family, including marriage and other events related to the family	array of FamilyEvent objects	read, write
citations	List of citations of the family	array of Citation objects	read
notes	List of notes of the family	array of Note objects	read
sub_tree	List of relatives of this family. To specify which relatives to return set the following parameters: ancestor_depth - indicates the direct ancestors degree to include in the list. Default value is 2 (grandparents) base_level - indicates the base level from which direct descendants should be included in the list. Default value is 1 (from parents level) descendant_depth - indicates the direct descendants degree to include in the list. Default value is 3 (3 generations from the base_level)	SubTree object	read

Example

https://familygraph.myheritage.com/family-144530322-1000001 (open in browser)

{
	"id": "family-144530322-1000001",
	"status": "married",
	"husband": {
		"id": "individual-144530322-1000001",
		"name": "John Fitzgerald Kennedy"
	},
	"wife": {
		"id": "individual-144530322-1000002",
		"name": "Jacqueline Lee Kennedy Onassis (born Bouvier)"
	},
	"link": "https:\/\/www.myheritage.com\/family-1_1000001_144530322_144530322\/kennedy-john-fitzgerald-kennedy-jacqueline-lee-kennedy-onassis-born-bouvier",
	"marriage_date": {
		"gedcom": "Sep 12 1953",
		"text": "Sep 12 1953",
		"date": "1953-09-12",
		"structured_date": {
			"first_date": {
				"day": 12,
				"month": 9,
				"year": 1953,
				"type": "exact",
				"class_name": "SingleDate"
			},
			"type": "exact",
			"class_name": "StructuredDate"
		},
		"class_name": "EventDate"
	},
	"children": [
		{
			"child": {
				"id": "individual-144530322-1000090",
				"name": "Arabella Kennedy"
			},
			"class_name": "ChildInFamily"
		},
		{
			"child": {
				"id": "individual-144530322-1000003",
				"name": "Caroline Bouvier Schlossberg (born Kennedy)"
			},
			"class_name": "ChildInFamily"
		},
		{
			"child": {
				"id": "individual-144530322-1000004",
				"name": "John Fitzgerald \"John-John\" Kennedy, Jr."
			},
			"class_name": "ChildInFamily"
		},
		{
			"child": {
				"id": "individual-144530322-1000091",
				"name": "Patrick Bouvier Kennedy"
			},
			"class_name": "ChildInFamily"
		}
	],
	"tree": {
		"id": "tree-144530322-1",
		"name": "jfk"
	},
	"site": {
		"id": "site-144530322",
		"name": "Demo Family Site"
	},
	"class_name": "Family"
}