Import & Export
Spaces can be bulk imported or exported using CSV files. This is useful for initial setup, integration with other systems, or performing bulk edits.
CSV Structure
Each row in the CSV represents a single space. The following fields are recognized:
| Field | Required | Description |
|---|---|---|
name |
Required | The display name of the space (e.g., Room 101). |
type |
Required | The space type (see Space Types). |
id |
Optional | The system identifier of the space. If provided, import will attempt to merge with an existing space. If omitted, a new space is created. |
In addition to these, any space property may be included using its
actual property name (see Space
Properties). For example, you might add floor_area or
max_occupancy.
Temporary IDs
Imports support the use of temporary ids prefixed with
@. These allow rows in the same import to reference each
other before permanent ids are assigned.
- A temporary id must be unique across the entire import (e.g.,
@floor-1). - When a new space is created with a temporary id, that identifier can
be used in other rows to reference relationships such as
parent_space_id. - During import, temporary ids are automatically “swizzled” to the assigned system ids.
For example:
name, type, id, parent_space_id
Floor 1, floor, @floor-1,
Room-101, room, , @floor-1
Room-102, room, , @floor-1
In this case, Room-101 and Room-102 reference @floor-1.
After import, those references are resolved to the real id assigned to
Floor-1.
Import Behavior
Merge — If an
idis provided and a matching space exists, the row’s properties are merged into the existing record. Properties not listed remain unchanged.Add Space — If no
idis provided, or a temporary id is provied, the row is added as a new space. Temporary ids can be used to link new rows together.Validation —
nameandtypeare required on every row. If import validation fails, no data will be added or updated. All errors are reported so they can be corrected and the import retried.
Export
Export produces a CSV with all defined spaces, including:
id,name, andtype- Any additional properties defined for each space
This export can be used as a template for re-importing updates.