Skip to main content
GET
Every person tracked at any of your competitors, in one list, with the same columns as List Competitor Team plus competitor_name, and the slot counter. People you removed are left out unless status asks for them. The name search ignores case and accents: helene finds “Hélène”. The list comes ordered pending first (normally nobody), then Monitored, Paused and Left, then by rank and name.

Authorizations

Authorization
string
header
required

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

Query Parameters

competitor_id
string

Keeps the people at these competitors, by their Clustr IDs (cmp_…). Repeat the parameter or send a comma-separated list. The ids from earlier responses also work.

function
string

Keeps the people in these functions, as a comma-separated list of sales, cs and other.

status
string

Keeps the people with these statuses, as a comma-separated list of monitored, paused, pending (shown as To validate in the app), left and removed. Defaults to every status except removed.

q
string

Searches people by name, ignoring case and accents.

limit
integer
default:50

The number of people per page, at most 200.

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

The number of people to skip, for paging.

Response

The people

success
boolean
required
Example:

true

data
object
required