The Swarm: Theswarm Relationships V3

Find connected profiles and connection details matching a query.

Tool ID: theswarm_relationships_v3

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'theswarm_relationships_v3',
  {
    "query": {}
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute theswarm_relationships_v3 --input '{
  "query": {}
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "items": [
      {
        "profile": {
          "full_name": "Example"
        },
        "connections": [
          {}
        ]
      }
    ],
    "count": 123,
    "total_count": 123
  }
}

Use deepline tools get theswarm_relationships_v3 --json for the latest machine-readable contract.

Input reference

Find connected profiles with their connection details. Renamed from Network Mapper in v3.

Name	Type	Required	Default	Details
`payload.query`	`object`	Yes	—	Search query in the ElasticSearch Query DSL format. Find mapping here
`payload.limit`	`integer`	No	`100`	Limit the number of results Minimum: 0. Maximum: 1000.
`payload.pagination_token`	`string`	No	—	Pagination token received in the previous response

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.items`	`array`	Yes	—	—
`result.data.items[].profile`	`object`	No	—	—
`result.data.items[].profile.id`	`string`	No	—	Format: `uuid`.
`result.data.items[].profile.full_name`	`string`	Yes	—	—
`result.data.items[].profile.current_title`	`string`	No	—	—
`result.data.items[].profile.linkedin_url`	`string`	No	—	—
`result.data.items[].profile.work_email`	`string`	No	—	—
`result.data.items[].profile.current_company_name`	`string`	No	—	—
`result.data.items[].profile.current_company_website`	`string`	No	—	—
`result.data.items[].connections`	`array`	No	—	—
`result.data.items[].connections[].connector_id`	`string`	No	—	Format: `uuid`.
`result.data.items[].connections[].connector_name`	`string`	No	—	—
`result.data.items[].connections[].connector_linkedin_url`	`string`	No	—	—
`result.data.items[].connections[].connector_current_title`	`string`	No	—	—
`result.data.items[].connections[].connector_current_company_name`	`string`	No	—	—
`result.data.items[].connections[].connection_strength_normalized`	`integer`	No	—	—
`result.data.items[].connections[].connection_strength`	`number`	No	—	Format: `float`.
`result.data.items[].connections[].manual_strength`	`number`	No	—	Format: `float`.
`result.data.items[].connections[].sources`	`array`	No	—	—
`result.data.items[].connections[].sources[].origin`	`"linkedin_connection" \| "work_overlap" \| "email_contact" \| "calendar_events" \| "manual_import" \| "education_overlap" \| "shared_investor"`	Yes	—	Allowed: `linkedin_connection`, `work_overlap`, `email_contact`, `calendar_events`, `manual_import`, `education_overlap`, `shared_investor`.
`result.data.items[].connections[].sources[].shared_company`	`string`	No	—	Name of the shared company from work overlap
`result.data.items[].connections[].sources[].shared_company_id`	`string`	No	—	ID of the shared company from work overlap Format: `uuid`.
`result.data.items[].connections[].sources[].shared_company_website`	`string`	No	—	Website of the shared company from work overlap
`result.data.items[].connections[].sources[].shared_company_linkedin_slug`	`string`	No	—	Linkedin Slug of the shared company from work overlap
`result.data.items[].connections[].sources[].overlap_start_date`	`string`	No	—	Start Date of work overlap
`result.data.items[].connections[].sources[].overlap_end_date`	`string`	No	—	End Date of work overlap
`result.data.items[].connections[].sources[].overlap_duration_months`	`integer`	No	—	Months Duration of work overlap
`result.data.items[].connections[].sources[].shared_school`	`string`	No	—	Name of school from education overlap
`result.data.items[].connections[].sources[].shared_major`	`string`	No	—	Name of major from education overlap
`result.data.items[].connections[].sources[].graduation_year`	`string`	No	—	Graduation year from education overlap
`result.data.items[].connections[].sources[].investor`	`string`	No	—	Name of common investor from investor overlap
`result.data.items[].connections[].sources[].portfolio_company`	`string`	No	—	Name of portfolio company from investor overlap
`result.data.count`	`integer`	Yes	—	—
`result.data.total_count`	`integer`	Yes	—	—
`result.data.pagination_token`	`string`	No	—	Pagination token for the next request
`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.

Get started

Build and automate

Common workflows

Data and integrations

Reference

The Swarm: Theswarm Relationships V3

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​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