Skip to main content
GET
The customers of every competitor you track in one response: the rows List All Competitor Customers pages through, with the same competitor_id, label, include_possible, signal, include_rejected, order, owner and cs_owner, and no paging. There is one row per company and competitor, as in the Customers table.

​
JSON or CSV

By default the response is JSON, each customer under customers as the list returns it, plus three fields the Customers table shows:
  • people_you_can_reach: how many people at the company match your buyer titles and are reached by your network, at most 20. It is missing when Clustr could not read it.
  • sales_owner and cs_owner: the company’s Sales owner and CS owner as the table shows them, the owner set in Clustr or else the one in your CRM.
Add format=csv to get a CSV file instead, the one the app’s Export Customers menu item downloads:
  • UTF-8 with a byte order mark, so Excel reads accented names correctly.
  • Sent as an attachment named clustr-competitor-customers-<YYYY-MM-DD>.csv (the date in UTC).
  • A cell that starts with =, +, - or @ gets a leading apostrophe, so a spreadsheet never runs it as a formula.
  • A file with no customers is the header line alone, and X-Export-Rows is 0.
Any other format value is answered with a 400.

​
At most 50,000 rows

Every response, JSON or CSV, carries X-Export-Total (customers that matched), X-Export-Rows (customers in this response) and X-Export-Truncated (true when more matched than this response holds). In JSON, data.total and data.truncated say the same.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
company
string

Keeps the customers at this company, by its name. Repeat it for several companies (a name may hold a comma, so it is never split).

​
competitor_id
string

Only this competitor's customers, by its Clustr ID (cmp_…). The id from earlier responses also works.

​
label
string

Keeps the customers with these labels, as a comma-separated list of confirmed, likely and possible. Defaults to confirmed,likely. possible also needs include_possible.

​
include_possible
enum<string>

true also lists possible customers, the ones with only a weak signal.

Available options:
0,
1,
true,
false
​
signal
string

Keeps the customers with at least one of these signals, as a comma-separated list: case_study, testimonial, post_announcement, post_webinar, post_highlight, logo_wall, cs_interaction or product_user_comment.

​
include_rejected
enum<string>

Set to 1 to also list the customers you rejected.

Available options:
0,
1
​
order
enum<string>

standing lists your own customers first, then the companies in your CRM, then the rest in the default order.

Available options:
standing
​
owner
string

Keeps the customers whose CRM account owner or CS owner has this email address. Customers are matched to your CRM on their domain.

​
cs_owner
string

Keeps the customers whose CS owner has this email address: the CS owner set in Clustr, or else the one in your CRM.

​
format
enum<string>
default:json

json (the default) or csv. CSV is UTF-8 with a byte order mark, served as an attachment named clustr-competitor-customers-<YYYY-MM-DD>.csv; a cell that starts with = + - @ gets a leading apostrophe so a spreadsheet reads it as text. Any other value answers 400.

Available options:
json,
csv

Response

The customers

The CSV file, when format=csv.