Skip to main content
GET
List Intros by Connector
One connector with their warm intros, paged. Here relationship.confidence_score is a percentage, 0 to 100.

Authorizations

Authorization
string
header
required

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

Headers

X-Clustr-Fresh
enum<string>

Send 1 for about 10 seconds after a write of your own: the read waits up to queries.clickhouse.write_wait_ms (default 6 s) for that write and is never answered from a last-good copy. Do not send it on every request.

Available options:
1

Query Parameters

q
string

Only the intros whose prospect's name, title or company, connector's name or industry holds this text, in any case.

exclude_customers
string[]

Absent follows the workspace's setting.

full_history
string[]

true adds every engagement.

include_all_positions
string[]

true adds each person's positions; needs a bounded page_size.

include
string[]

Optional. Leave it out for the full answer, as before. Name the heavy parts you want back, comma-separated, or none for the base intro alone (the primary shared experiences, the experience counts and the engagement totals stay).

  • engagements: relationship.engagement.history (with full_history=true).
  • shared_experiences: relationship.shared_experience_history and shared_education_experience_history.
linkedin_public_id
string[]

The connector's public identifier; this or linkedin_url: a public slug, a member id (ACoAA...) or a Sales Navigator id (ACwAA...), as LinkedIn shows it (a member id is case-sensitive).

linkedin_url
string[]

The connector's profile URL; this or linkedin_public_id. https://www.linkedin.com/in/ works too. A Sales Navigator URL (/sales/lead/...) is not read; send its id as linkedin_public_id.

account_tag
string[]

A People list filter (see GET /v1/internal/referral).

added
string[]

A People list filter (see GET /v1/internal/referral).

big_company_max_employees
string[]

Ignored. The "Hide big companies" filter was removed.

cities
string[]

A People list filter (see GET /v1/internal/referral).

customers
string[]

Keep intros whose connector currently works at the company with this name, matched case-insensitively; the same filter as client_companies. Repeat the parameter for several companies.

connector_crm_statuses
string[]

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

connector_linkedin_urls
string[]

Keep intros whose connector has this LinkedIn profile URL; the same filter as client_linkedin_urls. Repeat the parameter for several connectors.

client_names
string[]

A People list filter (see GET /v1/internal/referral).

client_public_identifiers
string[]

A People list filter (see GET /v1/internal/referral).

connector_role
string[]

Keep only the intros whose connector is part of your network; the same filter as client_role, and it wins when both are sent. network is the only value; any other value returns 400.

competitor
string[]

A People list filter (see GET /v1/internal/referral).

confidence_ranges
string[]

A People list filter (see GET /v1/internal/referral).

countries
string[]

A People list filter (see GET /v1/internal/referral).

created_after
string[]

A People list filter (see GET /v1/internal/referral).

created_before
string[]

A People list filter (see GET /v1/internal/referral).

crm_statuses
string[]

A People list filter (see GET /v1/internal/referral).

cursor.direction
string[]

A People list filter (see GET /v1/internal/referral).

cursor.last_id
string[]

The last intro id of the previous page, for cursor paging; the same as cursor.lastId.

cursor.last_score
string[]

The last score of the previous page, for cursor paging; the same as cursor.lastScore.

dismiss_reason
string[]

A People list filter (see GET /v1/internal/referral).

company_owner
string[]

A People list filter (see GET /v1/internal/referral).

assigned_owner
string[]

A People list filter (see GET /v1/internal/referral).

company_deal_stage
string[]

A People list filter (see GET /v1/internal/referral).

customer_of
string[]

A People list filter (see GET /v1/internal/referral).

domains
string[]

A People list filter (see GET /v1/internal/referral).

employee_ranges
string[]

A People list filter (see GET /v1/internal/referral).

engagement_types
string[]

A People list filter (see GET /v1/internal/referral).

evidence
string[]

A People list filter (see GET /v1/internal/referral).

fit
string[]

A People list filter (see GET /v1/internal/referral).

has_interaction
string[]

A People list filter (see GET /v1/internal/referral).

has_notes
string[]

A People list filter (see GET /v1/internal/referral).

hide_big_company_overlaps
string[]

Ignored. The "Hide big companies" filter was removed.

icp_fit
string[]

A People list filter (see GET /v1/internal/referral).

include_unengaged
string[]

A People list filter (see GET /v1/internal/referral).

industries
string[]

A People list filter (see GET /v1/internal/referral).

job_id
string[]

A People list filter (see GET /v1/internal/referral).

buyer_title_id
string[]

A People list filter (see GET /v1/internal/referral).

linkedin_urls
string[]

A People list filter (see GET /v1/internal/referral).

numeric_ids
string[]

A People list filter (see GET /v1/internal/referral).

owner
string[]

A People list filter (see GET /v1/internal/referral).

owners
string[]

A People list filter (see GET /v1/internal/referral).

page
string[]

A People list filter (see GET /v1/internal/referral).

page_size
string[]

A People list filter (see GET /v1/internal/referral).

prospect_companies
string[]

A People list filter (see GET /v1/internal/referral).

prospect_crm_statuses
string[]

A People list filter (see GET /v1/internal/referral).

prospect_job_function
string[]

A People list filter (see GET /v1/internal/referral).

prospect_linkedin_urls
string[]

A People list filter (see GET /v1/internal/referral).

prospect_names
string[]

A People list filter (see GET /v1/internal/referral).

prospect_positions
string[]

A People list filter (see GET /v1/internal/referral).

prospect_seniority_rank
string[]

A People list filter (see GET /v1/internal/referral).

revenue_ranges
string[]

A People list filter (see GET /v1/internal/referral).

seniority_levels
string[]

A People list filter (see GET /v1/internal/referral).

sort_direction
string[]

A People list filter (see GET /v1/internal/referral).

sort_field
string[]

A People list filter (see GET /v1/internal/referral).

statuses
string[]

A People list filter (see GET /v1/internal/referral).

tag
string[]

A People list filter (see GET /v1/internal/referral).

target_account
string[]

A People list filter (see GET /v1/internal/referral).

temperature
string[]

A People list filter (see GET /v1/internal/referral).

tier
string[]

A People list filter (see GET /v1/internal/referral).

vanity_names
string[]

A People list filter (see GET /v1/internal/referral).

Response

Typed result envelope.

success
boolean
required
data
object | null
required