Sign in
Maps

Get Shared Map Endpoint

Get a shared map by token. Optionally authenticated for non-public layers.

Emits Content-Security-Policy: frame-ancestors 'self' [<allowed_origins>...] on the response, derived from the active EmbedToken for this map. When no EmbedToken exists or allowed_origins is empty, defaults to frame-ancestors 'self'. The SecurityHeadersMiddleware respects this route-level CSP and skips emitting X-Frame-Options: DENY.

X-Embed-Token grants access to layers in the token's scope.

get/maps/shared/{token}

Request

  • The document declares no server URL.
  • Auth: one of:
    • none
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

tokenstring required

Headers

X-Embed-Tokenstring nullable

Optional embed token — includes its scoped dataset layers when valid for this map.

Response

Successful Response

namestring required
descriptionstring nullable required
center_lngnumber required
center_latnumber required
zoomnumber required
bearingnumber required
pitchnumber required
basemap_stylestring required
show_basemap_labelsboolean
has_non_public_layersboolean
legend_titlestring nullable

Changes

No recorded changes to this operation across all 50 revisions of this API.