The timeline column contains a range of dates. This is useful should your item(s) require more than a single date to be stored. Our API supports this column, so you can read and update the timeline column via the API.

Reading the timeline column

You can return the data in a timeline column in two different formats. The text field will return the data as a simple string, and the value field will return the data as a JSON string.

  "text": "2022-07-22 - 2022-08-14",
  "value": "{\"to\":\"2022-08-14\",\"from\":\"2022-07-22\",\"changed_at\":\"2022-07-21T12:00:00.000Z\"}"

Updating the timeline column

You can update a timeline column with a JSON string. Simple string updates are not supported.

To update a timeline column, send the start and end dates in a YYYY-MM-DD format, where the start date is “from” and the end date is “to”.

For example: "{\"from\":\"2019-06-03\",\"to\":\"2019-06-07\"}"

mutation {
  change_multiple_column_values(item_id:11111, board_id:22222, column_values: "{\"timeline_2\" : {\"from\" : \"2019-06-03\", \"to\" : \"2019-06-07\"}}") {
fetch ("", {
  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: YOUR_BOARD_ID,
      myItemId: YOUR_ITEM_ID,
      myColumnValues: "{\"timeline_2\" : {\"from\" : \"2019-06-03\", \"to\": \"2019-06-07\"}}"

You can find the Postman request to change the timeline column here.

Clearing the timeline column

You can clear the timeline column using a change_multiple_column_values mutation.

mutation {
  change_multiple_column_values(item_id:2973227073, board_id:2973227049, column_values: "{\"timeline\" : {\"to\" : \"\", \"from\" : \"\"}}") {


Have questions?

Join our developer community! You can share your questions and learn from fellow users and product experts.

Don’t forget to search before opening a new topic!