Skip to main content
GET
The customers of every competitor you track, in one list. Each row is the same as in List Competitor Customers, plus a competitor object naming whose customer it is. Pass competitor_id to narrow the list to one competitor, owner to keep one CRM owner’s, and order=standing to list your own customers first. Confirmed and likely customers by default; see List Competitor Customers for the signals and labels.

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.

limit
integer
default:100

The number of customers per page, at most 500.

Required range: x <= 500
offset
integer
default:0

The number of customers to skip, for paging.

Response

One page of customers

success
boolean
required
Example:

true

data
object
required