Skip to main content
GET
Get company map clusters 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

zoom
integer

Leaflet zoom level; decides how coarse the grouping grid is. Default 6.

north
number

Viewport edge in degrees. Send all four or none; none means worldwide, which is what the first load should ask for.

south
number

Viewport edge in degrees. Send all four or none; none means worldwide, which is what the first load should ask for.

east
number

Viewport edge in degrees. Send all four or none; none means worldwide, which is what the first load should ask for.

west
number

Viewport edge in degrees. Send all four or none; none means worldwide, which is what the first load should ask for.

Response

Pins in the viewport

clusters
object[]
actualBounds
object | null

Where to point the map: the extent of the returned pins

zoom
integer