Browse the tools
Relationship vocabulary
A relationship type is the word for how two people are connected, such as Sibling or Friend, filed under a category such as Family.
Tools
List the kinds of relationship the account has defined, such as parent or colleague.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many relationship types a page holds: 25 unless asked, 100 at most.
Read one kind of relationship: its name, the role of each contact, its category, whether it reads the same both ways, whether it is offered, whether it came with the account and how many relationships use it.
-
relationship_typestringrequired - The id of the relationship type, as list-relationship-types gives it.
List the categories the account files its kinds of relationship under.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many categories a page holds: 25 unless asked, 100 at most.
Read one category of relationship types: its name, position, whether it is offered, whether it came with the account and how many types it holds.
-
relationship_categorystringrequired - The id of the category, as list-relationship-categories gives it.
List the kinds of relationship filed under one category, in the order they are offered.
-
relationship_categorystringrequired - The id of the category, as list-relationship-categories gives it.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many relationship types a page holds: 25 unless asked, 100 at most.
Create a kind of relationship two contacts can be linked by, such as godparent and godchild, in one of the account’s categories. The change is written to the account log.
-
relationship_category_idstringrequired - The id of the category, as list-relationship-categories gives it.
-
namestringrequired - The name of the kind of relationship, such as Godparent.
-
role_astringrequired - The role of the first contact, such as godparent.
-
role_bstringoptional - The role of the other contact, such as godchild. Required when is_symmetric is false.
-
is_symmetricbooleanoptional - True when both contacts hold the same role, as with siblings. True when left out.
-
is_activebooleanoptional - Whether it is offered when contacts are linked. True when left out.
Rename a kind of relationship, change its roles or whether it reads the same both ways, or move it to another category. Whether it is offered changes with set-relationship-type-activation. The change is written to the account log.
-
relationship_typestringrequired - The id of the relationship type, as list-relationship-types gives it.
-
relationship_category_idstringoptional - The id of the category to move it to, as list-relationship-categories gives it.
-
namestringoptional - The new name.
-
role_astringoptional - The new role of the first contact.
-
role_bstringoptional - The new role of the other contact. It cannot be null when is_symmetric is false.
-
is_symmetricbooleanoptional - True when both contacts hold the same role. A type that came with the account, or that relationships use, keeps its direction.
Offer a kind of relationship when contacts are linked, or stop offering it. Relationships already written with it stay. The change is written to the account log.
-
relationship_typestringrequired - The id of the relationship type, as list-relationship-types gives it.
-
is_activebooleanrequired - True to offer it, false to stop offering it.
Move a kind of relationship to another place within its category. The change is written to the account log.
-
relationship_typestringrequired - The id of the relationship type, as list-relationship-types gives it.
-
positionintegerrequired - Where it goes within its category, counting from 1.
Delete a kind of relationship the account created. One that came with the account, or that relationships use, is refused; stop offering it instead. The change is written to the account log.
-
relationship_typestringrequired - The id of the relationship type, as list-relationship-types gives it.
Create a category to file kinds of relationship under, such as Sports. It is added at the end of the list. The change is written to the account log.
-
namestringrequired - The name of the category, such as Sports.
Rename a category the account created. One that came with the account keeps its name. The change is written to the account log.
-
relationship_categorystringrequired - The id of the category, as list-relationship-categories gives it.
-
namestringoptional - The new name.
Offer a category of relationship types when contacts are linked, or stop offering it. Relationships already written stay. The change is written to the account log.
-
relationship_categorystringrequired - The id of the category, as list-relationship-categories gives it.
-
is_activebooleanrequired - True to offer it, false to stop offering it.
Move a category of relationship types to another place in the list. The change is written to the account log.
-
relationship_categorystringrequired - The id of the category, as list-relationship-categories gives it.
-
positionintegerrequired - Where it goes in the list of categories, counting from 1.
Delete a category the account created. One that came with the account, or that still holds types, is refused; move its types to another category first. The change is written to the account log.
-
relationship_categorystringrequired - The id of the category, as list-relationship-categories gives it.