Relationship types

Every relationship in Rightsline has a distinct type, indicated by a Relationship Type Name and Relationship Type ID.

"relationshipType": {
    "relationshipTypeId": 0,
    "relationshipTypeName": "string"
}

The two main relationship types are:

Relationship Type ID
Relationship Type Name

0

Explicit

1

Implicit

Explicit relationships describe two records that are directly related. Implicit relationships are relationships that are implied based on the records sharing some common ancestry in their hierarchy.

A special type of relationship type is that of a party relationship. A contact that is related to another record as a party will have a relationship type ID and name equal to the party ID and name.

To retrieve the relationship types that are configured in Rightsline, you can use the following endpoint:

Get relationship types

GET https://api.rightsline.com/v4/relationship-types

This endpoint allows you to retrieve the possible entity relationship types.

Headers

Name
Type
Description

x-api-key

string

Your company's API key.

Authentication

string

Authentication token.

Last updated

Was this helpful?