Folders Methods

Method Name Method Type Description
get_folders(workspace_id) Getter Retrieves all folders in a workspace.
create_folder(name, workspace_id, **kwargs) Setter Creates a new folder in a workspace.
update_folder(folder_id, **kwargs) Setter Updates an existing folder in a workspace.
delete_folder(folder_id) Deleter Deletes a folder from a workspace.

Method Details

get_folders()

get_folders(workspace_id)

Description: Retrieves all folders in a workspace.

Arguments:

  • workspace_id (str): The UUID of the workspace.

Returns: Array of dictionaries containing folder data. Returns None or an error message on API call failure.

Example:

folders = monday.folders.get_folders("workspace_uuid")

create_folder()

create_folder(name, workspace_id, **kwargs)

Description: Creates a new folder in a workspace.

Arguments:

  • name (str): The name of the folder (required).
  • workspace_id (str): The unique identifier of the workspace (required).
  • color (str, optional): The folder's color.
  • parent_folder_id (str, optional): The ID of the folder to nest the new folder under (limited to 1 tier).

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

Example:

folder_id = monday.folders.create_folder("Project Docs", "workspace_uuid", color="#FF5733")

update_folder()

update_folder(folder_id, **kwargs)

Description: Updates an existing folder in a workspace.

Arguments:

  • folder_id (str): The UUID of the folder to update (required).
  • **kwargs: Keywords must be passed exactly as defined below. Folder colors can be found here: https://asset.cloudinary.com/monday-platform-dev/3e39afb2309b512f4f53cc9173554d48
  • name (str, optional): Updated name of the folder.
  • color (str, optional): Updated folder color.
  • parent_folder_id (str, optional): The ID of the folder to nest the updated folder under.

Returns: UUID of the updated folder. Returns None or an error message on API call failure.

Example:

updated_folder_id = monday.folders.update_folder(12345, name="Updated Folder Name")

delete_folder()

delete_folder(folder_id)

Description: Deletes a folder from a workspace.

Arguments:

  • folder_id (str): The UUID of the folder to delete.

Returns: True if successful. Returns None or an error message on API call failure.

Example:

deleted = monday.folders.delete_folder(12345)