Learn how to read type-specific column settings via the API
🚧 Only available in API versions 2025-10 and later
When creating and updating columns via the API, you must know the column's type-specific schema. You can retrieve these by querying the get_column_type_schema
object.
Queries
- Returns a JSON object defining the schema definition for a specific column type
- Can only be queried directly at the root
query {
get_column_type_schema (type: board_relation)
}
{
"data": {
"get_column_type_schema": {
"schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"settings": {
"type": "object",
"description": "Column specific settings",
"properties": {
"allowCreateReflectionColumn": {
"type": "boolean",
"description": "Whether to allow creation of reflection columns"
},
"allowMultipleItems": {
"type": "boolean",
"description": "Whether to allow selection of multiple items"
},
"boardIds": {
"type": "array",
"description": "Array of related board IDs",
"items": {
"type": "integer"
}
},
"boardId": {
"type": "integer",
"description": "Default board ID for the relation"
},
"item_ids": {
"type": "array",
"description": "Array of related item IDs",
"items": {
"type": "integer"
}
}
},
"additionalProperties": false
}
}
}
}
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Arguments
You can use the following argument(s) to reduce the number of results returned in your get_column_type_schema
query.
Argument | Description |
---|---|
type ColumnType! | The type of column to retrieve the schema for. |