The status column represents a label designation for your item(s). It can be used to denote the status of a particular item or hold any other custom labeling for the item. Each status column is a collection of indexes and their corresponding labels. The API allows you to read, filter, create, update, and clear the status column.

Read a status column

You can query the status column using the column_values object that enables you to return column-specific subfields by sending a fragment in your query. Values for the status column are of the BatteryValue or StatusValue type, depending on the board type (i.e., classic or multi-level).

StatusValue

For classic boards, status columns are of the StatusValue type.

query {
  items (ids:[1234567890, 9876543210]) {
    column_values {
      ... on StatusValue {
        index
        value
      }
    }
  }
}

Fields

You can use the following fields to specify what information to return.

BatteryValue

For multi-level boards, status rollup columns are of the BatteryValue type.

query {
  items (ids:[1234567890, 9876543210]) {
    column_values {
      ... on BatteryValue {
        battery_value {
          count
          key
				}
      }
    }
  }
}

Fields

You can use the following fields to specify what information to return.

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

Examples

This example returns all items on the specified board with a blank status value.

query {
  boards(ids: 1234567890) {
    items_page(
      query_params: {
        rules: [
          {
            column_id: "status"
            compare_value: [5]
            operator:any_of
          }
        ]
      }
	) {
      items {
        id
        name
      }
    }
  }
}

This example returns all items on the specific board with a "Done" label.

query {
  boards(ids: 1234567890) {
    items_page(
      query_params: {
        rules: [
          {
            column_id: "status"
            compare_value: "Done"
            operator:contains_terms
          }
        ]
      }
	) {
      items {
        id
        name
      }
    }
  }
}

Create a status column

Required scope:boards:write

The create_status_column mutation creates a new status column with strongly typed settings via the API. You can specify which fields to return from the new status column in the mutation response.

mutation {
  create_status_column(
    board_id: 1234567890
    id: "project_status"
    title: "Project Status"
    defaults: {
      labels: [
        { color: working_orange, label: "On Hold", index: 2}
        { color: done_green, label: "Done", index: 1}
        { color: sky, label: "Working On It", index: 3}
      ]
    },
    description: "The project's status."
  ) {
    description
    id
		title
  }
}

Arguments

You can use the following arguments to define the new status column's characteristics.

Update a status column

You can update a status column with either a simple string or a JSON string, and each status column can have a maximum of 40 labels.

Simple strings

Using the change_simple_column_value mutation, you can pass either the index or the label value of the status you want to update in the value argument. If the label is a number, send the index instead. Otherwise, the label will be treated as an index value, and the mutation will fail.

You can also send create_labels_if_missing: true in your mutation to create any labels that don't yet exist and avoid an error.

mutation {
  change_simple_column_value(
    item_id:9876543210
    board_id:1234567890
    column_id:"status"
    value: "8"
	) {
    id
  }
}

JSON

Using the change_multiple_column_values mutation, you can pass either the index or the label value of the status you want to update in the column_values argument. If the label is a number, send the index instead. Otherwise, the label will be treated as an index value, and the mutation will fail.

You can also send create_labels_if_missing: true in your mutation to create any labels that don't yet exist and avoid an error.

mutation {
  change_multiple_column_values(
    item_id:9876543210
    board_id:1234567890
    column_values: "{\"status\" : {\"index\" : \"1\"}}"
	) {
    id
  }
}

Clear a status column

You have two options to clear a status column. First, you can use the change_multiple_column_values mutation and pass null an empty string, or an empty object in the column_values argument.

mutation {
  change_multiple_column_values(
    item_id:9876543210
    board_id:1234567890
    column_values: "{\"status\" : null}"
	) {
    id
  }
}

You can also use the change_simple_column_value mutation and pass an empty string in the value argument.

mutation {
  change_simple_column_value(
    item_id:9876543210
    board_id:1234567890
    column_id: "status"
    value: ""
	) {
    id
  }
}

Index values and color mapping

As mentioned above, you can use both Index and Label values when using JSON formatting in your Mutation calls to update the Status column.

• change_column_value
• change_multiple_column_values
• create_item,create_subitem

By default, every index value matches a specific color. For example, the Green status has the index 1. Here’s a full list of the indexes and matching values.

When you create a new Status label, it will follow the default index value and its index will not change. However, the color of a status label can be changed. Therefore, you cannot assume a label’s color and index will always match.

Take the following example:

Index: 2 will have a color value of #e2445c. Thus, using this index value will set the Status column value to a Red-shadow color, as shown below:

And on the board, this will appear as such:

The color values are not static and can be changed within the Status column labels. You can find more info on this here.

Then, the index value will remain the same, but the color value will be changed. For example, if I chose Black as the new color, this is how the color value would appear in the API:

And this is how the item would appear on the board:

As such, using index values does not guarantee that you will populate the same color values across multiple boards.

If you encounter a mismatch of index values when sending data between boards in your account, we recommend manually changing the color of the labels back to the default values .