Get a list of relationship types with their inverse pairings Run in API Explorer
Ask AI
GET
/api/v1/static/relationship-types
curl \
--request GET 'https://api.plannrcrm.com/api/v1/static/relationship-types' \
--header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
"data": [
{
"value": "attorney",
"label": "Attorney",
"inverse_value": "client_of_attorney",
"inverse_label": "Client of Attorney"
},
{
"value": "aunt_uncle",
"label": "Aunt / Uncle",
"inverse_value": "niece_nephew",
"inverse_label": "Niece / Nephew"
},
{
"value": "beneficiary",
"label": "Beneficiary",
"inverse_value": "trust",
"inverse_label": "Trust"
},
{
"value": "business_partner",
"label": "Business Partner",
"inverse_value": "business_partner",
"inverse_label": "Business Partner"
},
{
"value": "child",
"label": "Child",
"inverse_value": "parent",
"inverse_label": "Parent"
},
{
"value": "civil-partner",
"label": "Civil Partner",
"inverse_value": "civil-partner",
"inverse_label": "Civil Partner"
},
{
"value": "client",
"label": "Client",
"inverse_value": "client",
"inverse_label": "Client"
},
{
"value": "client_of_attorney",
"label": "Client of Attorney",
"inverse_value": "attorney",
"inverse_label": "Attorney"
},
{
"value": "co-director",
"label": "Co-director",
"inverse_value": "co-director",
"inverse_label": "Co-director"
},
{
"value": "co-habiting",
"label": "Co-habiting",
"inverse_value": "co-habiting",
"inverse_label": "Co-habiting"
},
{
"value": "common-law",
"label": "Common Law",
"inverse_value": "common-law",
"inverse_label": "Common Law"
},
{
"value": "cousin",
"label": "Cousin",
"inverse_value": "cousin",
"inverse_label": "Cousin"
},
{
"value": "dependent",
"label": "Dependent",
"inverse_value": "guardian",
"inverse_label": "Guardian"
},
{
"value": "director",
"label": "Director",
"inverse_value": "employee",
"inverse_label": "Employee"
},
{
"value": "employee",
"label": "Employee",
"inverse_value": "employer",
"inverse_label": "Employer"
},
{
"value": "engaged",
"label": "Engaged",
"inverse_value": "engaged",
"inverse_label": "Engaged"
},
{
"value": "employer",
"label": "Employer",
"inverse_value": "employee",
"inverse_label": "Employee"
},
{
"value": "ex-employer",
"label": "Ex Employer",
"inverse_value": "ex-employee",
"inverse_label": "Ex-employee"
},
{
"value": "ex-partner",
"label": "Ex-Partner",
"inverse_value": "ex-partner",
"inverse_label": "Ex-Partner"
},
{
"value": "ex-spouse",
"label": "Ex-Spouse",
"inverse_value": "ex-spouse",
"inverse_label": "Ex-Spouse"
},
{
"value": "ex-employee",
"label": "Ex-employee",
"inverse_value": "ex-employer",
"inverse_label": "Ex Employer"
},
{
"value": "friend",
"label": "Friend",
"inverse_value": "friend",
"inverse_label": "Friend"
},
{
"value": "grandchild",
"label": "Grandchild",
"inverse_value": "grandparent",
"inverse_label": "Grandparent"
},
{
"value": "grandparent",
"label": "Grandparent",
"inverse_value": "grandchild",
"inverse_label": "Grandchild"
},
{
"value": "guardian",
"label": "Guardian",
"inverse_value": "dependent",
"inverse_label": "Dependent"
},
{
"value": "in-law",
"label": "In Law",
"inverse_value": "in-law",
"inverse_label": "In Law"
},
{
"value": "key-person",
"label": "Key Person",
"inverse_value": "key-person",
"inverse_label": "Key Person"
},
{
"value": "niece_nephew",
"label": "Niece / Nephew",
"inverse_value": "aunt_uncle",
"inverse_label": "Aunt / Uncle"
},
{
"value": "other",
"label": "Other",
"inverse_value": "other",
"inverse_label": "Other"
},
{
"value": "parent",
"label": "Parent",
"inverse_value": "child",
"inverse_label": "Child"
},
{
"value": "parent-company",
"label": "Parent Company",
"inverse_value": "parent-company",
"inverse_label": "Parent Company"
},
{
"value": "partner",
"label": "Partner",
"inverse_value": "partner",
"inverse_label": "Partner"
},
{
"value": "primary-contact",
"label": "Primary Contact",
"inverse_value": "primary-contact",
"inverse_label": "Primary Contact"
},
{
"value": "relative",
"label": "Relative",
"inverse_value": "relative",
"inverse_label": "Relative"
},
{
"value": "separated",
"label": "Separated",
"inverse_value": "separated",
"inverse_label": "Separated"
},
{
"value": "settlor",
"label": "Settlor",
"inverse_value": "trust",
"inverse_label": "Trust"
},
{
"value": "shareholder",
"label": "Shareholder",
"inverse_value": null,
"inverse_label": null
},
{
"value": "shareholder-director",
"label": "Shareholder Director",
"inverse_value": "shareholder",
"inverse_label": "Shareholder"
},
{
"value": "shareholder-non-director",
"label": "Shareholder Non-Director",
"inverse_value": "shareholder",
"inverse_label": "Shareholder"
},
{
"value": "sibling",
"label": "Sibling",
"inverse_value": "sibling",
"inverse_label": "Sibling"
},
{
"value": "spouse",
"label": "Spouse",
"inverse_value": "spouse",
"inverse_label": "Spouse"
},
{
"value": "step-child",
"label": "Step-Child",
"inverse_value": "step-parent",
"inverse_label": "Step-Parent"
},
{
"value": "step-parent",
"label": "Step-Parent",
"inverse_value": "step-child",
"inverse_label": "Step-Child"
},
{
"value": "trust",
"label": "Trust",
"inverse_value": null,
"inverse_label": null
},
{
"value": "trustee",
"label": "Trustee",
"inverse_value": "trust",
"inverse_label": "Trust"
},
{
"value": "widow",
"label": "Widow",
"inverse_value": "widower",
"inverse_label": "Widower"
},
{
"value": "widower",
"label": "Widower",
"inverse_value": "widow",
"inverse_label": "Widow"
},
{
"value": "work-colleague",
"label": "Work Colleague",
"inverse_value": "work-colleague",
"inverse_label": "Work Colleague"
}
]
}