Learn how to read and create mirror columns using the platform API
The mirror column displays a value from another board through a linked item. This allows users to make changes to multiple boards simultaneously and reuse data across boards without duplication.
Via the API, the mirror column supports read and create operations. Filtering mirrored content is not supported and may result in unexpected or inconsistent behavior.
Column Type | Implementation Type | Supported Operations |
|---|---|---|
|
|
|
Queries
Mirror columns can be queried through the column_values object using an inline fragment on MirrorValue.
query {
items(ids: [1234567890, 9876543210]) {
column_values {
... on MirrorValue {
display_value
id
}
}
}
}
Usedisplay_valueto read mirrored contentMirror columns don't expose raw values or structured field types. Always include
...on MirrorValue { display_value }.
Fields
You can use the following fields to specify what information your MirrorValue implementation will return.
| Field | Description |
|---|---|
column Column! | The column the value belongs to. |
display_value String! | The content of the mirrored column as text. |
id ID! | The column's unique identifier. |
mirrored_items [MirroredItem!]! | The linked items that provide the mirrored data. |
text String | Always returns null. Use display_value instead. |
type ColumnType! | The column's type. |
value JSON | Always returns null. Use mirrored_items instead. |
Mutations
Create
Required scope:boards:write
The create_column mutation creates a mirror column via the API. The defaults argument defines the mirror's configuration, including:
- Which column to mirror
- Which columns from the related board should be surfaced
You can specify which fields to return in the mutation response.
mutation {
create_column(
board_id: 1234567890
title: "Test Column"
column_type: mirror
defaults: {
relation_column: {
board_relation: true
}
displayed_linked_columns: [
{
board_id: "9876543210"
column_ids: ["status"]
}
]
}
) {
id
title
type
}
}