Boards
A board: the set of columns and lanes where cards of one kind of work move, such as "KPI tracking". Columns and lanes are separate resources that point at the board with board_ref, and space_boards puts the board into a space. Fields left out take the defaults of the app; a board without lanes gets one default lane. Give each board at least one column; a board without a space_boards record is placed in the space chosen for the import.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "boards". An entity can have any number of files. See Bundle format.
[
{
"resource": "boards",
"path": "resources/boards.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 board, for example KPI tracking. Up to 128 characters.Constraints: 1–128 characters. |
card_properties | object[] | No | Built-in card fields (size, due_date, tags, timeline, description) that the cards of this board always show. With required: true the field must also be filled, and a card where it is empty shows a warning. Each entry applies to all lanes, columns and card types of the board. |
card_properties[].field | enum | Yes | A built-in card field of the entry. Constraints: one of size, due_date, tags, timeline, description. |
card_properties[].required | boolean | No | Whether the field must be filled; the default is false. |
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: |
default_card_type_ref | Ref<card_types>? refers to Card types | No | The card type that new cards of this board start with, by the external_id of a card_types record. |
description | RichText? | No | Text shown on the board's information page; give the format with the text. |
References
Referenced by
- Activities:
payload.board_ref,payload.from.board_ref,payload.to.board_ref - Card history:
snapshot.board_ref - Cards:
board_ref - Columns:
board_ref - Lanes:
board_ref - Space boards:
board_ref
Boards
Refers to
default_card_type_ref→ Card types
Show on the entity map
Example
A record of this entity:
{
"external_id": "b-kpi",
"title": "KPI tracking",
"description": {
"format": "markdown",
"text": "Every company metric moves left to right: from a written definition to a live dashboard."
},
"default_card_type_ref": "ct-metric",
"card_properties": [
{
"field": "size"
},
{
"field": "due_date",
"required": true
},
{
"field": "tags"
}
],
"created_at": "2026-01-07T09:00:00Z"
}Related entities
Card types, Cards, Columns, Lanes, Space boards
Check after the import
After the import, the records of this entity can be checked on Boards › Get board.
JSON Schema
boards.json
