Skip to main content
GET
Get company counts per region for the public map

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

tenantSlug
string
required

The organisation, by its slug

level
enum<string>

country, county or state. Derived from the filters when absent: no country means country, a country means its counties.

Available options:
country,
county,
state
country
integer

Country id, once the visitor drilled into one

state
string

Full US state name, matching county.state

Response

Counts per region for the level

level
string
regions
object[]
unassignedCount
integer
totalCount
integer