Button

Learn how to read the button column using the monday.com API

The button column lets users trigger predefined actions with a single click.

Via the API, the button column is read-only. You can query its configuration and value data, but you can't update, filter, or programmatically trigger buttons.

Column Type

Implementation Type

Supported Operations

button

ButtonValue

  • Read: Yes
  • Filter: No
  • Update: No
  • Clear: No

Queries

Button columns can be queried through the column_values field on items queries using an inline fragment on ButtonValue.

query {
  items(ids: [1234567890]) {
    id
    name
    column_values {
      ... on ButtonValue {
        id
        label
        color
        text
      }
    }
  }
}
import { ApiClient } from "@mondaydotcomorg/api";
const client = new ApiClient({ token: process.env.MONDAY_TOKEN });

const query = `
  query($itemIds: [ID!]) {
    items(ids: $itemIds) {
      id
      name
      column_values {
        ... on ButtonValue {
          id
          label
          color
          text
        }
      }
    }
  }
`;


const variables = { itemIds: [1234567890] };
const response = await client.request(query, variables);

Fields

You can use the following fields to specify what information your ButtonValue implementation will return.

FieldDescription
id ID!The button column's unique identifier.
label String!The button's label.
text StringThe button’s display text.
color StringThe button’s HEX color value.
column Column!The column the value belongs to.
type ColumnType!The column type.
value JSONThe raw JSON-formatted column value.