Checkbox
The checkbox column represents a simple true or false value on a board. Our API fully supports the checkbox column, so you can filter, read, update, and clear it via the API.
Filtering the checkbox column
Using the items_page
object, you can easily filter a board's items by specific columns or column values. The table below contains the checkbox column's supported operators and compare values.
Operators | Compare values |
---|---|
is_empty | null |
is_not_empty | null |
Pro tip
items_page
is only available in API version2023-10
for now.
The following example returns all items on the specified board that have an unchecked checkbox column.
query {
boards (ids: 1234567890) {
items_page (query_params: {rules: [{column_id: "check", compare_value: [null], operator:is_empty}]}) {
items {
id
name
}
}
}
}
Reading the checkbox column
You can query the checkbox column using the column_values
object. 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 checkbox column are of the CheckboxValue
type.
Pro tip
column_values
v2 fields are only available in API version2023-10
.
query {
items (ids:[1234567890, 9876543210]) {
column_values {
... on CheckboxValue {
checked
updated_at
}
}
}
}
Fields
Field | Description |
---|---|
checked Boolean | Returns true if the column is checked. |
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 checkbox column in two different formats when you query by column values. The text
field will return the data as a simple string; the result will be empty if the column is unchecked. 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 versions2023-10
and later.
{
"text": "v",
"value": "{\"checked\":\"true\",\"changed_at\":\"2022-07-14T12:00:00.000Z\"}"
}
Updating the checkbox column
You can update a checkbox column using the change_multiple_column_values
mutation and passing a JSON string in the column_values
argument. Simple string updates are not supported.
JSON
To check the box, send {"checked" : "true"}
in the column_values
argument. Check out this mutation in action in our Postman library or follow along with these code samples!
mutation {
change_multiple_column_values(item_id:1234567890, board_id:9876543210, column_values: "{\"checkbox\" : {\"checked\" : \"true\"}}") {
id
}
}
fetch ("https://api.monday.com/v2", {
method: 'post',
headers: {
'Content-Type': 'application/json',
'Authorization' : 'YOUR_API_KEY_HERE'
},
body: JSON.stringify({
query : "mutation ($myBoardId:Int!, $myItemId:Int!, $myColumnValues:JSON!) { change_multiple_column_values(item_id:$myItemId, board_id:$myBoardId, column_values: $myColumnValues) { id } }",
variables : JSON.stringify({
myBoardId: 1234567890,
myItemId: 9876543210,
myColumnValues: "{\"checkbox\" : {\"checked\" : \"true\"}}"
})
})
})
Clearing the checkbox column
You can also clear (uncheck) a checkbox column using the change_multiple_column_values
mutation and passing null
in the column_values
argument. Check out this mutation in action in our Postman library or follow along with these code samples!
mutation {
change_multiple_column_values(item_id:9876543210, board_id:1234567890, column_values: "{\"checkbox\" : null}"){
id
}
}
fetch ("https://api.monday.com/v2", {
method: 'post',
headers: {
'Content-Type': 'application/json',
'Authorization' : 'YOUR_API_KEY_HERE'
},
body: JSON.stringify({
query : "mutation ($myBoardId:Int!, $myItemId:Int!, $myColumnValues:JSON!) { change_multiple_column_values(item_id:$myItemId, board_id:$myBoardId, column_values: $myColumnValues) { id } }",
variables : JSON.stringify({
myBoardId: 1234567890,
myItemId: 9876543210,
myColumnValues: "{\"checkbox\" : null}"
})
})
})
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! 😎
Updated 3 months ago