Subitems are special items that are "nested" under the items on your board. They can be accessed via the subitem column, which can be added from the column's center or by right-clicking an item to expose its dropdown menu. Like items, subitems store data within their columns.

Queries

Get subitems

• Required scope:boards:read
• Returns an array containing metadata about one or a collection of subitems
• Can only be nested within another query (e.g., items); can't be queried directly at the root

query {
  items(ids: 1234567890) {
    subitems {
      id
      column_values {
        value
        text
      }
    }
  }
}

Fields

Mutations

Required scope:boards:write

Create subitem

Creates a new subitem via the API. Returns Item.

The data of each subitem is stored in the subitem board columns (same as items), each of which holds a particular piece of information. Each column has a specific type, and different column types expect a different set of parameters to update their values. When sending data to a particular column, use a JSON-formatted string. If you're using JavaScript, you can use JSON.stringify() to convert a JSON object into a string.

You can also use simple values in this mutation or combine them with regular values. Read more about sending data for each column in our column types reference.

mutation {
  create_subitem(
    parent_item_id: 1234567890, 
    item_name: "New subitem", 
    column_values: "{\"date0\":\"2023-05-25\"}"
	) {
    id
    board {
      id
    }
  }
}

Arguments