Learn more about the other types used when reading, creating, updating, and deleting columns via the API
/tThe monday.com columns API lets you query a board's column configuration, appearance, and settings.
Each of the object types described below represents a specific aspect of a column. They can be queried as subfields on the columns query or provide column metadata in mutations.
ColumnCapabilities
An object containing the column's capability settings.
Field | Description | Supported Subfields |
|---|---|---|
calculated | The column’s capability settings. | calculated_type |
CalculatedCapability
An object containing a column's calculated capability settings.
Field | Description | Enum Values |
|---|---|---|
calculated_type | The type of calculated value. | |
function | The function to calculate the parent values. |
|
ColumnCapabilitiesInput
An object containing the input configuration for a column's capabilities.
| Field | Description | Supported Fields |
|---|---|---|
calculated CalculatedCapabilityInput | The input for configuring a column's calculated capability settings. | function CalculatedFunction! |
CalculatedCapabilityInput
An object containing the input settings for a column's calculated capabilities.
| Field | Description | Supported Fields |
|---|---|---|
calculated CalculatedCapabilityInput | The input for configuring a column's calculated capability settings. | function CalculatedFunction! |
CalculatedFunction
An enum containing the functions used to calculate column values within column capabilities.
Field | Description | Enum Values |
|---|---|---|
function | The function to count the values. If not provided, the default column type function will apply. |
|
ColumnMappingInput
An object containing the mapping between source and target columns across boards.
| Field | Description |
|---|---|
source ID! | The source column's unique identifier. |
target ID | The target column's unique identifier. |
ColumnType
An enum containing the available column types that can be filtered, read, or updated in queries and mutations.
auto_number | board_relation | button |
checkbox | color_picker | country |
creation_log | date | dependency |
doc | dropdown | email |
file | formula | hour |
item_assignees | item_id | last_updated |
link | location | long_text |
mirror | name | numbers |
people | phone | progress |
rating | status | subtasks |
tags | team | text |
timeline | time_tracking | vote |
week | world_clock | unsupported |
CreateDropdownColumnSettingsInput
An object containing the settings for a new dropdown column.
| Field | Description | Supported Fields |
|---|---|---|
label_limit_count Int | The maximum number of labels that can be selected. Must be used with the limit_select field. | |
labels [CreateDropdownLabelInput!]! | An array containing the dropdown column's labels. | label String! |
limit_select Boolean | Whether to limit the number of labels that can be selected. Must be used with the label_limit_count field. |
CreateDropdownLabelInput
An object containing the properties of a label in a new dropdown column.
| Field | Description |
|---|---|
label String | The new dropdown column's labels. |
CreateStatusColumnSettingsInput
An object containing the settings for a new status column.
Field | Description | Supported Fields |
|---|---|---|
labels | An array containing the status column’s labels. | color |
CreateStatusLabelInput
An object containing the properties of a label in a new status column.
| Field | Description | Enum Values |
|---|---|---|
color StatusColumnColors! | The label's color. | working_orange, done_green, stuck_red, dark_blue, purple, explosive, grass_green, bright_blue, saladish, egg_yolk, blackish, dark_red, sofia_pink, lipstick, dark_purple, bright_green, chili_blue, american_gray, brown, dark_orange, sunset, bubble, peach, berry, winter, river, navy, aquamarine, indigo, dark_indigo, pecan, lavender, royal, steel, orchid, lilac, tan, sky, coffee, teal |
description String | The label's description. | |
index Int! | The label's place in the list of supported labels. Lower numbers indicate a higher placement in the list. | |
is_done Boolean | Whether the label's status is done. | |
label String! | The label's text value. |
FileValueItem
An object containing the possible file representations for a files column's value.
| Possible Types |
|---|
FileAssetValue |
FileDocValue |
FileLinkValue |
FileAssetValue
An object containing the metadata for an uploaded asset file in a files column.
| Fields | Description |
|---|---|
asset Asset! | The asset associated with the file. |
asset_id ID! | The asset's unique identifier. |
created_at Date! | The file's creation date. |
creator User | The file's creator. |
creator_id ID | The unique identifier of the file's creator. |
is_image Boolean! | Whether the asset is an image. |
name String! | The asset's name. |
FileDocValue
An object containing the metadata for a monday document returned in a files column.
| Field | Description |
|---|---|
created_at Date! | The file's creation date. |
creator User | The file's creator. |
creator_id ID | The unique identifier of the file's creator. |
doc Document! | The document associated with the file. |
file_id ID! | The file's unique identifier. |
object_id ID! | The unique identifier of the associated board or object. |
url String | The file's URL. |
FileLinkValue
An object containing the metadata for an externally linked file in a files column.
Field | Description | Enum Values |
|---|---|---|
created_at | The file's creation date. | |
creator | The file's creator. | |
creator_id | The unique identifier of the file's creator. | |
file_id | The file's unique identifier. | |
kind | The file's kind. |
|
name | The file's name. | |
url | The file's URL. |
MirroredItem
An object containing details about a mirrored item returned by the MirrorValue implementation.
| Fields | Description | Possible Types |
|---|---|---|
linked_board Board! | The linked board. | |
linked_board_id ID! | The linked board's unique identifier. | |
linked_item Item! | The linked item. | |
mirrored_value MirroredValue | The mirrored values. | Board, BoardRelationValue, ButtonValue, CheckboxValue, ColorPickerValue, CountryValue, CreationLogValue, DateValue, DependencyValue, DocValue, DropdownValue, EmailValue, FileValue, FormulaValue, Group, HourValue, ItemIdValue, LastUpdatedValue, LinkValue, LocationValue, LongTextValue, MirrorValue, NumbersValue, PeopleValue, PhoneValue, ProgressValue, RatingValue, StatusValue, SubtasksValue, TagsValue, TeamValue, TextValue, TimeTrackingValue, TimelineValue, UnsupportedValue, VoteValue, WeekValue, WorldClockValue |
NumberValueUnitDirection
An enum containing the possible positions for a number value’s unit symbol within a NumbersValue field.
| Enum values | Description |
|---|---|
| left | The symbol is placed to the left of the number. |
| right | The symbol is placed to the right of the number. |
PeopleEntity
An object containing the people or team information represented in a PeopleValue field.
Field | Description | Enum Values |
|---|---|---|
id | The unique identifier of the person or team. | |
kind | The type of entity. |
|
StatusColumnCapabilitiesInput
An object containing the input configuration for a status column's capabilities.
| Field | Description | Supported Fields |
|---|---|---|
calculated StatusCalculatedCapabilityInput | The status column's capability settings. | function StatusCalculatedFunction! |
StatusCalculatedFunction
An enum containing the functions used to calculate values in a status column.
| Field | Description | Enum Values |
|---|---|---|
functionStatusCalculatedFunction! | The function to calculate the values. | COUNT_KEYS (label count) |
StatusLabelStyle
An object containing the style properties for a status label returned by the StatusValue implementation.
| Field | Description |
|---|---|
border String! | The label's border Hex color code. |
color String! | The label's Hex color code. |
TimeTrackingHistoryItem
An object containing the details of an individual time-tracking session returned by the TimeTrackingValue implementation.
| Field | Description |
|---|---|
created_at Date! | The date the session was added to the item. |
ended_at Date | The date the session ended. |
ended_user_id ID | The unique identifier of the user that ended the time tracking. |
id ID! | The unique session identifier. |
manually_entered_end_date Boolean! | Whether the session end date was entered manually. |
manually_entered_end_time Boolean! | Whether the session end time was entered manually. |
manually_entered_start_date Boolean! | Whether the session start date was entered manually. |
manually_entered_start_time Boolean! | Whether the session start time was entered manually. |
started_at Date | The date the session was started. Only applicable if the session was started by pressing the play button or through an automation. |
started_user_id ID | The unique identifier of the user that started the time tracking. |
status String! | The session's status. |
updated_at Date | The date the session was updated. |
UpdateDropdownColumnSettingsInput
An object containing the updated settings for a dropdown column.
| Field | Description | Supported Fields |
|---|---|---|
label_limit_count Int | The maximum number of labels that can be selected. Must be used with the limit_select field. | |
labels [UpdateDropdownLabelInput!]! | An array containing the dropdown column's labels. | label String! |
limit_select Boolean | Whether to limit the number of labels that can be selected. Must be used with the label_limit_count field. |
UpdateDropdownLabelInput
An object containing the properties of a dropdown label to update.
| Field | Description |
|---|---|
id Int | The unique identifier of the label to update. |
is_deactivated Boolean | Whether the label is deactivated. |
label String | The new dropdown column's labels. |
UpdateStatusColumnSettingsInput
An object containing the updated configuration settings for a status column.
Field | Description | Supported Fields |
|---|---|---|
labels | An array containing the status column’s updated labels. | color |
UpdateStatusLabelInput
An object containing the properties of a status label to update.
| Field | Description | Enum Values |
|---|---|---|
color StatusColumnColors! | The label's color. | working_orange, done_green, stuck_red, dark_blue, purple, explosive, grass_green, bright_blue, saladish, egg_yolk, blackish, dark_red, sofia_pink, lipstick, dark_purple, bright_green, chili_blue, american_gray, brown, dark_orange, sunset, bubble, peach, berry, winter, river, navy, aquamarine, indigo, dark_indigo, pecan, lavender, royal, steel, orchid, lilac, tan, sky, coffee, teal |
description String | The label's description. | |
id Int | The unique identifier of the label to update. | |
index Int! | The label's place in the list of supported labels. Lower numbers indicate a higher placement in the list. | |
is_deactivated Boolean | Whether the label is deactivated. | |
is_done Boolean | Whether the label's status is "Done". | |
label String! | The label's text value. |
