Search Opportunities

GET

network

opportunities

curl "https://api.clustr-ai.com/api/public/network/search/opportunities?domains=acme.com&confidence_ranges=75-100&page_size=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "data": {
    "results": [
      {
        "client": {
          "name": "John Doe",
          "job_title": "Sales Director",
          "owner_email": "alice@company.com",
          "owner_name": "Alice Martin"
        },
        "opportunities": [
          {
            "clustr_opportunity_id": "opp_3nc3njb95c66d41k8qf4ch6cd1",
            "opportunity_id": "opp_abc123",
            "prospect": {
              "name": "Jane Smith",
              "job_title": "CTO",
              "company_name": "Acme Corp",
              "positions": [
                {
                  "clustr_account_id": "acc_p5ym7hqze4s1kg0mgq2jc3ta29",
                  "company_name": "Acme Corp",
                  "linkedin_numeric_id": "12345678",
                  "linkedin_vanity_name": "acme-corp",
                  "domain": "acme.com",
                  "job_title": "CTO",
                  "is_current": true,
                  "is_primary": true
                },
                {
                  "clustr_account_id": "acc_qm2efgnsnna4m1tmasg9cqwpmd",
                  "company_name": "Northwind Ventures",
                  "linkedin_numeric_id": "74364633",
                  "linkedin_vanity_name": "northwind-ventures",
                  "job_title": "Board member",
                  "is_current": true,
                  "is_primary": false
                }
              ]
            },
            "relationship": { "confidence_score": 92, "total_overlap_months": 36 },
            "is_target_company": true
          }
        ]
      }
    ],
    "total": 42,
    "page": 1,
    "page_size": 25,
    "has_more": true
  }
}

Search opportunities with optional filters. All parameters are optional. Call with no filters to list all opportunities, or combine filters to narrow results. To see one connector’s opportunities, filter by client_public_identifiers or client_linkedin_urls: GET /network/search/opportunities?client_public_identifiers=john-doe. To find who can introduce you to a specific prospect, filter this endpoint by prospect_linkedin_urls instead: GET /network/search/opportunities?prospect_linkedin_urls=https://www.linkedin.com/in/jane-smith.

People with several current roles

Plenty of people hold more than one job at a time. A partner at a venture fund may also sit on the boards of three companies the fund backs, and each opportunity is filed under a single one of those companies. Company filters match every role a person currently holds, not just the one their opportunity is filed under, so a search for the fund finds that partner. This needs no parameter and is always on. A company filter matches the people who work there today. Add include_all_positions=true to see the full picture in the response: every job each person holds or held, with is_current separating the two and is_primary marking the role the opportunity is filed under.

Who to ask for the introduction

Each client (the connector) carries owner_email and owner_name: the team member who owns that connector, and therefore the person to ask. Both are omitted when the connector has no owner, so absence means unowned rather than unknown.

Notes on a result

Every opportunity carries a tracking object holding whatever Update Opportunity has set on it: notes and assigned_at. The object is present once something has been set. To read one opportunity’s notes without running a search, use Get Opportunity.

Which paths count

Paths whose prospect is also one of your connectors are included.

curl "https://api.clustr-ai.com/api/public/network/search/opportunities?domains=acme.com&confidence_ranges=75-100&page_size=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "data": {
    "results": [
      {
        "client": {
          "name": "John Doe",
          "job_title": "Sales Director",
          "owner_email": "alice@company.com",
          "owner_name": "Alice Martin"
        },
        "opportunities": [
          {
            "clustr_opportunity_id": "opp_3nc3njb95c66d41k8qf4ch6cd1",
            "opportunity_id": "opp_abc123",
            "prospect": {
              "name": "Jane Smith",
              "job_title": "CTO",
              "company_name": "Acme Corp",
              "positions": [
                {
                  "clustr_account_id": "acc_p5ym7hqze4s1kg0mgq2jc3ta29",
                  "company_name": "Acme Corp",
                  "linkedin_numeric_id": "12345678",
                  "linkedin_vanity_name": "acme-corp",
                  "domain": "acme.com",
                  "job_title": "CTO",
                  "is_current": true,
                  "is_primary": true
                },
                {
                  "clustr_account_id": "acc_qm2efgnsnna4m1tmasg9cqwpmd",
                  "company_name": "Northwind Ventures",
                  "linkedin_numeric_id": "74364633",
                  "linkedin_vanity_name": "northwind-ventures",
                  "job_title": "Board member",
                  "is_current": true,
                  "is_primary": false
                }
              ]
            },
            "relationship": { "confidence_score": 92, "total_overlap_months": 36 },
            "is_target_company": true
          }
        ]
      }
    ],
    "total": 42,
    "page": 1,
    "page_size": 25,
    "has_more": true
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

domains

string[]

Keep prospects who currently work at the company with this domain. Repeat the parameter for several domains; a prospect at any of them is kept.

linkedin_urls

string[]

Keep prospects who currently work at the company with this LinkedIn company URL. Repeat the parameter for several companies.

numeric_ids

string[]

Keep prospects who currently work at the company with this LinkedIn numeric id. Repeat the parameter for several companies.

vanity_names

string[]

Keep prospects who currently work at the company with this LinkedIn vanity name, the slug in its company page URL. Repeat the parameter for several companies.

client_names

string[]

Keep opportunities whose connector has this full name. Repeat the parameter for several connectors.

client_linkedin_urls

string[]

Keep opportunities whose connector has this LinkedIn profile URL. Repeat the parameter for several connectors. Use it to list one connector's opportunities.

client_public_identifiers

string[]

Keep opportunities whose connector has this LinkedIn public identifier, the slug at the end of their profile URL. Repeat the parameter for several connectors.

client_companies

string[]

Keep opportunities whose connector currently works at the company with this name, matched case-insensitively. Repeat the parameter for several companies.

prospect_names

string[]

Keep opportunities whose prospect has this full name. Repeat the parameter for several prospects.

prospect_linkedin_urls

string[]

Keep opportunities whose prospect has this LinkedIn profile URL. Repeat the parameter for several prospects. Use it to find who can introduce you to a specific person.

prospect_positions

string[]

Keep prospects whose job title is exactly this title, matched case-insensitively. Repeat the parameter for several titles.

prospect_companies

string[]

Keep prospects whose company has this name, matched case-insensitively. Repeat the parameter for several companies.

owner

string[]

Keep opportunities owned by this teammate, the person working the intro. Pass an owner id from List Owners or the owner's email address, matched case-insensitively. Pass unassigned for opportunities with no owner. Repeat the parameter or send a comma-separated list.

owners

string[]

Another way to pass owner, with the same values. Owners from both parameters are combined.

seniority_levels

enum<string>[]

Keep prospects at these seniority levels. Repeat the parameter or send a comma-separated list.

Available options:

high,

mid,

low

industries

string[]

Keep prospects whose company is in this industry, matched case-insensitively against the industry name the company carries. Repeat the parameter for several industries.

employee_ranges

string[]

Keep prospects whose company is in one of these LinkedIn headcount bands, written as LinkedIn writes them, for example 51-200. Pass na to also keep companies with no known headcount. Repeat the parameter or send a comma-separated list.

revenue_ranges

string[]

Keep prospects whose company is in this revenue band, written exactly as the band appears on the company. Revenue bands contain commas, so repeat the parameter for several bands. Pass na to also keep companies with no known revenue.

countries

string[]

Keep prospects located in this country, given as a country name or an ISO code. Repeat the parameter for several countries.

cities

string[]

Keep prospects located in one of these cities, given by their full name. A city matches the prospect's metro area, so Paris also keeps prospects in its suburbs. Repeat the parameter or send a comma-separated list.

fit

enum<string>[]

Keep prospects whose company carries one of these account grades, the same grade the Fit column shows on the People and Accounts tables. Repeat the parameter or send a comma-separated list.

Available options:

A+,

A,

B,

C,

D

icp_fit

enum<string>[]

Keep prospects whose company has this match against your ideal customer profiles: strong, partial or none. Repeat the parameter or send a comma-separated list.

Available options:

strong,

partial,

none

tier

string[]

Keep prospects whose company is filed under one of these tiers, by tier id from List Tiers. Pass none for companies with no tier. Repeat the parameter or send a comma-separated list.

target_account

enum<string>[]

yes keeps paths into a company on your target account list; no keeps paths into companies outside it.

Available options:

yes,

no

competitor

string[]

With the Competitor Monitoring add-on, keep paths into companies where a competitor you watch has engaged someone. Pass any for every watched competitor, or competitor ids from List Competitors. Repeat the parameter or send a comma-separated list.

tag

string<uuid>[]

Keep warm intros carrying these tags, by tag id from List Tag Groups or List Tags. Several ids match a warm intro carrying any of them. Repeat the parameter or send a comma-separated list. A value that is not a tag id returns 400.

account_tag

string<uuid>[]

Keep warm intros whose prospect's account carries these tags, by tag id from List Tags with subject_type=account. Several ids match a warm intro whose account carries any of them. Repeat the parameter or send a comma-separated list. A value that is not a tag id returns 400.

confidence_ranges

string[]

Keep paths whose strength falls in one of these ranges, as percentages written min-max. Each range includes its lower bound and stops just below its upper bound, and a range ending at 100 includes 100. Repeat the parameter or send a comma-separated list.

engagement_types

enum<string>[]

Keep paths that carry every one of these kinds of evidence: CONNECTED (the two are connected on LinkedIn), LIKE, COMMENT, RECOMMEND (a LinkedIn recommendation) and SHARE (the two worked at the same company). Case-insensitive. Repeat the parameter or send a comma-separated list.

Available options:

CONNECTED,

LIKE,

COMMENT,

RECOMMEND,

SHARE

crm_statuses

enum<string>[]

Keep paths where the connector or the prospect has this status in your CRM. Values in the same family match any of them: presence and recency (IN_CRM, NOT_IN_CRM, ACTIVE_7D, ACTIVE_30D, ACTIVE_90D, NO_RECENT_ACTIVITY), activity kind (HAS_*), activity direction (OUTBOUND_ACTIVITY, INBOUND_ACTIVITY) and activity status (STATUS_*). Values from different families must all match. Repeat the parameter for several values.

Available options:

IN_CRM,

NOT_IN_CRM,

ACTIVE_7D,

ACTIVE_30D,

ACTIVE_90D,

NO_RECENT_ACTIVITY,

HAS_EMAIL,

HAS_CALL,

HAS_MEETING,

HAS_NOTE,

HAS_TASK,

OUTBOUND_ACTIVITY,

INBOUND_ACTIVITY,

STATUS_COMPLETED,

STATUS_SCHEDULED,

STATUS_CANCELLED,

STATUS_NO_SHOW,

STATUS_SENT,

STATUS_BOUNCED

client_crm_statuses

enum<string>[]

The same statuses as crm_statuses, matched on the connector only. Repeat the parameter for several values.

Available options:

IN_CRM,

NOT_IN_CRM,

ACTIVE_7D,

ACTIVE_30D,

ACTIVE_90D,

NO_RECENT_ACTIVITY,

HAS_EMAIL,

HAS_CALL,

HAS_MEETING,

HAS_NOTE,

HAS_TASK,

OUTBOUND_ACTIVITY,

INBOUND_ACTIVITY,

STATUS_COMPLETED,

STATUS_SCHEDULED,

STATUS_CANCELLED,

STATUS_NO_SHOW,

STATUS_SENT,

STATUS_BOUNCED

prospect_crm_statuses

enum<string>[]

The same statuses as crm_statuses, matched on the prospect only. Repeat the parameter for several values.

Available options:

IN_CRM,

NOT_IN_CRM,

ACTIVE_7D,

ACTIVE_30D,

ACTIVE_90D,

NO_RECENT_ACTIVITY,

HAS_EMAIL,

HAS_CALL,

HAS_MEETING,

HAS_NOTE,

HAS_TASK,

OUTBOUND_ACTIVITY,

INBOUND_ACTIVITY,

STATUS_COMPLETED,

STATUS_SCHEDULED,

STATUS_CANCELLED,

STATUS_NO_SHOW,

STATUS_SENT,

STATUS_BOUNCED

temperature

enum<string>[]

Keep paths at this heat, as the Heat column shows it: warm (an interaction or recommendation in the last 30 days), cool (in the last 90 days) or cold (none in the last 90 days). Repeat the parameter or send a comma-separated list.

Available options:

warm,

cool,

cold

has_interaction

boolean

default:false

Keep only paths with at least one recorded interaction between the two people, such as a like or a comment.

has_notes

enum<string>[]

with_notes keeps paths that carry a note; without_notes keeps paths that have none.

Available options:

with_notes,

without_notes

company_owner

string

The sales owner of the prospect's company, as on the Accounts list: owner ids, or unassigned for companies with no owner. Repeat the parameter or send a comma-separated list.

company_deal_stage

string

The stage of an open CRM deal on the prospect's company, as your CRM names it. Repeat the parameter for several stages; commas stay part of the stage name.

customer_of

string

Requires the Competitor Monitoring add-on. Keeps the paths into companies that are a customer of a watched competitor (Confirmed or Likely): competitor ids, or any. Repeat the parameter or send a comma-separated list.

evidence

enum<string>

When your workspace includes relationships built on shared work history, pick which paths to return, as the Warm intros views do. recommended returns paths with an interaction or a recommendation between the two people. all also returns paths where the two worked together at a small company in the same place, as your matching settings define it. Any other value returns 400.

Available options:

recommended,

all

hide_big_company_overlaps

boolean

default:false

Ignored. Paths whose only evidence is having worked together at a company above your workspace's size limit are never returned.

big_company_max_employees

integer

Ignored.

include_unengaged

boolean

default:false

Your workspace's matching settings decide whether paths with no recorded engagement appear, whatever value you send.

exclude_client_companies

boolean

true hides prospects whose current company is on your client companies list, unless that company is marked not a client; false shows them. Leave it out to follow your workspace's hideClientCompanies matching setting, which is on by default.

created_after

string<date-time>

Keep paths that first appeared for your workspace at or after this time, as an RFC 3339 timestamp.

created_before

string<date-time>

Keep paths that first appeared for your workspace at or before this time, as an RFC 3339 timestamp.

added

enum<string>[]

Keep paths that first appeared for your workspace within these windows: 7d, 30d or 90d (the last 7, 30 or 90 days) or older (more than 90 days ago). Repeat the parameter or send a comma-separated list.

Available options:

7d,

30d,

90d,

older

job_id

string

Keep the opportunities an import produced, by the Clustr ID (job_…) of the job that import returned, for connectors imported in that job. The job id from earlier responses also works.

full_history

boolean

default:false

Return each path's full engagement history alongside its totals.

include_all_positions

boolean

default:false

Return every job each person holds or held, as a positions array on the person, with is_current separating current from past roles and is_primary marking the role the opportunity is filed under.

sort_field

string

default:confidenceScore

The key to sort by: confidenceScore, clientName, prospectName, seniorityLevel, prospectCompany, companyPaths (companies with the most paths first, each company's paths together), industry, employees, revenue, country, createdAt, added or updatedAt. To sort by Intro tags, pass introTags: it orders by the record's first tag in the field's order, records with none last. Ties are broken by opportunity id.

sort_direction

enum<string>

default:desc

Sort ascending or descending.

Available options:

asc,

desc

page

integer

default:1

The page to return, starting at 1.

Required range: x >= 1

page_size

integer

default:100

Opportunities per page. A value above 1000 returns 1000; leaving it out or passing 0 returns 100.

Required range: x <= 1000

Response

Matching opportunities, grouped by connector.

success

boolean

required

Example:

true

data

object

required

The warm intros GET /network/search/opportunities returns: one entry per connector with that connector's opportunities, and the paging totals.

Show child attributes

curl "https://api.clustr-ai.com/api/public/network/search/opportunities?domains=acme.com&confidence_ranges=75-100&page_size=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "data": {
    "results": [
      {
        "client": {
          "name": "John Doe",
          "job_title": "Sales Director",
          "owner_email": "alice@company.com",
          "owner_name": "Alice Martin"
        },
        "opportunities": [
          {
            "clustr_opportunity_id": "opp_3nc3njb95c66d41k8qf4ch6cd1",
            "opportunity_id": "opp_abc123",
            "prospect": {
              "name": "Jane Smith",
              "job_title": "CTO",
              "company_name": "Acme Corp",
              "positions": [
                {
                  "clustr_account_id": "acc_p5ym7hqze4s1kg0mgq2jc3ta29",
                  "company_name": "Acme Corp",
                  "linkedin_numeric_id": "12345678",
                  "linkedin_vanity_name": "acme-corp",
                  "domain": "acme.com",
                  "job_title": "CTO",
                  "is_current": true,
                  "is_primary": true
                },
                {
                  "clustr_account_id": "acc_qm2efgnsnna4m1tmasg9cqwpmd",
                  "company_name": "Northwind Ventures",
                  "linkedin_numeric_id": "74364633",
                  "linkedin_vanity_name": "northwind-ventures",
                  "job_title": "Board member",
                  "is_current": true,
                  "is_primary": false
                }
              ]
            },
            "relationship": { "confidence_score": 92, "total_overlap_months": 36 },
            "is_target_company": true
          }
        ]
      }
    ],
    "total": 42,
    "page": 1,
    "page_size": 25,
    "has_more": true
  }
}

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

Search Opportunities

People with several current roles

Who to ask for the introduction

Notes on a result

Which paths count

Authorizations

Query Parameters

Response

​People with several current roles

​Who to ask for the introduction

​Notes on a result

​Which paths count

Authorizations

Query Parameters

Response

People with several current roles

Who to ask for the introduction

Notes on a result

Which paths count