The name column holds the names of your item(s) and is the first column you see on a board. The API allows you to read, filter, and update the name column.

Read a name column

You can't read the name column using column_values, but you can read it using the items_page_by_column_values object.

The following example returns all items on board 1234567890 that have "Item 1" as their name column value.

query {
  items_page_by_column_values(
    board_id: 1234567890
    columns: {
      column_id: "name"
      column_values: "Item 1"
    }
  ) {
    items {
      id
      name
    }
  }
}

Filter a name 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 name column's supported operators and compare values.

Examples

The following example returns all items on the specified board with an item whose name contains "Project 1".

query {
  boards(ids: 1234567890) {
    items_page(
      query_params: {
        rules: [
          {
            column_id: "name"
            compare_value: ["Project 1"]
            operator: contains_text
          }
        ]
      }
    ) {
      items {
        id
      }
    }
  }
}

Update a name column

You can update a preexisting item's name 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 the item's name using JSON, send a string between 1 and 255 characters long.

mutation {
  change_multiple_column_values(
    item_id: 9876543210
    board_id: 1234567890
    column_values: "{\"name\": \"My Item\"}"
  ) {
    id
  }
}