Site

A family site as represented in the Family Graph API.

Family sites are created by users in order to have a website for their family. Users can invite other family members to the site. A family site can include several family trees, in which individuals and families are defined. A family site can also contain media items such as photos, documents, videos and audios.


Fields

The Site object contains the following fields:

Name Description Type Access Mode

id

The site's id

id

read

name

The site's name

string

read

description

The site's description

string

read

sub_domain

The site's sub-domain (subdomain.myheritage.com)

string

read

link

Link to site on MyHeritage.com

string

read

plan

The site's subscription plan

  • basic - Basic (free) site

  • premium - Premium site

  • premium-plus - PremiumPlus site

string

read

privacy_policy

The site's privacy policy

  • public - site is public

  • mixed - some of the content in the site is private and some is public

  • private - site is private

string

read

site_logo

The site's logo image

Photo object: id and name fields

read

creator

The user who created the site

User object: id and name fields

read

created_date

The date when the site was created

string (YYYY-MM-DD)

read

plan_expiry_date

The date when the site's plan will expire (or has expired)

string (YYYY-MM-DD)

read

default_tree

The family tree in the site where users are taken to by default

Tree object: id and name fields

read

default_root_individual

The root individual in the default family tree

Individual object: id and name fields

read

member_count

The number of users who are members in the site

int

read

album_count

The number of media albums in the site

int

read

media_count

The number of media items in the site

int

read

tree_count

The number of family trees in the site

int

read

is_listed_in_site_center

Indicates whether the site is listed in the site center

boolean

read

can_members_edit_trees

Indicates whether members of the site can edit trees of the site

boolean

read

can_members_post_content

Indicates whether members of the site can post content to the site

boolean

read

can_member_manage_media

Indicates whether the current member can manage media of the site

boolean

read

is_request_membership_allowed

Indicates whether users who are not members of the site can request membership in the site

boolean

read

can_members_invite_other_members

Indicates whether members of the site can invite other people to the site

boolean

read

is_site_opened_for_guests

Indicates whether guests can view limited information on the site

boolean

read

notify_managers_on_membership_request

Indicates whether managers of the site will be notified upon membership request in the site

boolean

read

is_in_discoveries_cooloff

Returns whether the site is in discoveries cooloff or not

boolean

read

matches_count

List of matches count in the site. 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

class_name

The object class name

string

read

Connections

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

memberships

List of users who are members of the site

array of Membership objects

read

trees

List of family trees in the site

array of Tree objects

read, write

albums

List of albums in the site

array of Album objects

read, write

invitations

List of invitations to the site

array of Invitation objects

read, write

media

List of media items in the site (sorted by created_date, most recent first)

array of MediaItem objects

read

Example

https://familygraph.myheritage.com/site-144530322 (open in browser)
{
"id": "site-144530322",
"name": "Demo Family Site",
"description": "Demo family site for developers",
"sub_domain": "demosite",
"link": "https:\/\/www.myheritage.com\/site-144530322\/demo-family-site",
"plan": "basic",
"privacy_policy": "public",
"creator": {
"id": "user-10",
"name": "Developer MyHeritage"
},
"created_date": "2011-03-03",
"plan_expiry_date": "2012-03-03",
"default_tree": {
"id": "tree-144530322-1",
"name": "jfk"
},
"default_root_individual": {
"id": "individual-144530322-1000028",
"name": "Joseph Patrick Kennedy II"
},
"member_count": 1,
"album_count": 6,
"media_count": 305,
"tree_count": 3,
"is_listed_in_site_center": false,
"can_members_edit_trees": true,
"can_members_post_content": true,
"can_member_manage_media": true,
"is_request_membership_allowed": true,
"can_members_invite_other_members": true,
"is_site_opened_for_guests": true,
"notify_managers_on_membership_request": true,
"is_in_discoveries_cooloff": false,
"class_name": "Site"
}