Object Schemas Other Types

Learn more about the other types used when reading, creating, updating, and deleting object schemas via the API

The monday.com object schemas API lets you manage the column structure applied across boards in your account. The types below are used as inputs and return types across the object schema queries and mutations.

ObjectSchemaColumn

Represents a column defined within an object schema.

FieldTypeDescription
descriptionStringThe column's description. Returns null if not set.
idID!The column's unique identifier.
policyObjectSchemaColumnPolicyThe policy rules governing this column. Returns null if no policy is set.
settingsJSONThe column's type-specific configuration as a JSON object.
tagsObjectSchemaColumnTagsStatus tags for this column (deprecation, opt-in, inheritance info).
titleString!The column's display title.
typeColumnTypeThe column's type.

ObjectSchemaColumnPolicy

Defines the policy rules that govern a column's behavior and what boards can override.

FieldTypeDescription
can_override[String!]!The fields that connected boards are allowed to override: settings, title, description.
cannot_deleteBoolean!When true, the column cannot be deleted.
messagesJSONUser-facing messages explaining why specific actions are disabled. Returns null if not set.
read_onlyBoolean!When true, the column is read-only for boards.

ObjectSchemaColumnTags

Status tags that indicate the current state of a column within an object schema.

FieldTypeDescription
deprecatedJSONDeprecation metadata, including a start timestamp. Returns null if the column is not deprecated.
inheritedBooleanWhen true, the column is inherited from a parent object schema.
opt_in_by_defaultJSONOpt-in metadata, including an optional end timestamp. Returns null if the column uses opt-out behavior.

ObjectSchemaActionResult

Represents the result of a single action executed within a bulk_object_schema_column_actions mutation.

FieldTypeDescription
actionObjectSchemaAction!The action type that was performed.
object_schemaObjectSchema!The state of the object schema after the action was applied.

BoardConnection

Represents the connection between a board and an object schema, returned by the connect_board_to_object_schema mutation.

FieldTypeDescription
idID!The board's unique identifier.
object_schema_idIDThe unique identifier of the connected object schema. Returns null if the board is not connected to a schema.

BulkDetachBoardResult

Represents the result of a single detach operation within a detach_boards_from_object_schema mutation.

FieldTypeDescription
board_idID!The unique identifier of the board that was detached.
errorStringThe error message if the detach operation failed. Returns null on success.
successBoolean!When true, the board was successfully detached.

CreateObjectSchemaColumnInput

Input type for creating a new column on an object schema.

FieldTypeDescription
defaultsJSONType-specific configuration for the column (e.g. labels for a status column).
descriptionStringThe column's description.
opt_out_by_defaultBooleanWhen true, connected boards opt out of this column by default. The default is false (opt-in).
policyColumnPolicyInput!The policy rules for this column.
titleString!The column's display title.
typeColumnType!The column's type.

UpdateObjectSchemaColumnInput

Input type for updating an existing column on an object schema.

FieldTypeDescription
column_idID!The unique identifier of the column to update.
defaultsJSONUpdated type-specific configuration for the column.
descriptionStringThe updated column description.
opt_out_by_defaultBooleanUpdated opt-out behavior for the column.
policyColumnPolicyInputUpdated policy rules for the column.
titleStringThe updated column title.

ColumnPolicyInput

Input type for defining a column's policy rules.

FieldTypeDescription
can_override[CanOverrideField!]!The fields that connected boards are allowed to override.
cannot_deleteBoolean!When true, prevents boards from deleting this column.
messagesPolicyMessagesInputUser-facing messages explaining why specific actions are disabled on connected boards.

PolicyMessagesInput

Input type for configuring user-facing messages on a column policy.

FieldTypeDescription
disabled_reasonDisabledReasonInputMessages explaining why specific column actions are disabled.

DisabledReasonInput

Input type for per-action disabled reason messages displayed to board users.

FieldTypeDescription
deleteStringReason why the column cannot be deleted.
edit_descriptionStringReason why the column description cannot be edited.
edit_labelsStringReason why the column labels cannot be edited.
edit_labels_positions_v2StringReason why the column label positions cannot be edited.
edit_settingsStringReason why the column settings cannot be edited.
edit_titleStringReason why the column title cannot be edited.

ObjectSchemaActionInput

Input type for a single action within the bulk_object_schema_column_actions mutation.

FieldTypeDescription
actionObjectSchemaAction!The type of action to execute.
create_object_schema_columnsCreateObjectSchemaColumnsActionInputThe columns to create. Required when action is CREATE_OBJECT_SCHEMA_COLUMNS.
delete_object_schema_columnsDeleteObjectSchemaColumnsActionInputThe column IDs to delete. Required when action is DELETE_OBJECT_SCHEMA_COLUMNS.
update_object_schema_columnsUpdateObjectSchemaColumnsActionInputThe column updates to apply. Required when action is UPDATE_OBJECT_SCHEMA_COLUMNS.

CreateObjectSchemaColumnsActionInput

Input type for the create columns action within a bulk operation.

FieldTypeDescription
columns[CreateObjectSchemaColumnInput!]!An array of column definitions to create.

UpdateObjectSchemaColumnsActionInput

Input type for the update columns action within a bulk operation.

FieldTypeDescription
columns[UpdateObjectSchemaColumnInput!]!An array of column updates to apply.

DeleteObjectSchemaColumnsActionInput

Input type for the delete columns action within a bulk operation.

FieldTypeDescription
column_ids[ID!]!An array of column IDs to delete.

ObjectSchemaAction

Enum of supported action types for bulk_object_schema_column_actions.

Enum ValueDescription
CREATE_OBJECT_SCHEMA_COLUMNSCreates columns on the object schema.
DELETE_OBJECT_SCHEMA_COLUMNSDeletes columns from the object schema.
UPDATE_OBJECT_SCHEMA_COLUMNSUpdates columns on the object schema.

ColumnActiveStateAction

Enum of supported actions for set_object_schema_column_active_state.

Enum ValueDescription
DEACTIVATEDeprecates the column on the object schema.
REACTIVATERestores a previously deprecated column.

CanOverrideField

Enum of fields that connected boards are permitted to override on a schema column.

Enum ValueDescription
descriptionBoards can override the column's description.
settingsBoards can override the column's type-specific settings.
titleBoards can override the column's display title.