Skip to main content
GET
Returns your client companies, ordered by name. One item per company. A company can be on your list more than once: added manually, imported from a CSV and marked in your CRM. Those entries are grouped into one item, and each one appears in its sources. Entries are grouped by the Clustr company they matched, else by LinkedIn numeric id, else by LinkedIn slug. Companies marked “Not a client” are included, with excluded: true and the exclusion_id you need to undo it. They count toward total here, but not in the summary.

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

source
string

manual, csv or crm; empty is every source. Anything else is a 400.

q
string

Matches the name, LinkedIn page or domain.

cursor
string

The next_cursor of the previous page.

limit
string

The page size, a positive integer (default 50, at most 200).

domain
string

A domain or website URL, matched on its registrable domain, lowercased. A value with no domain is a 400.

linkedin_url
string

A LinkedIn company page URL (linkedin.com/company/...), matched on its numeric id or its vanity. Any other URL is a 400.

linkedin_numeric_id
string

A LinkedIn company numeric id, digits only; anything else is a 400. With several of domain, linkedin_url and linkedin_numeric_id, an item matches when it holds any of them. A linkedin_url whose numeric id differs from linkedin_numeric_id is a 400.

Response

Typed result envelope.

success
boolean
required
data
object
required