Other types

Learn about other types supported by the boards APIs

The monday.com boards APIs enable you to create, read, update, and delete boards.

The types below are used by the boards queries and mutations, and are not independently queryable.

ItemNicknameInput

An object containing the item nickname.

FieldTypeDescription
pluralStringThe plural form of the item nickname
preset_typeStringThe preset type for item nickname.
singularStringThe singular form of the item nickname.

item_nickname

🚧

Only available in version 2026-04 and later

An enum value of board_attribute on update_board that allows you to modify a board’s item nickname.

mutation {
  update_board(
    board_id: 1234567890
    board_attribute: item_nickname
    new_value: "{\"preset_type\":\"other\",\"singular\":\"Task\",\"plural\":\"Tasks\"}"
  )
}
FieldTypeDescription
pluralStringThe plural form of the item nickname
preset_typeStringThe preset type for item nickname.
singularStringThe singular form of the item nickname.

SetBoardPermissionResponse

An object containing the result of setting a board's permissions via the API.

FieldTypeDescriptionEnum Values
edit_permissionsBoardEditPermissions!Specifies which group of users is allowed to edit the board’s content. This setting reflects the board's technical editing permissions.assignee
collaborators
everyone
owners
failed_actions[String!]Any actions that failed during the permission update process.

UpdateTeamsBoardRoleResponse

An object containing the result of the update_teams_board_role mutation.

Only available in API versions 2026-10 and later

FieldTypeDescriptionEnum Values
successful_team_ids[ID!]!The IDs of the teams whose board role was successfully updated.
failed_teams[FailedTeamBoardRoleUpdate!]!The teams whose board role could not be updated, with the reason for each failure.

FailedTeamBoardRoleUpdate

Represents a single team that failed to have its board role updated by update_teams_board_role.

FieldTypeDescriptionEnum Values
team_idID!The ID of the team that could not be updated.
errorString!The reason the update failed for this team (e.g., the team isn't subscribed to the board).

UpdateUsersBoardRoleResponse

An object containing the result of the update_users_board_role mutation.

Only available in API versions 2026-10 and later

FieldTypeDescriptionEnum Values
successful_user_ids[ID!]!The IDs of the users whose board role was successfully updated.
failed_users[FailedUserBoardRoleUpdate!]!The users whose board role could not be updated, with the reason for each failure.

FailedUserBoardRoleUpdate

Represents a single user that failed to have its board role updated by update_users_board_role.

FieldTypeDescriptionEnum Values
user_idID!The ID of the user that could not be updated.
errorString!The reason the update failed for this user.

UpdateBoardHierarchyAttributesInput

An object containing the board's attributes to update.

FieldTypeDescription
account_product_idIDThe board's updated account product ID. You must also provide the relevant workspace_id within the updated product.
folder_idIDThe board's updated folder ID.
positionDynamicPositionThe board's updated position in the left-side menu.
workspace_idIDThe board's updated workspace ID.

Dynamic position

An object containing the board's updated position in the left-side menu of the platform.

FieldTypeDescriptionEnum Values
is_afterBooleanSpecifies where to position the target board relative to the reference object:
  • Set to true to place the target after the reference
  • Set to false to place the target before the reference
object_idString!The unique identifier of the reference object that the target board should be positioned relative to.
object_typeObjectType!The type of the reference object.Board
Folder
Overview

UpdateBoardHierarchyResult

An object containing the result of updating a board's position, product, or workspace.

FieldTypeDescription
boardBoardThe updated board.
messageStringA message about the operation's result.
successBoolean!Whether the operation was successful.

BoardInferredMetadata

🚧

Only available in API versions 2026-07 and later

Optional metadata inferred for a board (for example, how items are referred to in context).

FieldTypeDescription
item_typeStringCustom terminology label for items on this board (when set).

BoardManualMetadata

🚧

Only available in API versions 2026-07 and later

Optional metadata supplied explicitly for a board.

FieldTypeDescription
board_mdStringMarkdown content describing the board.

BoardActivityLogsPage

🚧

Returned by Board.activity_logs from API version 2027-01

Returned by activity_logs on Board. A page of the board's activity log entries.

FieldTypeDescription
logs[ActivityLog!]The activity log entries for this page.
cursorStringThe cursor to pass to fetch the next page. null if this is the last page.

ExportAsyncJob

Moved to its own tab — see ExportAsyncJob in the Board Export reference.


ExportFile

Moved to its own tab — see ExportFile in the Board Export reference.


CreateBoardExportOptionsInput

Moved to its own tab — see CreateBoardExportOptionsInput in the Board Export reference.


ExportResult

Moved to its own tab — see ExportResult in the Board Export reference.


HeaderFormat

Moved to its own tab — see HeaderFormat in the Board Export reference.


ConnectedItemColumnFormat

Moved to its own tab — see ConnectedItemColumnFormat in the Board Export reference.


PeopleColumnFormat

Moved to its own tab — see PeopleColumnFormat in the Board Export reference.


ExportJobStatusInfo

Moved to its own tab — see ExportJobStatusInfo in the Board Export reference.


ExportJobStatus

Moved to its own tab — see ExportJobStatus in the Board Export reference.


ExportFailureReason

Moved to its own tab — see ExportFailureReason in the Board Export reference.


BoardDependencyCyclesResult

🚧

Only available in API versions 2027-01 and later

The dependency cycles found on a board. Returned by board_dependency_cycles.

FieldTypeDescription
board_idIDThe ID of the board.
cycles[DependencyCycle!]The cycles found. An empty list means the board was checked and is clean.
truncatedBooleanReturns true when more cycles exist than the reporting cap allows.

DependencyCycle

🚧

Only available in API versions 2027-01 and later

A single cycle in the board dependency graph. Used by BoardDependencyCyclesResult.cycles.

FieldTypeDescription
path[CycleEdge!]The ordered items forming the cycle.

CycleEdge

🚧

Only available in API versions 2027-01 and later

One item in a cycle, with the predecessor that links to it. Used by DependencyCycle.path.

FieldTypeDescription
item_idIDThe item that is part of the cycle.
predecessor_idIDThe item that this item depends on within the cycle.
typeCycleEdgeTypeThe link type. Returns null when the stored edge type is unrecognized.

CycleEdgeType

🚧

Only available in API versions 2027-01 and later

The type of link between two items inside a cycle. Used by CycleEdge.type.

ValueDescription
FSFinish to Start: the item can start only after its predecessor finishes.
SSStart to Start: the item can start only after its predecessor starts.
FFFinish to Finish: the item can finish only after its predecessor finishes.
SFStart to Finish: the item can finish only after its predecessor starts.
HIERARCHYA parent/subitem link rather than a dependency.