World clock
The world clock column holds the current time of any place in the world. Our API fully supports the world clock column, so you can filter, read, update, and clear it via the API.
Filtering the world clock 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 world clock column's supported operators and compare values.
Operators | Compare values |
---|---|
any_of | The name of the timezone (as shown in the UI) |
not_any_of | The name of the timezone (as shown in the UI) |
Pro tip
items_page
is only available in API version2023-10
for now.
The following example returns all items on the specified board with a world clock column value of Samoa.
query {
boards (ids: 1234567890) {
items_page (query_params: {rules: [{column_id: "world_clock", compare_value: ["Samoa"], operator:any_of}]}) {
items {
id
name
}
}
}
}
Reading the world clock column
You can query the world clock 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 world clock column are of the WorldClockValue
type.
Pro tip
column_values
v2 fields are only available in API version2023-10
.
query {
items (ids:[1234567890, 9876543210]) {
column_values {
... on WorldClockValue {
text
timezone
}
}
}
}
Fields
Field | Description |
---|---|
column Column! | The column the value belongs to. |
id ID! | The column's unique identifier. |
text String | The column's value as text. |
timezone String | The column's timezone. |
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 world clock column in two different formats when you query by column values. The text
field will return the time zone as a simple string. The value
field will return the column's metadata 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": "US/Pacific",
"value": "{\"timezone\":\"US/Pacific\",\"changed_at\":\"2022-07-21T12:00:00.000Z\"}"
}
Updating the world clock column
You can update a world clock 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 update a world clock column, send the time zone of the user as a string in continent/city form. 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: "{\"world_clock\" : {\"timezone\" : \"Europe/London\"}}") {
id
}
}
fetch ("https://api.monday.com/v2", {
method: 'post',
headers: {
'Content-Type': 'application/json',
'Authorization' : 'YOUR_API_KEY'
},
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: "{\"world_clock\" : {\"timezone\" : \"Europe/London\"}}"
})
})
})
Clearing the world clock column
You can also clear a world clock column using the change_multiple_column_values
mutation and passing null
or an empty object in the column_values
argument.
mutation {
change_multiple_column_values(item_id:9876543210, board_id:1234567890, column_values: "{\"world_clock\" : 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: "{\"world_clock\" : 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