Items Methods

Method Name	Method Type	Description
`get_item_ids_from_group(board_id, group_id)`	Getter	Retrieves all item IDs from a specific group.
`get_items_page_from_group(board_id, group_id, columns)`	Getter	Retrieves items from a specific group.
`get_items_from_column(board_id, column_id, value, columns)`	Getter	Retrieves items filtered by a column value.
`get_items_with_status(board_id, group_id, columns, column_id, index_value)`	Getter	Retrieves items with a specific status.
`get_items_page_between_dates(board_id, group_id, columns, column_id, start_date, end_date)`	Getter	Retrieves items between a date range (Timeline).
`get_items_page_between_date(board_id, group_id, columns, column_id, start_date, end_date)`	Getter	Retrieves items between a date range (Date column).
`get_item_ids_between_dates(board_id, group_id, column_id, start_date, end_date)`	Getter	Retrieves item IDs between a date range (Timeline).
`get_item_ids_between_date(board_id, group_id, column_id, start_date, end_date)`	Getter	Retrieves item IDs between a date range (Date column).
`get_item_columns(item_list, column_id_list)`	Getter	Retrieves column values for a list of items.
`get_items_by_column_values(board_id, column_filters, limit)`	Getter	Retrieves items matching specified column values.
`create_item(board, group, item_name)`	Setter	Creates a new item in a group.
`create_item_with_column_values(board, group, item_name, column_dict)`	Setter	Creates an item with specified column values.
`archive_item(item_id)`	Setter	Archives an item on a board.
`duplicate_item(board_id, item_id, with_updates)`	Setter	Duplicates an item with optional updates.
`move_item_to_board(item_id, target_board_id, target_group_id, column_mapping)`	Setter	Moves an item to another board.
`delete_item(item_id)`	Deleter	Deletes an item from the platform.

Method Details

get_item_ids_from_group()

get_item_ids_from_group(board_id, group_id)

Description: Retrieves all item IDs from a specific group on a board.

Arguments:

board_id (int): The ID of the board.
group_id (str): The ID of the group.

Returns: - List of item IDs (list of int). Returns None or an error message if the request fails.

Example:

item_ids = monday.items.get_item_ids_from_group(board_id=123456789, group_id="group_abc")

get_items_page_from_group()

get_items_page_from_group(board_id, group_id, columns)

Description: Retrieves items from a specific group in a board.

Arguments:

board_id (int): The ID of the board.
group_id (str): The ID of the group.
columns (list of str): List of column IDs to retrieve values from.

Returns: - List of item dictionaries containing item details. Returns None or an error message if the request fails.

Example:

items = monday.items.get_items_page_from_group(board_id=123456789, 
                                               group_id="group_abc", 
                                               columns=["mirror1", "connect_boards0"])

get_items_from_column()

get_items_from_column(board_id, column_id, value, columns)

Description: Retrieves items from a board filtered by a specific column value.

Arguments:

board_id (int): The ID of the board.
column_id (str): The column ID to filter by.
value (str | int | list): The value to filter items by.
columns (list of str): List of column IDs to retrieve values from.

Returns: - List of items matching the filter. Returns None or an error message if the request fails.

Example:

filtered_items = monday.items.get_items_from_column(board_id=123456789, 
                                                    column_id="status", 
                                                    value="Confirmed", 
                                                    columns=["mirror1", "connect_boards0"])

get_items_with_status()

get_items_with_status(board_id, group_id, columns, column_id, index_value)

Description: Retrieves items from a specific group where a column matches a given status.

Arguments:

board_id (int): The ID of the board.
group_id (str): The ID of the group.
columns (list of str): List of column IDs to retrieve values from.
column_id (str): The column to filter items by.
index_value (int): The status to match.

Returns: - List of items that match the status filter. Returns None or an error message if the request fails.

Example:

status_items = monday.items.get_items_with_status(board_id=123456789, 
                                                  group_id="group_abc", 
                                                  columns=["text1", "country1"], 
                                                  column_id=["status2"], 
                                                  index_value=2)

get_items_page_between_dates()

get_items_page_between_dates(board_id, group_id, columns, column_id, start_date, end_date)

Description: Retrieves items from a board within a specific date range using a Timeline column.

Arguments:

board_id (int): The ID of the board.
group_id (str): The ID of the group.
columns (list of str): List of column IDs to retrieve values from.
column_id (str): The Timeline column ID.
start_date (str, YYYY-MM-DD format): The start of the date range.
end_date (str, YYYY-MM-DD format): The end of the date range.

Returns: - List of items that fall within the specified date range. Returns None or an error message if the request fails.

Example:

items_between_dates = monday.items.get_items_page_between_dates(board_id=123456789, 
                                                                group_id="group_abc", 
                                                                columns=["status", "priority"], 
                                                                column_id="timeline", 
                                                                start_date="2024-01-01", 
                                                                end_date="2024-02-01")

get_items_page_between_date()

get_items_page_between_date(board_id, group_id, columns, column_id, start_date, end_date)

Description: Retrieves items from a board within a specific date range using a Date column.

Arguments:

board_id (int): The ID of the board.
group_id (str): The ID of the group.
columns (list of str): List of column IDs to retrieve values from.
column_id (str): The Date column ID.
start_date (str, YYYY-MM-DD format): The start of the date range.
end_date (str, YYYY-MM-DD format): The end of the date range.

Returns: - List of items that fall within the specified date range. Returns None or an error message if the request fails.

Example:

items_between_dates = monday.items.get_items_page_between_date(board_id=123456789, 
                                                               group_id="group_abc", 
                                                               columns=["status", "priority"], 
                                                               column_id="date1", 
                                                               start_date="2024-01-01", 
                                                               end_date="2024-02-01")

get_item_ids_between_dates()

get_item_ids_between_dates(board_id, group_id, column_id, start_date, end_date)

Description: Retrieves item IDs between a specified date range using a Timeline column.

Arguments:

board_id (int): ID of the board.
group_id (str): ID of the group.
column_id (str): ID of the timeline column.
start_date (str, YYYY-MM-DD format): Start date of the date range.
end_date (str, YYYY-MM-DD format): End date of the date range.

Returns: List of item IDs within the specified date range. None or error message on API call failure.

Example:

item_ids = monday.items.get_item_ids_between_dates(board_id=123456789, 
                                                   group_id="group_abc", 
                                                   column_id="timeline_column", 
                                                   start_date="2024-01-01", 
                                                   end_date="2024-02-01")

get_item_ids_between_date()

get_item_ids_between_date(board_id, group_id, column_id, start_date, end_date)

Description: Retrieves item IDs between a specified date range using a Date column.

Arguments:

board_id int: ID of the board.
group_id str: ID of the group.
column_id str: ID of the date column.
start_date str, YYYY-MM-DD format: Start date.
end_date str, YYYY-MM-DD format: End date.

Returns: List of item IDs within the specified date range. None or error message on API call failure.

Example:

item_ids = monday.items.get_item_ids_between_date(board_id=123456789, 
                                                  group_id="group_abc", 
                                                  column_id="date1", 
                                                  start_date="2024-01-01", 
                                                  end_date="2024-02-01")

get_item_columns()

get_item_columns(item_list, column_id_list)

Description: Retrieves column values for a list of items.

Arguments:

item_list (list of int): List of item IDs.
column_id_list (list of str): List of column IDs to retrieve values for.

Returns: List of dictionaries containing item IDs and their respective column values. None or error message on API call failure.

Example:

item_columns = monday.items.get_item_columns(item_list=[123456789, 1234567890], 
                                             column_id_list=["status", "text"])

get_items_by_column_values()

get_items_by_column_values(board_id, column_filters, limit)

Description: Retrieves items from a board that match specified column values.

Arguments:

board_id (int): ID of the board.
column_filters (list of dict): List of dictionaries with column_id, and column_values (for supported columns see https://developer.monday.com/api-reference/reference/items-page-by-column-values).
limit (int): Maximum number of items to retrieve. Defaults to 100.

Returns: List of matching items. None or error message on API call failure.

Example:

items = monday.items.get_items_by_column_values(board_id=123456789, 
                                                column_filters =[
                                                    {"column_id": "status1", "column_values": ["In Progress"]},
                                                    {"column_id": "text1", "column_values": ["ABCD123"]}
                                                ],
                                                limit=50)

create_item()

create_item(board, group, item_name)

Description: Creates a new item within a group on a board.

Arguments:

board_id (int): ID of the board.
group_id (str): ID of the group.
item_name (str): Name of the new item.

Returns: UUID of the newly created item. None or error message on API call failure.

Example:

new_item_id = monday.items.create_item(123456789, "group_abc", "New Task")

create_item_with_column_values()

create_item_with_column_values(board, group, item_name, column_dict)

Description: Creates a new item within a group on a board and populates specific column values.

Arguments:

board_id (int): ID of the board.
group_id (str): ID of the group.
item_name (str): Name of the new item.
column_dict (dict): Dictionary of column values to set when the item is created.

Returns: UUID of the newly created item. None or error message on API call failure.

Example:

new_item = monday.items.create_item_with_column_values(board_id=123456789, 
                                                       group_id="group_abc", 
                                                       item_name="New Task", 
                                                       column_dict={
                                                           "text1": {"type": "text", "values": ["Task description"]},
                                                           "status1": {"type": "status", "values": ["Pending"]}
                                                       })

archive_item()

archive_item(item_id)

Description: Archives an item on a board.

Arguments:

item_id: (int): The unique identifier of the item to archive.

Returns: True if the item was successfully archived. Returns None or an error message if the request fails.

Example:

success = monday.items.archive_item(123456789)

duplicate_item()

duplicate_item(board_id, item_id, with_updates)

Description: Duplicates an item, including its updates if specified.

Arguments:

board_id (int): The unique identifier of the board where the item exists.
item_id (int): The unique identifier of the item to duplicate.
with_updates (bool): Boolean indicating whether to include updates in the duplication. Defaults to True.

Returns: The UUID of the duplicated item. Returns None or an error message if the request fails.

Example:

duplicated_item_id = monday.items.duplicate_item(board_id=123456789,
                                                item_id=987654321,
                                                 with_updates=True)

move_item_to_board()

move_item_to_board(item_id, target_board_id, target_group_id, column_mapping)

Description: Moves an item to another board with optional column mapping.

Arguments:

item_id: (int): The ID of the item to move.
target_board_id: (int): The ID of the destination board.
target_group_id: (str): The ID of the group within the target board.
column_mapping: (dict): (Optional) Dictionary mapping source columns to target columns.

Returns: The UUID of the moved item. Returns None or an error message if the request fails.

Example:

moved_item_id = monday.items.move_item_to_board(item_id=987654321, 
                                                target_board_id=123456789, 
                                                target_group_id="group_abc", 
                                                column_mapping={"status": "status_new"})

delete_item()

delete_item(item_id)

Description: Deletes an item from the platform.

Arguments:

item_id: (int): The unique identifier of the item to delete.

Returns: True if the item was successfully deleted. Returns None or an error message if the request fails.

Example:

delete_success = monday.items.delete_item(123456789)