Skip to content

Developer Docs

Main Navigation

3D Embed API

REST API

GraphQL API

Appearance

Sidebar Navigation

REST API Reference

Buildings

List buildings

Create building

Get building

Update building

Delete building

Floor

List floors

Create floor

Update floor

Get floor

Export floor as GeoJSON

Export floor as PNG / SVG

Export floor as DXF

Export floor as IFC

Export floor as GLTF

Export floor as IMDF

Archive a floor

Unarchive a floor

Duplicate a floor

Assign label to floor

Remove a label

Layout

List layouts

Create a layout

Get layout

Update layout

Delete layout

Duplicate a layout

List layout revisions

Create a layout revision

Get layout revision

Run layout operations

Space

List spaces

Get space

Get space GeoJSON

Asset

List assets

Get asset

Get asset GeoJSON

Custom attribute

List definitions

List definitions for resource type

Create definition

Update definition

Delete definition

Get definitions for resource type and key

Token

Create temporary access token

Label

List labels

Get label

Create or update label

Delete label

Webhook

List webhooks

Create webhook

Get webhook

Update webhook

Delete webhook

Extensions

List extensions

Create extension

Add a new version

Delete extension

Create a layout

POST /layout

Create a new layout for a given floor

Request

Body

floorId

string

layout

isDefault

categories

array [string ]

Responses

200

Returns the new layout

id

string

floorId

string

layout

isDefault

boolean

categories

array [string ]