Skip to content
getgeolens.com
GeoLens Docs

Get Shared Map Endpoint

GET
/maps/shared/{token}
 
curl --request GET \
  --url https://example.com/api/maps/shared/example \
  --header 'Authorization: Bearer <token>'

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
token
required
Token
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
SharedMapResponse
object
name
required
Name
string
description
required
Any of:
string
center_lng
required
Center Lng
number
center_lat
required
Center Lat
number
zoom
required
Zoom
number
bearing
required
Bearing
number
pitch
required
Pitch
number
basemap_style
required
Basemap Style
string
show_basemap_labels
Show Basemap Labels
boolean
default: true
has_non_public_layers
Has Non Public Layers
boolean
layers
required
Layers
Array<object>
SharedLayerResponse
object
dataset_id
required
Dataset Id
string
dataset_name
required
Dataset Name
string
display_name
Any of:
string
table_name
required
Table Name
string
geometry_type
required
Any of:
string
column_info
Any of:
Array<object>
object
key
additional properties
any
sort_order
required
Sort Order
integer
visible
required
Visible
boolean
opacity
required
Opacity
number
paint
required
Paint
object
key
additional properties
any
layout
required
Layout
object
key
additional properties
any
layer_type
Layer Type
string
default: vector_geolens
dataset_record_type
Any of:
string
filter
Any of:
Array
label_config
Any of:
object
key
additional properties
any
popup_config
Any of:
PopupConfig

Per-layer popup configuration: enable/disable + custom title template

  • ordered visible-fields allowlist. Persisted as JSONB on map_layers.
object
enabled
required
Enabled
boolean
expression
Any of:
string
<= 500 characters
visible_fields
Any of:
Array<string>
<= 100 items
style_config
Any of:
object
key
additional properties
any
show_in_legend
Show In Legend
boolean
default: true
tile_url
required
Tile Url
string
is_dem
Any of:
boolean
is_3d
Any of:
boolean
feature_count
Any of:
integer
Example 
{
  "show_basemap_labels": true,
  "has_non_public_layers": false,
  "layers": [
    {
      "layer_type": "vector_geolens",
      "show_in_legend": true
    }
  ]
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}