Export floor as SVG

POST /floor/{floorId}/svg

Renders the floor's default layout as an SVG file and returns a download URL valid for 30 minutes. Uses the layout's latest published revision. The organisation's space label mapping is used; pass spaceLabelMapping to override, {} for none. Required API token scopes: floor.export plus either: floor.queryPublic or floor.readPublic for public floors, or either: floor.queryPrivate or floor.readPrivate for private floors. Publishable access tokens are not accepted.

Request

Path Parameters

floorId

string<uuid>

Body

theme

object
Floor plan theme (colors, room stamps, wall contours, fonts)

shapeLayers

object
Custom shape layers drawn on top of the plan

visibility

object
Element and space visibility by type, query or id, e.g. { "byType": { "roomStamp": { "show": false } } }

spaceLabelMapping

object
Custom labels per space usage, e.g. { "meetingRoom": "Huddle" }. Defaults to the organisation's space usage mapping; an object replaces it entirely, {} renders the plain usage labels

units

object

system

string ;values: metric |imperial

lengthDecimals

integer

areaDecimals

integer

roomDimensions

string ;values: area |boundingBox

Responses

200

OK

downloadUrl

string<uri>
Short URL redirecting to a signed AWS S3 url, valid for 30 minutes

thumbnailUrl

string<uri>
Signed AWS S3 url of a PNG thumbnail, only returned by the PDF export