Get Coworker Inferred Connections
| ⚠️ This endpoint is currently in BETA |
|---|
Returns inferred connections based on shared work history, grouped by the target person, strongest first.
A connection is the belief that a source (a person in your Affinity data, with an id, whom you know) might know a target (a person not in your Affinity data, described only, whom you want to know), because the two had overlapping employment at a shared company.
The same target can be reachable through several people you know. Connections are grouped by target: each item in data is one target together with the connections to them. Within a target, connections are ordered by confidence descending; targets are ordered by their strongest connection, strongest first.
Each target carries the company they work at today in target.currentCompany: the company at which they are a potential contact now, which is not necessarily the shared employer behind the connection.
The filter parameter is required and must contain at least one filter. The only currently supported filter is target.currentCompany.id, which narrows the targets to a single such company.
Filters
| Property Name | Type | Description | Allowed Operators | Examples |
|---|---|---|---|---|
target.currentCompany.id | integer | The id of the company the target person currently works at. Must reference a single company; filtering on more than one (e.g. target.currentCompany.id = 1 | target.currentCompany.id = 2) returns a 400. | = | target.currentCompany.id = 123 |
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter options. At least one filter is required; the only currently supported filter is target.currentCompany.id, which narrows the targets to the one company the target person currently works at. Filtering on more than one company returns a 400.
Cursor for the next or previous page
Number of targets to include in the page
1 <= x <= 50Include total count of the collection in the pagination response
Response
OK
A paginated list of shared-work-history connections grouped by target person. Each item is one target and the connections inferred to them.