Skip to main content
GET
Bulk read of account state for a set of companies. Companies with no state yet are simply absent from the result. Every account is queryable, and “no state” is a normal answer. Tags are a separate read. Fetch them per record with Get An Account’s Tags, or read the vocabulary (the tag fields) with List Tag Groups.

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

company_id
string

The same as company_ids, repeated for each account. company_ids is the name to use.

company_ids
string
required

Comma-separated or repeated company uuids.

Response

The account states for the requested companies.

success
boolean
required
data
object
required