Spaces
A space: the top-level container of boards, folders and documents, such as "KPI Program". Spaces can be nested through parent_ref, and the spaces, folders and documents with the same parent share one list, ordered by sort_order; a space without a parent is created under the space you choose in the importer. Give boards to a space with space_boards and people and groups with tree_entity_roles. Imported spaces are open only to the people and groups given access, so list everyone who should see the space.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "spaces". An entity can have any number of files. See Bundle format.
[
{
"resource": "spaces",
"path": "resources/spaces.json"
}
]Fields
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string (ExternalId) | Yes | Your own identifier of the record, for example k-mrr, unique within the resource across all of its files and case sensitive. Other records refer to this one by it. The import also keeps it as the external id of the object it creates.Constraints: 1–512 characters. |
title | string | Yes | Name of the space, for example KPI Program. Up to 256 characters.Constraints: 1–256 characters. |
author_ref | Ref<users>? refers to Users | No | The user who created the record, by the external_id of a users record, for example u-ava. Leave it out or use null when the author is unknown or has left. |
created_at | Timestamp | No | When the record was created, with a time zone, for example 2026-01-12T09:30:00Z.Constraints: RFC 3339 with a time zone. Default: |
key | string | No | The prefix of the card keys this space issues, for example KPI_MRD_X7Q4: 2 to 16 characters, capital letters, digits and underscore, starting with a letter; a hyphen is not allowed. Leave it out when no card key comes from this space. The card keys that use it are the key of cards, and the counter that numbers the next card of the space continues after the highest number among them. A key is unique among spaces and folders together, and a key the target company already uses is replaced by a new one.Constraints: pattern ^[A-Z][A-Z0-9_]{1,15}$. |
parent_ref | PolymorphicRef? | No | Where a nested space sits: an object with resource (spaces, folders or documents) and the external_id of that record. Leave it out for a top-level space.Constraints: resource is one of spaces, folders, documents. |
sort_order | number | No | Position among the records next to it; a smaller number goes first and it must be greater than 0. Left out, the record goes to the end of the list. Constraints: > 0. Default: |
References
Referenced by
- Custom properties:
space_refs - Documents:
parent_ref - Folders:
parent_ref - Iterations:
space_ref - Space boards:
space_ref - Spaces:
parent_ref - Tree entity roles:
tree_entity_ref
Spaces
Show on the entity map
Example
A record of this entity:
{
"external_id": "s-kpi",
"title": "KPI Program",
"sort_order": 1,
"created_at": "2026-01-05T09:00:00Z",
"key": "KPI_MRD_X7Q4"
}Rules
- A key is unique among spaces and folders together.
- The value of key must be unique.
- parent_ref builds one tree together with Documents, Folders, Spaces; no record can be its own ancestor.
- A key must be unique within the company. Convertinator gives a key that the company already uses a new one and reports it before the import and on the final screen.
Related entities
Cards, Documents, Folders, Space boards, Tree entity roles
Check after the import
After the import, the records of this entity can be checked on Spaces › Retrieve space.
JSON Schema
spaces.json
