Affinity: V2 Persons Person ID Relationships Get

List a person’s relationships in Affinity with their interaction strength scores from emails and meetings.

Tool ID: affinity_v2_persons_person_id_relationships_get

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'affinity_v2_persons_person_id_relationships_get',
  {
    "personId": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute affinity_v2_persons_person_id_relationships_get --input '{
  "personId": 123
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "data": [
      {
        "person1": {
          "id": 123,
          "firstName": "Jane",
          "lastName": "Doe",
          "primaryEmailAddress": "jane.doe@example.com"
        },
        "person2": {
          "id": 123,
          "firstName": "Jane",
          "lastName": "Doe",
          "primaryEmailAddress": "jane.doe@example.com"
        },
        "interactionScore": 1,
        "linkedIn": {}
      }
    ],
    "pagination": {
      "prevUrl": "https://example.com",
      "nextUrl": "https://example.com"
    }
  }
}

Use deepline describe affinity_v2_persons_person_id_relationships_get --json for the latest machine-readable contract.

Input reference

Returns the relationships for a given person, 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. ## 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. ## LinkedIn connections The collection also includes relationships based on a See the live schema below for the complete notes.

Name	Type	Required	Default	Details
`payload.personId`	`integer`	Yes	—	Person ID Format: `int64`. Minimum: 1. Maximum: 9007199254740991.
`payload.filter`	`string`	No	—	Filter options
`payload.orderBy`	`array`	No	`["-interactionScore"]`	Properties to sort by. Defaults to `-interactionScore`. Prefix with `-` for descending order.
`payload.cursor`	`string`	No	—	Cursor for the next or previous page
`payload.limit`	`integer`	No	`20`	Number of items to include in the page Format: `int32`. Minimum: 1. Maximum: 100.
`payload.totalCount`	`boolean`	No	`false`	Include total count of the collection in the pagination response

Output reference

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	—
`result.data.data`	`array`	Yes	—	Maximum items: 100.
`result.data.data[].person1`	`object`	Yes	—	—
`result.data.data[].person1.id`	`integer`	Yes	—	Format: `int64`. Minimum: 1. Maximum: 9007199254740991.
`result.data.data[].person1.firstName`	`string \| null`	Yes	—	—
`result.data.data[].person1.lastName`	`string \| null`	Yes	—	—
`result.data.data[].person1.primaryEmailAddress`	`string \| null`	Yes	—	Format: `email`.
`result.data.data[].person2`	`object`	Yes	—	—
`result.data.data[].person2.id`	`integer`	Yes	—	Format: `int64`. Minimum: 1. Maximum: 9007199254740991.
`result.data.data[].person2.firstName`	`string \| null`	Yes	—	—
`result.data.data[].person2.lastName`	`string \| null`	Yes	—	—
`result.data.data[].person2.primaryEmailAddress`	`string \| null`	Yes	—	Format: `email`.
`result.data.data[].interactionScore`	`number`	Yes	—	Format: `double`. Minimum: 0. Maximum: 1.
`result.data.data[].linkedIn`	`record`	Yes	—	—
`result.data.pagination`	`object`	Yes	—	—
`result.data.pagination.prevUrl`	`string \| null`	No	—	Format: `uri`.
`result.data.pagination.nextUrl`	`string \| null`	No	—	Format: `uri`.
`result.meta`	`object`	No	—	—

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation