Import Connectors

POST

network

import

connectors

curl -X POST https://api.clustr-ai.com/api/public/network/import/connectors \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "connectors": [
      {
        "linkedin_url": "https://www.linkedin.com/in/john-doe",
        "record_id": "CRM_12345",
        "owner_email": "alice@company.com"
      }
    ],
    "webhook_url": "https://your-webhook.com/endpoint"
  }'

curl -X POST https://api.clustr-ai.com/api/public/network/import/connectors \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "linkedin_urls": ["https://www.linkedin.com/in/john-doe"],
    "mark_companies_as_clients": true
  }'

import requests

requests.post(
    "https://api.clustr-ai.com/api/public/network/import/connectors",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "connectors": [{"linkedin_url": "https://www.linkedin.com/in/john-doe"}],
        "webhook_url": "https://your-webhook.com/endpoint",
    },
)

await fetch("https://api.clustr-ai.com/api/public/network/import/connectors", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    connectors: [{ linkedin_url: "https://www.linkedin.com/in/john-doe" }],
    webhook_url: "https://your-webhook.com/endpoint",
  }),
});

{
  "connectors": [
    {
      "linkedin_url": "https://www.linkedin.com/in/john-doe",
      "record_id": "CRM_12345",
      "owner_email": "alice@company.com",
      "connector_tag": "Friend"
    }
  ],
  "webhook_url": "https://your-webhook.com/endpoint",
  "max_opportunities": 50,
  "full_history": true,
  "custom": {
    "your_field": "value"
  },
  "filters": {
    "confidence_score_ranges": ["75-100", "50-75"],
    "seniority_levels": ["high", "mid"]
  }
}

{
  "success": true,
  "data": {
    "clustr_job_id": "job_f2ex7r7fdbt7r11e7pyba58qse",
    "message": "Successfully queued prospects for processing (webhook registered)",
    "job_id": "988f0602-1ddd-49ec-aef6-e0a6d680b5a5",
    "stats": {
      "total_submitted": 1,
      "valid_processed": 1,
      "invalid_urls": 0
    }
  }
}

{
  "success": false,
  "error": {
    "message": "Invalid request body",
    "code": "BAD_REQUEST"
  }
}

{
  "success": false,
  "error": {
    "message": "Invalid or missing API key",
    "code": "UNAUTHORIZED"
  }
}

Import connectors by LinkedIn URL. Connectors are the people whose connections Clustr analyzes to find referral opportunities. Processing is asynchronous. Results come via webhook or email.

If your workspace already has imports in progress, a new job may be queued and will start automatically once capacity frees up. Poll Get Job Status or List Jobs and look for QUEUED.

A person listed twice in one request is processed and charged once. The extra copies are counted in stats.duplicates, listed in discarded_urls with reason duplicate, and left out of stats.valid_processed.

The companies are added once the import finishes, typically 10 to 15 minutes after the call. A company already on your client list is not added twice, and one you marked Not a client stays that way. The companies show on the list with the CSV source, like any other bulk import.

curl -X POST https://api.clustr-ai.com/api/public/network/import/connectors \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "connectors": [
      {
        "linkedin_url": "https://www.linkedin.com/in/john-doe",
        "record_id": "CRM_12345",
        "owner_email": "alice@company.com"
      }
    ],
    "webhook_url": "https://your-webhook.com/endpoint"
  }'

curl -X POST https://api.clustr-ai.com/api/public/network/import/connectors \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "linkedin_urls": ["https://www.linkedin.com/in/john-doe"],
    "mark_companies_as_clients": true
  }'

import requests

requests.post(
    "https://api.clustr-ai.com/api/public/network/import/connectors",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "connectors": [{"linkedin_url": "https://www.linkedin.com/in/john-doe"}],
        "webhook_url": "https://your-webhook.com/endpoint",
    },
)

await fetch("https://api.clustr-ai.com/api/public/network/import/connectors", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    connectors: [{ linkedin_url: "https://www.linkedin.com/in/john-doe" }],
    webhook_url: "https://your-webhook.com/endpoint",
  }),
});

{
  "connectors": [
    {
      "linkedin_url": "https://www.linkedin.com/in/john-doe",
      "record_id": "CRM_12345",
      "owner_email": "alice@company.com",
      "connector_tag": "Friend"
    }
  ],
  "webhook_url": "https://your-webhook.com/endpoint",
  "max_opportunities": 50,
  "full_history": true,
  "custom": {
    "your_field": "value"
  },
  "filters": {
    "confidence_score_ranges": ["75-100", "50-75"],
    "seniority_levels": ["high", "mid"]
  }
}

{
  "success": true,
  "data": {
    "clustr_job_id": "job_f2ex7r7fdbt7r11e7pyba58qse",
    "message": "Successfully queued prospects for processing (webhook registered)",
    "job_id": "988f0602-1ddd-49ec-aef6-e0a6d680b5a5",
    "stats": {
      "total_submitted": 1,
      "valid_processed": 1,
      "invalid_urls": 0
    }
  }
}

{
  "success": false,
  "error": {
    "message": "Invalid request body",
    "code": "BAD_REQUEST"
  }
}

{
  "success": false,
  "error": {
    "message": "Invalid or missing API key",
    "code": "UNAUTHORIZED"
  }
}

Authorizations

Authorization

string

header

required

The API key you created on the API settings page of the Clustr app.

Body

application/json

Request body for importing connectors

webhook_url

string<uri>

required

URL to receive results when processing completes

Example:

"https://your-webhook.com/endpoint"

connectors

object[]

The connectors to import, 1 to 50 per request. Send either this or linkedin_urls.

Required array length: 1 - 50 elements

Show child attributes

linkedin_urls

string<uri>[]

The shorter way to import: 1 to 50 LinkedIn profile URLs with no CRM metadata. Send this or connectors, one of the two.

Required array length: 1 - 50 elements

Example:

[
  "https://www.linkedin.com/in/john-doe",
  "https://www.linkedin.com/in/jane-smith"
]

contacts

object[]

The same list as connectors, under another name. Send only one of the two.

Required array length: 1 - 50 elements

Show child attributes

completion_email

string<email>

An email address to notify when the job completes. Clustr sends a notification email to this address. Use your own address here, rather than the connector's.

Example:

"notify@example.com"

max_opportunities

integer

Maximum number of opportunities to return per connector

Required range: x >= 0

Example:

50

full_history

boolean

default:false

Include each path's full engagement history in the webhook payload.

mark_companies_as_clients

boolean

default:false

Set true when the people you import are clients. Once the import finishes, each connector's current company is added to your client list, so warm intros into those companies are hidden wherever client companies are excluded. It applies to every connector in the request.

Leave it off when you import people to reach their own company (account expansion): their employer then stays a target.

custom

object

Any JSON object of your own. It is returned unchanged in the webhook payload.

Example:

{ "your_field": "value" }

filters

object

Filters applied to the opportunities this import finds.

Show child attributes

Response

Connectors queued for processing

success

boolean

required

Example:

true

data

object

required

Show child attributes

curl -X POST https://api.clustr-ai.com/api/public/network/import/connectors \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "connectors": [
      {
        "linkedin_url": "https://www.linkedin.com/in/john-doe",
        "record_id": "CRM_12345",
        "owner_email": "alice@company.com"
      }
    ],
    "webhook_url": "https://your-webhook.com/endpoint"
  }'

curl -X POST https://api.clustr-ai.com/api/public/network/import/connectors \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "linkedin_urls": ["https://www.linkedin.com/in/john-doe"],
    "mark_companies_as_clients": true
  }'

import requests

requests.post(
    "https://api.clustr-ai.com/api/public/network/import/connectors",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "connectors": [{"linkedin_url": "https://www.linkedin.com/in/john-doe"}],
        "webhook_url": "https://your-webhook.com/endpoint",
    },
)

await fetch("https://api.clustr-ai.com/api/public/network/import/connectors", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    connectors: [{ linkedin_url: "https://www.linkedin.com/in/john-doe" }],
    webhook_url: "https://your-webhook.com/endpoint",
  }),
});

{
  "connectors": [
    {
      "linkedin_url": "https://www.linkedin.com/in/john-doe",
      "record_id": "CRM_12345",
      "owner_email": "alice@company.com",
      "connector_tag": "Friend"
    }
  ],
  "webhook_url": "https://your-webhook.com/endpoint",
  "max_opportunities": 50,
  "full_history": true,
  "custom": {
    "your_field": "value"
  },
  "filters": {
    "confidence_score_ranges": ["75-100", "50-75"],
    "seniority_levels": ["high", "mid"]
  }
}

{
  "success": true,
  "data": {
    "clustr_job_id": "job_f2ex7r7fdbt7r11e7pyba58qse",
    "message": "Successfully queued prospects for processing (webhook registered)",
    "job_id": "988f0602-1ddd-49ec-aef6-e0a6d680b5a5",
    "stats": {
      "total_submitted": 1,
      "valid_processed": 1,
      "invalid_urls": 0
    }
  }
}

{
  "success": false,
  "error": {
    "message": "Invalid request body",
    "code": "BAD_REQUEST"
  }
}

{
  "success": false,
  "error": {
    "message": "Invalid or missing API key",
    "code": "UNAUTHORIZED"
  }
}

API Reference

Import

Search

Jobs

Network

Opportunities

Owners

Accounts

Account States

Saved Views

Workflows

Intro Requests

Notes

Record Activity

Tags

Target Accounts

Client Companies

Excluded Companies

Buyer Titles

ICP

Competitor Monitoring

Connector Refresh

Notifications

Import Connectors

Authorizations

Body

Response