Skip to main content
GET
Returns the tiers your workspace sorts accounts into, ordered by rank. position 0 is the highest. Read this before writing a tier anywhere. Tier names are chosen per workspace: “A / B / C” for one customer, “Strategic / Growth / Watch” for the next. Create Target Account and Set Target Account Tier both take the name, and both reject one your workspace does not have rather than creating it.
Tiers are managed in the app, under Targeting → Tiering, where they are named, reordered and deleted. This endpoint is read-only: vocabulary is a deliberate decision, and a typo arriving over the API should not become a permanent tier.
Rank carries meaning. The app colours a tier by its position rather than by a stored colour, which is why there is no colour field here and why reordering tiers repaints the tables. Position 0 is the top tier.

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

with_counts
enum<string>

Set true to add account_count to each tier: how many of your accounts carry it.

Available options:
true

Response

The tenant's tiers, by position.

success
boolean
required
data
object
required