Get Map Endpoint

GET

/maps/{map_id}

curl --request GET \
  --url https://example.com/api/maps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Get a single map with its layers.

Authorizations

• OAuth2PasswordBearer

Parameters

Path Parameters

map_id

required

Map Id

string format: uuid

Responses

200

Successful Response

Media type application/json

MapResponse

object

id

required

Id

string format: uuid

name

required

Name

string

description

required

Any of:

string

string

null

null

notes

Any of:

string

string

null

null

center_lng

required

Any of:

number

number

null

null

center_lat

required

Any of:

number

number

null

null

zoom

required

Any of:

number

number

null

null

bearing

required

Bearing

number

pitch

required

Pitch

number

basemap_style

required

Basemap Style

string

show_basemap_labels

required

Show Basemap Labels

boolean

visibility

required

MapVisibility

string

Allowed values: private internal public

thumbnail_url

Any of:

string

string

null

null

forked_from_id

Any of:

string

string format: uuid

null

null

forked_from_name

Any of:

string

string

null

null

created_by

required

Any of:

string

string format: uuid

null

null

created_by_username

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

layers

required

Layers

Array<object>

MapLayerResponse

object

id

required

Id

string format: uuid

dataset_id

required

Dataset Id

string format: uuid

dataset_name

required

Dataset Name

string

dataset_geometry_type

required

Any of:

string

string

null

null

dataset_table_name

required

Dataset Table Name

string

dataset_extent_bbox

required

Any of:

Array<number>

Array<number>

null

null

dataset_column_info

Any of:

Array<object>

Array<object>

object

key

additional properties

any

null

null

dataset_feature_count

Any of:

integer

integer

null

null

dataset_sample_values

Any of:

object

object

key

additional properties

any

null

null

display_name

Any of:

string

string

null

null

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

string

null

null

filter

Any of:

Array

Array

null

null

label_config

Any of:

object

object

key

additional properties

any

null

null

popup_config

Any of:

PopupConfig

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

string

<= 500 characters

null

null

visible_fields

Any of:

Array<string>

Array<string>

<= 100 items

null

null

null

null

style_config

Any of:

object

object

key

additional properties

any

null

null

show_in_legend

Show In Legend

boolean

default: true

is_3d

Any of:

boolean

boolean

null

null

layer_count

required

Layer Count

integer

widgets

Any of:

Array<string>

Array<string>

null

null

Example

{
  "visibility": "private",
  "layers": [
    {
      "layer_type": "vector_geolens",
      "show_in_legend": true
    }
  ]
}

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": {}
    }
  ]
}