Learn how to read the color picker column on monday boards using the platform API
The color picker column allows design teams to assign specific colors to items. After selecting a color, the column displays the relevant color code in the format of your choice.
Via the API, the color picker column supports read operations.
Column Type | Implementation Type | Supported Operations |
|---|---|---|
|
|
|
Queries
Color picker columns can be queried through the column_values field on items queries using an inline fragment on ColorPickerValue.
query {
items(ids: [1234567890, 9876543210]) {
column_values {
... on ColorPickerValue {
color
updated_at
}
}
}
}import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });
const query = `
query($itemIds: [ID!]) {
items(ids: $itemIds) {
column_values {
... on ColorPickerValue {
color
updated_at
}
}
}
}
`;
const variables = {
itemIds: [9571351485, 9572374902],
};
const response = await mondayApiClient.request(query, variables);Fields
You can use the following fields to specify what information your ColorPickerValue implementation will return.
| 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 value as text. Returns null if the column has no value. |
type ColumnType! | The column's type. |
updated_at Date | The column's last updated date. |
value JSON | The raw JSON-formatted column value. |
