Relationship

👍 Required plan

Available only in the SOCIAL plan and up.

This field is a bit different, because it is a short descriptor of another person.

Member	Type	Description
@type	String	Either one of 'work,’ 'family,’ 'friend,’ or 'other’. Default is 'friend’.
@subtype	String	A free text providing further info on the association. For example, Father.
names	Name[]	Array of names

Search Requirements

For a Relationship object to be useful for a search, it must include at least a valid name object.

Example

{
    "@type": "family", 
    "@subtype": "Adoptive Father", 
    "names": [
        {
            "first": "Jonathan", 
            "last": "Kent", 
            "display": "Jonathan Kent"
        }
    ] 
}