Browse the tools
Relationships
A relationship is how two people are connected, such as a friend, a sibling or a parent and a child.
Tools
List the relationships of one contact, from either side, a page at a time: the type, both people with the role each holds, whether it is current or ended, and its dates.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringrequired - The id of the contact, as list-contacts gives it.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many relationships a page holds: 25 unless asked, 100 at most.
Read one relationship of a contact: the type, both people with the role each holds, whether it is current or ended, and its dates.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringrequired - The id of either person in the relationship, as list-contacts gives it.
-
relationshipstringrequired - The id of the relationship, as list-contact-relationships gives it.
Add a partner, a family member or any other relative to a contact, with or without a record of their own, by linking them with a relationship type. The other person is an existing contact, a new person named here, or somebody whose name is unknown. One relationship holds both sides, so there is no reverse to add. The change is written to the account log.
-
vaultstringrequired - The id of the vault holding both people, as list-vaults gives it.
-
contactstringrequired - The id of the contact the relationship is recorded from, as list-contacts gives it.
-
relationship_typestringrequired - The id of the relationship type, as list-relationship-types gives it. A type names a role for each side: role_a and role_b. A type that is symmetric gives both sides the same role, as partners do.
-
other_contactstringoptional - The id of the other person, an existing contact of the same vault, as list-contacts gives it. Leave other_contact out to name a new person with first_name, or to record somebody whose name is unknown.
-
first_namestringoptional - The first name of the other person when they are not a contact yet. Not allowed with other_contact.
-
last_namestringoptional - The last name of the other person. Needs first_name.
-
creates_recordbooleanoptional - True to give the person named here a full record of their own in the vault. False when left out: they then exist only through this relationship.
-
holds_role_abooleanoptional - Whether the contact holds role_a of the type and the other person role_b. For parent and child, where role_a is parent, true says the contact is the parent. True when left out. Ignored for a symmetric type.
Change a relationship of a contact: its type, whether it is current or ended, its dates, which side holds which role, or the name of somebody who exists only through it. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringrequired - The id of either person in the relationship, as list-contacts gives it. holds_role_a is read from the side of this person.
-
relationshipstringrequired - The id of the relationship, as list-contact-relationships gives it.
-
relationship_typestringoptional - The id of a new relationship type, as list-relationship-types gives it.
-
statusstringoptional -
Whether the relationship is current or ended. Setting it back to current clears the end date.
One of:
current,ended -
started_onstringoptional - When it started, as YYYY-MM-DD.
-
ended_onstringoptional - When it ended, as YYYY-MM-DD, for an ended relationship. The end cannot fall before the start.
-
holds_role_abooleanoptional - Whether the contact holds role_a of the type and the other person role_b. For parent and child, where role_a is parent, true says the contact is the parent. Ignored for a symmetric type.
-
first_namestringoptional - A first name for the other person, only when they exist through this relationship alone.
-
last_namestringoptional - The last name of the other person. Needs first_name.
-
creates_recordbooleanoptional - True to give the other person, who exists through this relationship alone, a full record of their own.
Delete a relationship. It leaves both contacts at once. Neither person is deleted, including somebody who existed only through it. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringrequired - The id of either person in the relationship, as list-contacts gives it.
-
relationshipstringrequired - The id of the relationship, as list-contact-relationships gives it.