---
title: "Get Relationships for a Company"
method: GET
path: "/v2/companies/{companyId}/relationships"
tags: ["Companies"]
---

# Get Relationships for a Company

`GET /v2/companies/{companyId}/relationships`

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.

## LinkedIn connections

The collection also includes relationships based on a LinkedIn connection between an internal
team member and a person related to this company. Whenever a LinkedIn connection exists between 
the two persons in a relationship, `linkedIn` is populated with the date the connection was made. 
`linkedIn` is `null` when no LinkedIn connection between the two persons is known by Affinity. 
Note that LinkedIn-based relationships which do not have any interaction data will have an 
`interactionScore` of `0`.

## 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` |

## Sorting

You can sort relationships using the `orderBy` query parameter. `interactionScore` is the only
sortable property.

## Path parameters

- `companyId` integer, required

## Query parameters

- `filter` string
- `orderBy` string[]
- `cursor` string
- `limit` integer
- `totalCount` boolean

## Response `200`

OK

- RelationshipsPaged — A paginated list of relationships
  - `data` Relationship[], required — A page of Relationship objects
    - `person1` RelationshipPerson, required — A person involved in a relationship, including basic identifying information.
      - `id` integer, required — The person's unique identifier
      - `firstName` string, nullable, required — The person's first name
      - `lastName` string, nullable, required — The person's last name
      - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
    - `person2` RelationshipPerson, required — A person involved in a relationship, including basic identifying information.
      - `id` integer, required — The person's unique identifier
      - `firstName` string, nullable, required — The person's first name
      - `lastName` string, nullable, required — The person's last name
      - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
    - `interactionScore` number, double, required — A score between 0.0 and 1.0 representing the strength of the relationship based on communication patterns such as emails, meetings, and other interactions. Higher scores indicate stronger relationships.
    - `linkedIn` RelationshipLinkedIn, required — LinkedIn connection details for the two persons in a relationship.
      - `connectedOn` string, date, required — The date the LinkedIn connection was established.
  - `pagination` PaginationWithTotalCount, required
    - `prevUrl` string, uri, nullable — URL for the previous page
    - `nextUrl` string, uri, nullable — URL for the next page

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `default` — Errors

---

[API](https://skmtc.net/affinity/apis/affinity-api-v2.md) · [All operations](https://skmtc.net/affinity/apis/affinity-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinity/affinity-api-v2/revisions/4c2891c31b7f/schema)