Boards Methods

Method Name Method Type Description
get_all_boards() Getter Retrieves all boards from the platform.
get_board_info(board_id) Getter Retrieves details of a specific board, including name, state, permissions, type, and workspace.
get_board_groups(board_id) Getter Retrieves all groups within a specified board.
get_board_from_item(item_id) Getter Retrieves the board ID for a given item.
get_board_views(board_id) Getter Retrieves all views associated with a board.
create_board(board_name, board_type, workspace_id) Setter Creates a new board in a specified workspace.
update_board_description(board_id, description) Setter Updates the description of a board.
duplicate_board(board_id, duplicate_type, board_name, keep_subscribers, workspace_id, folder_id) Setter Duplicates an existing board with optional parameters for structure, pulses, updates, and new workspace location.
delete_board(board_id) Deleter Deletes a specified board.
archive_board(board_id) Deleter Archives a board instead of deleting it.

Method Details

get_all_boards()

get_all_boards()

Description: Retrieves all boards from the platform.

Returns: A dictionary containing board IDs and names, None or an error message if the API call fails.

Example: 

boards = monday.boards.get_all_boards()

get_board_info()

get_board_info(board_id)

Description: Retrieves details of a board, including its name, state, permissions, type, and workspace ID.

Arguments:

  • board_id (int): The ID of the board.

Returns: A dictionary containing board details. None or an error message if the API call fails.

Example: 

board_info = monday.boards.get_board_info(1234567890)

get_board_groups()

get_board_groups(board_id)

Description: Retrieves all groups within a specific board.

Arguments:

  • board_id (int): The ID of the board.

Returns: A dictionary containing group IDs and names. None or an error message if the API call fails.

Example: 

groups = monday.boards.get_board_groups(1234567890)

get_board_from_item()

get_board_from_item(item_id)

Description: Retrieves the board ID where a specific item is located.

Arguments:

  • item_id (int): The ID of the item.

Returns: A dictionary containing the board ID and name. None or an error message if the API call fails.

Example: 

board = monday.boards.get_board_from_item(987654321)

get_board_views()

get_board_views(board_id)

Description: Retrieves all views associated with a board.

Arguments:

  • board_id (int): The ID of the board.

Returns: A list of views. None or an error message if the API call fails.

Example: 

views = monday.boards.get_board_views(1234567890)

create_board()

create_board(board_name, board_type, workspace_id)

Description: Creates a new board in a specified workspace.

Arguments:

  • board_name (str): The name of the board.
  • board_type (str): The board's visibility (public, private, or share).
  • workspace_id (int): The ID of the workspace where the board should be created.

Returns: The newly created board's ID. None or an error message if the API call fails.

Example: 

new_board_id = monday.boards.create_board("Project Board", "private", 11223344)

update_board_description()

update_board_description(board_id, description)

Description: Updates the description of a board.

Arguments:

  • board_id (int): The ID of the board to update.
  • description (str): The new description text.

Returns: The response from the API, None or an error message if the API call fails.

Example: 

response = monday.boards.update_board_description(1234567890, "Updated board description")

duplicate_board()

duplicate_board(board_id, duplicate_type, board_name, keep_subscribers, workspace_id, folder_id)

Description: Duplicates a board with various options.

Arguments:

  • board_id (int): The ID of the board to duplicate.
  • duplicate_type (str): The duplication type (duplicate_board_with_structure, duplicate_board_with_pulses, duplicate_board_with_pulses_and_updates).
  • board_name (str, optional): New name for the duplicated board.
  • keep_subscribers (bool, optional): Whether to duplicate the board subscribers.
  • workspace_id (int, optional): The workspace ID where the duplicated board should be placed.
  • folder_id (int, optional): The folder ID within the workspace (if applicable).

Returns: The new board ID. None an error message if the API call fails.

Example: 

duplicated_board_id = monday.boards.duplicate_board(board_id=1234567890, duplicate_type="duplicate_board_with_pulses", board_name="Duplicated Board", keep_subscribers=True, workspace_id=11223344)

delete_board()

delete_board(board_id)

Description: Deletes a specified board.

Arguments:

  • board_id (int): The ID of the board to be deleted.

Returns: True if deletion is successful. None or an error message if the API call fails.

Example: 

is_deleted = monday.boards.delete_board(1234567890)

archive_board()

archive_board(board_id)

Description: Archives a board instead of deleting it.

Arguments:

  • board_id (int): The ID of the board to archive.

Returns: True if archiving is successful. None or an error message if the API call fails.

Example: 

is_archived = monday.boards.archive_board(1234567890)