Unipile: List Relations

List the first-degree connections (relations) of a connected LinkedIn account.

Tool ID: unipile_list_relations

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(
  'unipile_list_relations',
  {
    "account_id": "123456789"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute unipile_list_relations --input '{
  "account_id": "123456789"
}' --json

Example response

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

{
  "data": {
    "object": "UserRelationsList",
    "items": [
      {
        "object": "UserRelation",
        "first_name": "Jane",
        "last_name": "Doe",
        "headline": "example",
        "public_identifier": "example_123",
        "public_profile_url": "https://example.com",
        "created_at": 123,
        "member_id": "member_123",
        "member_urn": "example",
        "connection_urn": "example"
      }
    ],
    "cursor": "cursor_123"
  }
}

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

Input reference

Returns a list of all the relations of an account. Ensure careful implementation of this action and consult provider limits and restrictions: https://developer.unipile.com/docs/provider-limits-and-restrictions

Name	Type	Required	Default	Details
`payload.cursor`	`string`	No	—	A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. Minimum length: 1.
`payload.filter`	`string`	No	—	Filter out results by user name.
`payload.limit`	`integer`	No	—	A limit for the number of items returned in the response. The value can be set between 1 and 1000. Minimum: 1. Maximum: 1000.
`payload.account_id`	`string`	Yes	—	The account to get the relations from. (if user_id is not provided)

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.object`	`"UserRelationsList"`	Yes	—	Allowed: `UserRelationsList`.
`result.data.items`	`array`	Yes	—	—
`result.data.items[].object`	`"UserRelation"`	Yes	—	Allowed: `UserRelation`.
`result.data.items[].first_name`	`string`	Yes	—	—
`result.data.items[].last_name`	`string`	Yes	—	—
`result.data.items[].headline`	`string`	Yes	—	—
`result.data.items[].public_identifier`	`string`	Yes	—	—
`result.data.items[].public_profile_url`	`string`	Yes	—	—
`result.data.items[].created_at`	`number`	Yes	—	—
`result.data.items[].member_id`	`string`	Yes	—	—
`result.data.items[].member_urn`	`string`	Yes	—	—
`result.data.items[].connection_urn`	`string`	Yes	—	—
`result.data.items[].profile_picture_url`	`string`	No	—	—
`result.data.cursor`	`unknown \| null`	Yes	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

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