- Family Graph API
- Objects
- AggregateValueAdd
- Album
- Audio
- BuyNowData
- ChildInFamily
- Citation
- ColorizationData
- Comment
- Config
- ConfirmationStatus
- Counter
- Device
- DiscoveryBase
- DnaAncestorName
- DnaEnums
- DnaEthnicity
- DnaEthnicityReport
- DnaKit
- DnaKitFile
- DnaMatch
- DnaMatchCommonAncestor
- DnaMatchNote
- DnaMatchRelationship
- DnaOrderItemShippingDetails
- Document
- Enums
- EthnicityInLocation
- Event
- EventDate
- EventPlace
- ExportGEDCOM
- ExportGEDCOMStatus
- Family
- FamilyEvent
- GenealogyEvent
- GoalActivity
- Image
- Individual
- Installation
- Invitation
- MatchesCount
- MatchingRequest
- MediaItem
- Membership
- Navigation
- NavigationItem
- NavigationItemBadge
- NewPhotoInfo
- Note
- Notification
- NotificationHistory
- OrderItemCoupon
- OrderItemShippingDetails
- Page
- PersonalPhotosDiscovery
- Phones
- Photo
- PhotoVersion
- Range
- RecordColorizationData
- RecordIndividual
- RecordMatchesCount
- Relationship
- ResiEvent
- ShippingOption
- SingleDate
- Site
- SmartMatch
- Source
- StructuredDate
- StructuredPlace
- SubTree
- SuggestedRelative
- System
- Tag
- ThreadsCount
- Tree
- TreeItem
- User
- UserMenu
- ValueAddData
- ValueAddElement
- ValueAddFactor
- Video
- WorldEthnicities
- SDKs
- PHP SDK
- iOS SDK
- Android SDK
User
A registered MyHeritage.com user as represented in the Family Graph API.
Users represent people who registered to MyHeritage.com. A user can be a member in several family sites. In each family site, a user can be associated to an Individual in a family tree who represents this person in the family tree. The API only returns information about users who are members of family sites that the current user is also a member of.
Fields
The User
object contains the following fields:
Name | Description | Type | Access Mode |
id |
The user's id |
id |
read |
name |
The user's full name |
string |
read |
The user's email address (returned only for applications that were granted the "email" scope) |
string |
read |
|
first_name |
The user's first name |
string |
read |
last_name |
The user's last name |
string |
read |
nickname |
The user's nickname |
string |
read, write |
gender |
The user's gender
|
string |
read, write |
preferred_display_language |
The user's preferred display language (ISO-639-1 code) |
string |
read |
preferred_email_language |
The user's preferred language for emails (ISO-639-1 code) |
string |
read |
link |
Link to user on MyHeritage.com |
string |
read |
birth_date |
The user's birth date |
EventDate object: gedcom, text, date, structured_date and class_name fields |
read, write |
address |
The user's first address line. Available only for current user. |
string |
read, write |
address2 |
The user's second address line. Available only for current user. |
string |
read |
city |
The user's city |
string |
read, write |
country_code |
The user's country code |
string |
read, write |
country_code_by_ip |
The user's country code based on their IP address |
string |
read |
country |
The user's country name |
string |
read |
state_or_district |
The user's state or district |
string |
read, write |
state_or_district_by_ip |
The user's state or district based on their IP address |
string |
read |
zip_code |
The user's zip or postal code |
string |
read, write |
created_time |
The date and time when the user was created on MyHeritage.com |
string (YYYY-MM-DD HH:MM:SS) |
read |
last_visit_time |
The date and time when the user last visited MyHeritage.com |
string (YYYY-MM-DD HH:MM:SS) |
read |
is_public |
Indicates whether the user's profile public and can be searched for |
boolean |
read |
show_age |
Indicates whether to show the user's age to strangers (people who are not members of family site this user is also a member of) |
boolean |
read |
allow_posting_comments |
Indicates whether other users can post comments to the user's profile |
boolean |
read |
notify_on_comment |
Indicates whether the user is notified on when a comment is posted to the user's profile |
boolean |
read |
show_real_name |
Indicates whether the user's real name or nickname is visible to strangers (people who are not members of family site this user is also a member of) |
boolean |
read, write |
reports_full_name |
User's full name displayed on health reports |
array of strings |
read, write |
personal_photo |
The personal photo (profile photo) of the user |
Photo object: id and name fields |
read, write |
default_site |
The family site the user visits by default |
Site object: id and name fields |
read |
default_tree |
The tree where this user is associated in the user's default family site |
Tree object: id and name fields |
read |
default_individual |
The individual associated with this user in the user's default family site |
Individual object: id and name fields |
read |
phones |
The user's phones info. Available only for current user. |
Phones object: home_phone, work_phone, mobile_phone, home_fax, work_fax and class_name fields |
read, write |
age_group |
The user's age_group. Possible values are 'A' (for adult) and 'C' (for child). |
string |
read |
age_group_in_years |
The user's age_group in years e.g. 30's, 60's etc. |
string |
read |
new_notifications_count |
The number of unseen user's notifications |
int |
read |
colorization_count |
Number of photos that are in process of colorization plus successfully colorized |
int |
read |
color_restoration_count |
Number of photos that are in process of color restoration plus successfully restored |
int |
read |
enhancement_count |
Number of photos that are in process of enhancement plus successfully enhanced |
int |
read |
photo_with_portrait_animation_count |
Number of photos that have at lest one triggered portrait animation for related portrait |
int |
read |
class_name |
The object class name |
string |
read |
Connections
The User object contains the following connections:Name | Description | Type | Access Mode |
memberships |
List of memberships of the user in family sites |
array of Membership objects |
read |
picture |
Picture (profile photo) of the user |
array of Photo objects |
read, write |
devices |
The user's devices |
array of Device objects |
read, write |
dna_kits |
The user's DNA kits |
array of DnaKit objects |
read, write |
notifications_history |
The user's notifications history |
array of NotificationHistory objects |
read, write |
Example
https://familygraph.myheritage.com/user-10 (open in browser){
"id": "user-10",
"name": "Developer MyHeritage",
"first_name": "Developer",
"last_name": "MyHeritage",
"nickname": "dev",
"gender": "M",
"preferred_display_language": "EN",
"preferred_email_language": "EN",
"link": "https:\/\/www.myheritage.com\/member-10_1\/developer-myheritage",
"birth_date": {
"text": "July 28 1975",
"date": "1975-07-28",
"structured_date": {
"first_date": {
"day": 28,
"month": 7,
"year": 1975,
"type": "exact",
"class_name": "SingleDate"
},
"type": "exact",
"class_name": "StructuredDate"
},
"class_name": "EventDate"
},
"age": {
"text": 45,
"class_name": "DateDifference"
},
"address": "Tilling Road",
"city": "London",
"country_code": "GB",
"country_code_by_ip": "US",
"country": "United Kingdom",
"state_or_district_by_ip": "VA",
"zip_code": "NW2 1LJ",
"created_time": "2006-06-26T16:40:50+0000",
"last_visit_time": "2019-12-04T14:43:59+0000",
"is_public": true,
"show_age": true,
"allow_posting_comments": false,
"notify_on_comment": false,
"show_real_name": true,
"reports_full_name": [
"",
""
],
"personal_photo": {
"id": "photo-0-3-12181762"
},
"default_site": {
"id": "site-144530322",
"name": "Demo Family Site"
},
"default_tree": {
"id": "tree-144530322-1",
"name": "jfk"
},
"default_individual": {
"id": "individual-144530322-1000028",
"name": "Joseph Patrick Kennedy II"
},
"age_group": "A",
"age_group_in_years": "40's",
"suggestions": {
"id": "suggestions-10"
},
"new_notifications_count": 0,
"colorization_count": 0,
"color_restoration_count": 0,
"enhancement_count": 0,
"photo_with_portrait_animation_count": 0,
"preferences": {
"id": "userpreferences-10"
},
"class_name": "User"
}