The color picker column allows you to pick specific colors on a board to help maintain a consistent board design. After selecting your color, the column will display the relevant color code in the format of your choice. Our API partially supports the color picker column, so you can only read it via the API. We currently do not support filtering results by the color picker column.

Reading the color picker column

You can query the color picker column using the column_values. The object has different fields based on which API version you are using. Column values v2 fields will be available in API versions 2023-10 and later, while column values v1 fields are only supported in versions 2023-07 and 2023-04.

Column values v2

The column_values object enables you to return column-specific subfields by sending a fragment in your query. Values for the color picker column are of the ColorPickerValue type.

👍
Pro tip
column_values v2 fields are only available in API version 2023-10.

query {
  items (ids:[1234567890, 9876543210]) {
    column_values {
      ... on ColorPickerValue {
        color
        updated_at
      }
    }
  }
}

Fields

Field	Description
color `String`	The column's HEX color value.
column `Column!`	The column the value belongs to.
id `ID!`	The column's unique identifier.
text `String`	The column's value as text.
type `ColumnType!`	The column's type.
updated_at `Date`	The column's last updated date.
value `JSON`	The column's JSON-formatted raw value.

Column values v1

You can return the data in a color picker column in two different formats when you query by column values. The text field will return the HEX code for the selected color as a simple string. The value field will return metadata about the column as a JSON string.

🚧
Removing column values v1 support
column_values v1 fields will no longer be supported in API versions 2023-10 and later.

{
  "text": "#61b927",
  "value": "{\"color\":{\"hex\":\"#61b927\",\"hsl\":{\"a\":1,\"h\":96.2014751552795,\"l\":0.43990062366832383,\"s\":0.6484224082421121},\"hsv\":{\"a\":1,\"h\":96.2014751552795,\"s\":0.78671875,\"v\":0.7251420454545454},\"rgb\":{\"a\":1,\"b\":39,\"g\":185,\"r\":97},\"oldHue\":96.2014751552795,\"source\":\"rgb\"},\"changed_at\":\"2022-08-05T12:00:00.000Z\"}"
}

📘
Join our developer community!
We've created a community specifically for our devs where you can search through previous topics to find solutions, ask new questions, hear about new features and updates, and learn tips and tricks from other devs. Come join in on the fun! 😎