In API version 2023-10, the value argument in the change_simple_column_value mutation is nullable to enable column value deletion.

To clear the column, simply pass null value in the value argument.

mutation {
  change_simple_column_value (board_id:1234567890, item_id:9876543210, column_id:"date", value:null) {
    id
  }
}

The deprecated items_by_column_values and items_by_multiple_column_values objects will be removed and replaced with the new items_page_by_column_values object in API version 2023-10.

The new object provides a simple and intuitive way to query an item's column values. It combines two old objects into one while simultaneously keeping the behaviors nearly the same. It utilizes string values per column to search and return items with specific values, as well as cursor-based pagination to filter through large data sets.

It supports limited column types, but we will gradually add support for additional types over time. Certain columns also have restrictions that impact the scope of the object's querying abilities.

The items_page_by_column_values object enables you to query simple values and works best for simple use cases. We also added the new items_page object that has very powerful filtering capabilities and can be used for your advanced filtering needs!

In API version 2023-10, many of the ID arguments and fields that were integers have become ID type. This includes, but is not limited to, board_id, item_id, parent_item_id, parent_id, team_id, id, update_id, workspace_id, user_id, ids, and doc_folder_id.

The type ID is alphanumeric and accepts both strings and integers as valid inputs, but it will only return strings. Though it accepts both, we advise against treating them as integers and storing them in your database as text.

Let's take the docs object for example. The tables below show the impacted arguments and fields, what type they were before the update, and what they look like after the update.

Fields that are changing from Int to ID

Impacted arguments

In API version 2023-10, you can no longer send empty parentheses in queries. If you try, the query will return an error. Check out the code sample below to see a query that was previously supported and find out how you can update it so it won't throw an error!

Previously supported sample query

query {
  boards () {
    id
  }
}

Updated sample query

query {
  boards (ids:1234567890) {
    id
  }
}

query {
  boards (limit:10) {
    id
  }
}

Strings must be sent with quotation marks, so you can no longer send arguments without them in API versions 2023-10 and later. If you send strings without quotation marks, it will result in an error.

Check out the code samples below to see queries and mutations that were previously supported, and find out how you can update them so they won't throw an error!

Previously supported code samples

mutation {
  create_column(board_id: 1234567890, title:Country, description: "This is my country column", column_type:country) {
    id
    title
    description
  }
}

query {
  users (name: Test) {
    id
  }
}

query {
  items (ids: 1231234123) {
    column_values (ids: task_status) {
      value
    }
  }
}

Updated code samples

mutation{
  create_column(board_id: 1234567890, title:"Country", description: "This is my country column", column_type:country) {
    id
    title
    description
  }
}

query {
  users (name: "Test") {
    id
  }
}

query {
  items (ids: 1231234123) {
    column_values (ids: "task_status") {
      value
    }
  }
}

The newest_first argument for boards queries will be deprecated in API version 2023-10. You can instead use the order_by argument and sort by the creation date, so the most recently created boards will be listed first.

Sample query

query {
  boards (ids: 1234567890, order_by: created_at) {
    id
  }
}

We will remove the deprecated pos field on boards and columns queries in API version 2023-10.

You can use the new linked_items field to return an item's linked items. The response is an array that contains the unique identifiers of the linked items.

This field is only available in API versions 2023-10 and later!

Sample query

query {
  items (ids: 9876543210) {
    linked_items (linked_board_id:1234567890, link_to_item_column_id:"connect_boards") {
      id
    }
  }
}

Sample response

{
  "data": {
    "items": [
      {
        "linked_items": [
          {
            "id": "1122334455"
          },
          {
            "id": "5544332211"
          }
        ]
      }
    ]
  },
  "account_id": 12345678
}

The new edit_update and delete_update webhooks allow you to listen to boards to notify you when an update is edited or deleted. These events are only available in API versions 2023-10 and later.

The new move_item_to_board mutation allows you to easily move an item between boards via the API. If an item has subitems, they will also move with the item. Please note that if you do not provide column mapping, the system will try to map the item according to the column name and type.

The mutation is only available in API versions 2023-10 and later!

Sample mutation

mutation {
  move_item_to_board (board_id:1234567890, group_id: "new_group", item_id:9876543210) {
    id
  }
}