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.
| Field | Type | Description |
|---|---|---|
| plural | String | The plural form of the item nickname |
| preset_type | String | The preset type for item nickname. |
| singular | String | The singular form of the item nickname. |
item_nickname
Only available in version
2026-04and 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\"}"
)
}| Field | Type | Description |
|---|---|---|
| plural | String | The plural form of the item nickname |
| preset_type | String | The preset type for item nickname. |
| singular | String | The singular form of the item nickname. |
SetBoardPermissionResponse
An object containing the result of setting a board's permissions via the API.
| Field | Type | Description | Enum Values |
|---|---|---|---|
| edit_permissions | BoardEditPermissions! | Specifies which group of users is allowed to edit the board’s content. This setting reflects the board's technical editing permissions. | assigneecollaboratorseveryoneowners |
| 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
| Field | Type | Description | Enum 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.
| Field | Type | Description | Enum Values |
|---|---|---|---|
| team_id | ID! | The ID of the team that could not be updated. | |
| error | String! | 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
| Field | Type | Description | Enum 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.
| Field | Type | Description | Enum Values |
|---|---|---|---|
| user_id | ID! | The ID of the user that could not be updated. | |
| error | String! | The reason the update failed for this user. |
UpdateBoardHierarchyAttributesInput
An object containing the board's attributes to update.
| Field | Type | Description |
|---|---|---|
| account_product_id | ID | The board's updated account product ID. You must also provide the relevant workspace_id within the updated product. |
| folder_id | ID | The board's updated folder ID. |
| position | DynamicPosition | The board's updated position in the left-side menu. |
| workspace_id | ID | The board's updated workspace ID. |
Dynamic position
An object containing the board's updated position in the left-side menu of the platform.
| Field | Type | Description | Enum Values |
|---|---|---|---|
| is_after | Boolean | Specifies where to position the target board relative to the reference object:
| |
| object_id | String! | The unique identifier of the reference object that the target board should be positioned relative to. | |
| object_type | ObjectType! | The type of the reference object. | BoardFolderOverview |
UpdateBoardHierarchyResult
An object containing the result of updating a board's position, product, or workspace.
| Field | Type | Description |
|---|---|---|
| board | Board | The updated board. |
| message | String | A message about the operation's result. |
| success | Boolean! | Whether the operation was successful. |
BoardInferredMetadata
Only available in API versions
2026-07and later
Optional metadata inferred for a board (for example, how items are referred to in context).
| Field | Type | Description |
|---|---|---|
| item_type | String | Custom terminology label for items on this board (when set). |
BoardManualMetadata
Only available in API versions
2026-07and later
Optional metadata supplied explicitly for a board.
| Field | Type | Description |
|---|---|---|
| board_md | String | Markdown content describing the board. |
BoardActivityLogsPage
Returned by
Board.activity_logsfrom API version2027-01
Returned by activity_logs on Board. A page of the board's activity log entries.
| Field | Type | Description |
|---|---|---|
| logs | [ActivityLog!] | The activity log entries for this page. |
| cursor | String | The 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-01and later
The dependency cycles found on a board. Returned by board_dependency_cycles.
| Field | Type | Description |
|---|---|---|
| board_id | ID | The ID of the board. |
| cycles | [DependencyCycle!] | The cycles found. An empty list means the board was checked and is clean. |
| truncated | Boolean | Returns true when more cycles exist than the reporting cap allows. |
DependencyCycle
Only available in API versions
2027-01and later
A single cycle in the board dependency graph. Used by BoardDependencyCyclesResult.cycles.
| Field | Type | Description |
|---|---|---|
| path | [CycleEdge!] | The ordered items forming the cycle. |
CycleEdge
Only available in API versions
2027-01and later
One item in a cycle, with the predecessor that links to it. Used by DependencyCycle.path.
| Field | Type | Description |
|---|---|---|
| item_id | ID | The item that is part of the cycle. |
| predecessor_id | ID | The item that this item depends on within the cycle. |
| type | CycleEdgeType | The link type. Returns null when the stored edge type is unrecognized. |
CycleEdgeType
Only available in API versions
2027-01and later
The type of link between two items inside a cycle. Used by CycleEdge.type.
| Value | Description |
|---|---|
FS | Finish to Start: the item can start only after its predecessor finishes. |
SS | Start to Start: the item can start only after its predecessor starts. |
FF | Finish to Finish: the item can finish only after its predecessor finishes. |
SF | Start to Finish: the item can finish only after its predecessor starts. |
HIERARCHY | A parent/subitem link rather than a dependency. |
