The world clock column displays the current time for any global location. You can use the API to read, filter, update, and clear world clock column values.

Read a world clock column

You can query the world clock column using the column_values object to return column-specific subfields by sending a fragment in your query. Values are of the WorldClockValue type.

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. Returns `""` if the column has an empty value.
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.

Filter a world clock column

Using the items_page object, you can filter a board's items by specific columns or column values. The world clock column supports these operators and compare values:

Operators	Compare Values
`any_of`	Timezone name (as shown in the UI)
`not_any_of`	Timezone name (as shown in the UI)

Example

This 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 
			}
    }
  }
}

Update a 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 Format

To update a world clock column, send the time zone of the user as a string in continent/city form:

mutation {
  change_multiple_column_values(
    item_id:9876543210
    board_id:1234567890
    column_values: "{\"world_clock\" : {\"timezone\" : \"Europe/London\"}}"
	) {
    id
  }
}

Clear a world clock column

You can 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
  }
}