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).

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

🚧

Only available in API versions 2026-10 and later

Returned by activity_log on Board. Fields are not yet documented here.


ExportAsyncJob

🚧

Only available in API versions 2026-10 and later

Returned by create_board_export. Poll export_job_status with the job's job_id until the status is COMPLETED, FAILED, or CANCELLED. fetch_export_job_status is a deprecated alias reachable only on dev. Fields are not yet documented here.


ExportFile

🚧

Only available in API versions 2026-10 and later

A completed board export, ready to download. Returned as one branch of ExportResult when the export finished within the synchronous window.

FieldTypeDescription
download_urlStringPresigned URL to download the exported file. Treat it as a secret — anyone holding it can download the file until it expires.
expires_atStringWhen download_url stops working, as an ISO 8601 timestamp. The URL cannot be refreshed; call the mutation again for a new one.

ExportOptionsInput

🚧

Only available in API versions 2026-10 and later

Optional export configuration, passed to create_board_export. Every field is optional; omitting the whole object exports the board with the defaults below.

FieldTypeDefaultDescription
include_subitemsBooleanfalseInclude subitems in the export.
include_item_identifiersBooleanfalseAppend item_id — and parent_item_id when include_subitems is true — as the last columns. Needed to match exported rows back to items.
header_rowHeaderFormatCOLUMN_IDWhether the header row uses column titles or column IDs. Defaults to COLUMN_ID when omitted.
non_importable_columnsNonImportableColumnsINCLUDEWhat to do with columns that cannot be read back in on import.
people_column_formatPeopleColumnFormatOutput format for people column values. Omit to keep the raw ID form.
connected_item_column_formatConnectedItemColumnFormatNAMEWhether connected items (Connect boards) render as names or IDs.

ExportResult

🚧

Only available in API versions 2026-10 and later

A union returned by create_board_export. It is either a finished export you can download immediately, or a reference to a job that is still running.

union ExportResult = ExportAsyncJob | ExportFile

The server decides which member to return based on board size and current load. Which branch you get is not part of the contract and can change without notice, so your query must handle both. Select both members with inline fragments:

mutation {
  create_board_export(board_id: 1234567890) {
    ... on ExportFile {
      download_url
      expires_at
    }
    ... on ExportAsyncJob {
      job_id
    }
  }
}
MemberMeaning
ExportFileThe export already finished. Use download_url right away.
ExportAsyncJobThe export is still running. Poll export_job_status with job_id until it is terminal.

There is no error member. Problems surface either as a GraphQL error (if the request is rejected before the export starts) or as a FAILED status on export_job_status (if it fails after starting).


HeaderFormat

🚧

Only available in API versions 2026-10 and later

Format of the header row in an exported file. Used by ExportOptionsInput.header_row.

ValueDescription
TITLEUse column titles as headers. Human-readable, but titles are not unique and can be renamed at any time.
COLUMN_IDUse column IDs as headers. Stable identifiers — use this when the file will be re-imported or processed by a script.

NonImportableColumns

🚧

Only available in API versions 2026-10 and later

How to handle columns whose values cannot be read back in on import. Used by ExportOptionsInput.non_importable_columns.

ValueDescription
INCLUDEExport these columns anyway, using their standard rendering. Best for reporting, where you want every value.
SKIPOmit these columns from the file entirely. Best when the file is meant to be imported back in cleanly.
ERRORFail the export if any such column would be included. Use when a silently lossy export would be worse than none.

ConnectedItemColumnFormat

🚧

Only available in API versions 2026-10 and later

Output format for connected items (Connect boards) column values. Used by ExportOptionsInput.connected_item_column_format.

ValueDescription
NAMEUse the linked items' display names (e.g. Task A, Task B). This is the default.
IDUse the linked items' IDs (e.g. 111, 222). Use this when the export needs to be joined back to items.

PeopleColumnFormat

🚧

Only available in API versions 2026-10 and later

Output format for people column values. Used by ExportOptionsInput.people_column_format.

ValueDescription
NAMEUse display names (e.g. Jordan Lee, Marketing Team) instead of the raw ID form (e.g. user:123).

Omit the option entirely to keep the raw ID form, which is what you want if the values need to be resolved back to specific users or teams.


ExportJobStatusInfo

🚧

Only available in API versions 2026-10 and later

The current state of an async board export job. Returned by export_job_status.

FieldTypeDescription
statusExportJobStatusCurrent status of the job. COMPLETED, FAILED, and CANCELLED are terminal — stop polling when you see one.
download_urlStringPresigned download URL. Populated only while status is COMPLETED and the URL has not expired; it becomes null afterwards. Run the export again to get a fresh one.
failure_reasonExportFailureReasonStructured reason the job failed. Populated only when status is FAILED. Branch on this rather than on failure_message.
failure_messageStringHuman-readable error detail, when the failure exposes text that is safe to show. Populated only when status is FAILED, and may be null even then.

Note that a COMPLETED job can still return a null download_url if you poll after the URL has expired, so check for null before using it.


ExportJobStatus

🚧

Only available in API versions 2026-10 and later

Lifecycle status of an async board export job. Used by ExportJobStatusInfo.status.

ValueTerminalDescription
RUNNINGNoThe export is still in progress. Keep polling.
COMPLETEDYesThe export finished successfully. Read download_url.
FAILEDYesThe export failed. Read failure_reason, and failure_message when present.
CANCELLEDYesThe export was cancelled.

Treat any unrecognized value as terminal so a future addition cannot leave your client polling forever.


ExportFailureReason

🚧

Only available in API versions 2026-10 and later

Structured reason an async board export job failed. Used by ExportJobStatusInfo.failure_reason.

ValueRetryableDescription
BOARD_UNAVAILABLENoThe board was deleted or archived.
BOARD_INACCESSIBLENoThe caller lost permission to read the board.
ITEM_LIMIT_EXCEEDEDNoThe board has more items than the export limit allows.
INVALID_REQUESTNoThe request was rejected during validation — for example, an unsupported combination of export options. Fix the request before retrying.
NOT_FOUNDNoThe board, or something it referenced, could not be found.
INTERNAL_ERRORYesAn unexpected internal error occurred. Retrying the mutation is reasonable.