HTML map image

get

https://{subdomain}.maptician.com/ext/v1/maps/{mapID}/html/

Returns an HTML page consisting of a non-live copy of the current version of the specified map.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

mapID

uuid

required

The identifier for the map.

Query Params

background_color

string

Defaults to #ffffff

The color the background of the map will be rendered with. Should generally be the hexadecimal color value.

background_opacity

number

0 to 1

Defaults to 1

The opacity of the map's background.

primary_shadows

boolean

Defaults to true

Whether primary map objects cast a shadow on the background.

overlay_shadows

boolean

Defaults to true

Whether overlay map objects cast a shadow on the background. These objects include token-icon based map objects and text labels.

architect

boolean

Determines whether the architecture layer will be rendered in the returned map. For all layer parameters, an affirmative inclusion (providing a 'true' value) will make the map only render the layers that are specifically called with a true value. If a layer is provided a 'false' value, then the layer will be omitted, but other layers will be included by default.

zones

boolean

Determines whether the zones layer will be rendered in the returned map.

rooms

boolean

Determines whether the rooms layer will be rendered in the returned map.

furniture

boolean

Determines whether the furniture layer will be rendered in the returned map.

poi

boolean

Determines whether the points of interest layer will be rendered in the returned map.

security

boolean

Determines whether the security infrastructure layer will be rendered in the returned map.

maplinks

boolean

Determines whether the maplinks layer will be rendered in the returned map.

info

boolean

Determines whether the map information layer will be rendered in the returned map.

seats

boolean

Determines whether the Seats layer will be rendered in the returned map. If any layer parameter is explicitly provided with true, the map will render only those layers (include-mode). If a layer is provided with false, that layer will be omitted while others remain included by default (exclude-mode). This parameter applies to SVG and HTML exports.

export_time

string

Point-in-time context used to populate Seats with assignments, reservations, and flex schedules “as of” the given moment. Accepts: - ISO-8601 (e.g., 2025-10-28T09:00:00-04:00) - Unix epoch milliseconds (e.g., 1730120400000) - Unix epoch seconds (e.g., 1730120400, when time_format=unixS)
If omitted, uses the server receipt time in the map’s timezone.

time_format

string

enum

Defaults to iso

Parser to use for export_time. If not provided, iso is assumed. Supported values mirror dateTimeFormatType.

Allowed:

selfContained

boolean

When true, inlines external <image> assets as base64 data URIs in the SVG markup for a portable, self-contained file. Applies to SVG/HTML map exports. Default is false.

Headers

mapticianauth

string

required

Authorization token to access the API.

Responses

400

Invalid Request

500

Server Error

200HTML Map