Skip to main content
GET
Returns a null account_state when the account has no state yet. Every account is queryable, and “no state” is a normal answer, not a 404. notes is the account’s note. notes_updated_at, notes_updated_by and notes_updated_by_name say when it last changed and which member changed it. They change only with the note, while updated_at also moves when the tier or owner does. dismiss_reason is why a dismissed account was dismissed, kept apart from the note. The account’s tags are a separate read: Get An Account’s Tags.

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

Path Parameters

account_id
string
required

The account: its acc_ Clustr id, or the company uuid.

Response

The account state, or null.

success
boolean
required
data
object
required