Learn how to read, create, and delete required field columns using the platform API
On monday.com boards, you can designate required field columns that make specific columns mandatory when adding a new item. Doing so ensures that all new items added to your board will have specific columns populated. Any status, dropdown, numbers, date, timeline, people, text, email, phone, link, rating, country, or location column can be set as required.
Queries
You can retrieve monday.com required field columns data via the API through the validations
query.
- Returns an array containing metadata about one or a collection of required field columns
- Can only query
validations
directly at the root; can't be nested within another query - Requires permission to edit column settings on the board
- Available for Pro and Enterprise accounts only
query {
validations(
id: 1234567890
) {
required_column_ids
rules
}
}
Arguments
You can use the following argument(s) to reduce the number of results returned in your validations
query.
Argument | Description | Enum Values |
---|---|---|
id ID! | The board's unique identifier. | |
type ValidationsEntityType | The type of entity to validate. | board |
Fields
You can use the following field(s) to specify what information your validations
query will return.
Field | Description |
---|---|
required_column_ids [String!] | An array of the required columns' unique identifiers. |
rules JSON | The validation rules. |
Mutations
The API allows you to create and delete required columns using the following mutations.
Add required column
The add_required_column
mutation makes an existing column required via the API. This does not create a new column. It returns the RequiredColumns
type which allows you to specify what fields to query back when you run it.
Note: Available for Pro and Enterprise accounts only
mutation {
add_required_column(
id:1234567890,
column_id: "long_text",
type: board
) {
required_column_ids
}
}
{
"data": {
"add_required_column": {
"required_column_ids": [
"long_text"
]
}
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Arguments
Argument | Description | Enum Values |
---|---|---|
column_id String! | The column's unique identifier. | |
id ID! | The board's unique identifier. | |
type ValidationsEntityType | The type of entity to validate. | board |
Remove required column
The remove_required_column
mutation removes an existing column's required designation via the API. This does not delete the column itself. It returns the RequiredColumns
type which allows you to specify what fields to query back when you run it.
Note: Available for Pro and Enterprise accounts only
mutation {
remove_required_column(
id:1234567890,
column_id: "long_text",
type: board
) {
required_column_ids
}
}
{
"data": {
"remove_required_column": {
"required_column_ids": []
}
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Arguments
Argument | Description | Enum Values |
---|---|---|
column_id String! | The column's unique identifier. | |
id ID! | The board's unique identifier. | |
type ValidationsEntityType | The type of entity to validate. | board |