Get Relationships for a Company
| ⚠️ This endpoint is currently in BETA |
|---|
Returns the relationships for a given company, including the interaction score that measures the strength of each relationship based on communication patterns such as emails, meetings, and other interactions.
Each relationship includes two persons (person1 and person2) who have a connection related to this company.
Interaction score
The interactionScore is a value between 0.0 and 1.0 that reflects how frequently the
two persons interact across email, calendar events, and chat messages. The more interactions,
the higher the score. Recent interactions are weighted slightly higher than older ones. As
rough guidance, scores at or above 0.7 typically indicate two persons that communicate
regularly, scores between 0.4 and 0.7 indicate occasional communication, and scores below
0.4 indicate only sporadic communication.
Filters
You can filter relationships using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties.
| Property Name | Type | Description | Allowed Operators | Examples |
|---|---|---|---|---|
interactionScore | double | Strength of the relationship, between 0.0 and 1.0. Higher means stronger. | >, <, >=, <= | interactionScore>=0.5 |
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Company ID
1 <= x <= 9007199254740991Query Parameters
Filter options
Cursor for the next or previous page
Number of items to include in the page
1 <= x <= 100Include total count of the collection in the pagination response