Skip to main content
GET
List the connectors in your network : the same rows, filters and order as the Connectors list in the app. Each connector carries its clustr_person_id, how many people they may_know_count, their tags, their owner and whether a keep-fresh slot holds them (in_slot). Narrow the list with the app’s filters: search, owner (from List Owners), job_function, seniority_rank, tags on the connector (connector_tag_id), on their account (account_tag) or on their intros (intro_tag), and tag_group_empty for connectors with no tag in a field. Tag ids come from List Tags. Page with page and page_size. Use the clustr_person_ids it returns as connector_ids in Set Connectors Owner and Delete Connectors, or as the connector_id of Set Connector Slot. Leave include out and every row is whole. Send include=none for the base row alone (the connector, its ids, current role and company, counts, tags, owner and slot), or name the heavy parts you want back, comma-separated: crm (the connector’s own CRM contact, and the company’s CRM match inside connector_employment) and prospects (the people they may know). A part you leave out is absent from the row, not null. An unknown value is a 400 that lists the allowed ones. List Connectors is the lighter list: one row per connector with their intro count and owner email, filtered by tag name or owner email.

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

include
enum<string>[]

Optional. Leave it out for the full row, as before. Name the heavy parts you want back, comma-separated, or none for the base row alone.

  • prospects: the people the connector may know.
  • crm: the connector's own CRM contact, and the company's CRM match inside connector_employment.
Available options:
none,
prospects,
crm
job_function
string[]

Narrow to connectors whose current title resolves, through graph.title_roles, to one of these functions — the same value the contact's job_function carries. Repeatable, or one comma-separated value; OR-within. Case-insensitive. Same vocabulary as prospect_job_function on /v2/intros; unprefixed because a connector row describes one person. Anything else, or an empty value, is a 400.

seniority_rank
string[]

Narrow to connectors whose current title resolves to one of these seniority ranks (0 intern … 7 C-suite) — the same seniority_rank the contact carries. Repeatable, or one comma-separated value; OR-within. Distinct from seniority_level, which is the coarse high / mid / low score; both compose. A value outside 0-7, a non-integer, or an empty value is a 400.

tag_group_empty
string[]

Narrow to connectors carrying NO tag in these tag fields (uuid ids): a field column's "No ". OR'd with the tags of the same field selected in connector_tag_id, AND'd with every other filter. Repeatable, or one comma-separated value. Anything that is not a uuid is a 400.

account_tag
string[]

Tags on the connector's ACCOUNT (their current company), account tag ids (uuid). Several ids match a connector carrying ANY of them. Repeatable, or one comma-separated value. A non-uuid value narrows to nothing.

intro_tag
string[]

Tags on the connector's WARM INTROS, path tag ids (uuid): keeps connectors with at least one warm intro carrying them. Several ids match a connector with warm intros carrying ANY of them. Repeatable, or one comma-separated value. A non-uuid value narrows to nothing.

page
integer

1-based page number. Default 1.

Required range: x >= 1
page_size
integer

Rows per page. Default 25, capped at 50,000 (the CSV export asks for every row).

Required range: x >= 1

Free text over the connector's name, headline and current job title. Case and accent insensitive, contains-match.

connector
string[]

Connector linkedin_id. Repeatable; OR-within.

company_name
string[]

Exact current company name. Repeatable; OR-within.

seniority_level
enum<string>[]

Coarse seniority score band. Repeatable; OR-within.

Available options:
high,
mid,
low
country
string[]

Country name or ISO code, case insensitive; a name also matches its ISO code. Repeatable; OR-within.

job_title
string[]

Contains-match on the current job title, case and accent insensitive. Repeatable; OR-within.

connector_tag_id
string[]

Person tag id (uuid), or untagged for connectors with no tag. Several ids match a connector carrying ANY of them. Repeatable.

owner
string[]

Owner id (uuid) of the connector's owner rule, or unassigned. Repeatable; OR-within.

owner_id
string[]

Former name of owner, still accepted.

icp_fit
enum<string>[]

ICP fit of the connector's current company. Repeatable; OR-within.

Available options:
strong,
partial,
none
reach
string[]

Reach (may_know_count) in one of these ranges: N, N-M (inclusive) or N+. Repeatable, or one comma-separated value; OR-within.

reach_targets
string[]

Target reach (prospects at target accounts) in one of these ranges, as reach. A connector whose snapshot has not computed it matches none.

reach_icp
string[]

Reach at ideal customers (prospects at strong or partial ICP-fit companies) in one of these ranges, as reach.

kept_fresh
string[]

yes: the connector is in a keep-fresh slot; no: it is not. Both, or neither, is no filter. Repeatable, or one comma-separated value.

added
string[]

When this workspace first acquired the connector: 7d, 30d, 90d (within that many days), older (more than 90 days ago), never (no date). Repeatable, or one comma-separated value; OR-within.

exclude_customers
string

true: count reach without prospects at your customers. When Settings > companies; default: follow Settings > Matching. Anything else is false.

sort
string

See the operation description.

order
enum<string>
Available options:
asc,
desc
requesting_crm_provider
string

The CRM the in-CRM context is scoped to.

Response

Typed result envelope.

success
boolean
required
data
object
required