The button column allows you to perform an action (i.e., move an item to a new group) with just the click of a button. Our API partially supports the button column, so you can only read it via the API. We currently do not support filtering your results by the button column.

Reading the button column

You can query the button column using the column_values object. The object has different fields based on which API version you are using. Column values v2 fields will be available in API versions 2023-10 and later, while column values v1 fields are only supported in versions 2023-07 and 2023-04.

Column values v2

The column_values object enables you to return column-specific subfields by sending a fragment in your query. Values for the button column are of the ButtonValue type.

👍

Pro tip

column_values v2 fields are only available in API version 2023-10.

query {
  items (ids:[1234567890, 9876543210]) {
    column_values {
      ... on ButtonValue {
        color
        label
      }
    }
  }
}

Fields

Column values v1

You can return the data in a button column in two different formats when you query by column values. The text field will return the button's label as a simple string. The value field will return the metadata about the button as a JSON string.

🚧

Removing column values v1 support

column_values v1 fields will no longer be supported in API versions 2023-10 and later.

{
  "text": "Click Here",
  "value": "{\"clicks\":1,\"changed_at\":\"2022-08-05T12:00:00.000Z\"}"
}

📘

Join our developer community!

We've created a community specifically for our devs where you can search through previous topics to find solutions, ask new questions, hear about new features and updates, and learn tips and tricks from other devs. Come join in on the fun! 😎