ClickUp Integration
Overview
Section titled “Overview”Enable your agents to manage tasks, projects, and productivity workflows through ClickUp. Create and update tasks, organize projects, manage team assignments, and streamline your productivity management with AI-powered automation.
Prerequisites
Section titled “Prerequisites”Before using the ClickUp integration, ensure you have:
- A CrewAI AMP account with an active subscription
- A ClickUp account with appropriate permissions
- Connected your ClickUp account through the Integrations page
Setting Up ClickUp Integration
Section titled “Setting Up ClickUp Integration”1. Connect Your ClickUp Account
Section titled “1. Connect Your ClickUp Account”- Navigate to CrewAI AMP Integrations
- Find ClickUp in the Authentication Integrations section
- Click Connect and complete the OAuth flow
- Grant the necessary permissions for task and project management
- Copy your Enterprise Token from Integration Settings
2. Install Required Package
Section titled “2. Install Required Package”uv add crewai-tools3. Environment Variable Setup
Section titled “3. Environment Variable Setup”export CREWAI_PLATFORM_INTEGRATION_TOKEN="your_enterprise_token"Or add it to your .env file:
CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_tokenAvailable Actions
Section titled “Available Actions”clickup/search_tasks
Description: Search for tasks in ClickUp using advanced filters.
Parameters:
taskFilterFormula(object, optional): A filter in disjunctive normal form - OR of AND groups of single conditions.Available fields:{"operator": "OR","conditions": [{"operator": "AND","conditions": [{"field": "statuses%5B%5D","operator": "$stringExactlyMatches","value": "open"}]}]}space_ids%5B%5D,project_ids%5B%5D,list_ids%5B%5D,statuses%5B%5D,include_closed,assignees%5B%5D,tags%5B%5D,due_date_gt,due_date_lt,date_created_gt,date_created_lt,date_updated_gt,date_updated_lt
clickup/get_task_in_list
Description: Get tasks in a specific list in ClickUp.
Parameters:
listId(string, required): List - Select a List to get tasks from. Use Connect Portal User Settings to allow users to select a ClickUp List.taskFilterFormula(string, optional): Search for tasks that match specified filters. For example: name=task1.
clickup/create_task
Description: Create a task in ClickUp.
Parameters:
listId(string, required): List - Select a List to create this task in. Use Connect Portal User Settings to allow users to select a ClickUp List.name(string, required): Name - The task name.description(string, optional): Description - Task description.status(string, optional): Status - Select a Status for this task. Use Connect Portal User Settings to allow users to select a ClickUp Status.assignees(string, optional): Assignees - Select a Member (or an array of member IDs) to be assigned to this task. Use Connect Portal User Settings to allow users to select a ClickUp Member.dueDate(string, optional): Due Date - Specify a date for this task to be due on.additionalFields(string, optional): Additional Fields - Specify additional fields to include on this task as JSON.
clickup/update_task
Description: Update a task in ClickUp.
Parameters:
taskId(string, required): Task ID - The ID of the task to update.listId(string, required): List - Select a List to create this task in. Use Connect Portal User Settings to allow users to select a ClickUp List.name(string, optional): Name - The task name.description(string, optional): Description - Task description.status(string, optional): Status - Select a Status for this task. Use Connect Portal User Settings to allow users to select a ClickUp Status.assignees(string, optional): Assignees - Select a Member (or an array of member IDs) to be assigned to this task. Use Connect Portal User Settings to allow users to select a ClickUp Member.dueDate(string, optional): Due Date - Specify a date for this task to be due on.additionalFields(string, optional): Additional Fields - Specify additional fields to include on this task as JSON.
clickup/delete_task
Description: Delete a task in ClickUp.
Parameters:
taskId(string, required): Task ID - The ID of the task to delete.
clickup/get_list
Description: Get List information in ClickUp.
Parameters:
spaceId(string, required): Space ID - The ID of the space containing the lists.
clickup/get_custom_fields_in_list
Description: Get Custom Fields in a List in ClickUp.
Parameters:
listId(string, required): List ID - The ID of the list to get custom fields from.
clickup/get_all_fields_in_list
Description: Get All Fields in a List in ClickUp.
Parameters:
listId(string, required): List ID - The ID of the list to get all fields from.
clickup/get_space
Description: Get Space information in ClickUp.
Parameters:
spaceId(string, optional): Space ID - The ID of the space to retrieve.
clickup/get_folders
Description: Get Folders in ClickUp.
Parameters:
spaceId(string, required): Space ID - The ID of the space containing the folders.
clickup/get_member
Description: Get Member information in ClickUp.
Parameters: None required.
Usage Examples
Section titled “Usage Examples”Basic ClickUp Agent Setup
Section titled “Basic ClickUp Agent Setup”from crewai import Agent, Task, Crewfrom crewai import Agent, Task, Crew
# Create an agent with Clickup capabilitiesclickup_agent = Agent( role="Task Manager", goal="Manage tasks and projects in ClickUp efficiently", backstory="An AI assistant specialized in task management and productivity coordination.", apps=['clickup'] # All Clickup actions will be available)
# Task to create a new taskcreate_task = Task( description="Create a task called 'Review Q1 Reports' in the Marketing list with high priority", agent=clickup_agent, expected_output="Task created successfully with task ID")
# Run the taskcrew = Crew( agents=[clickup_agent], tasks=[create_task])
crew.kickoff()Filtering Specific ClickUp Tools
Section titled “Filtering Specific ClickUp Tools”task_coordinator = Agent( role="Task Coordinator", goal="Create and manage tasks efficiently", backstory="An AI assistant that focuses on task creation and status management.", apps=['clickup/create_task'])
# Task to manage task workflowtask_workflow = Task( description="Create a task for project planning and assign it to the development team", agent=task_coordinator, expected_output="Task created and assigned successfully")
crew = Crew( agents=[task_coordinator], tasks=[task_workflow])
crew.kickoff()Advanced Project Management
Section titled “Advanced Project Management”from crewai import Agent, Task, Crew
project_manager = Agent( role="Project Manager", goal="Coordinate project activities and track team productivity", backstory="An experienced project manager who ensures projects are delivered on time.", apps=['clickup'])
# Complex task involving multiple ClickUp operationsproject_coordination = Task( description=""" 1. Get all open tasks in the current space 2. Identify overdue tasks and update their status 3. Create a weekly report task summarizing project progress 4. Assign the report task to the team lead """, agent=project_manager, expected_output="Project status updated and weekly report task created and assigned")
crew = Crew( agents=[project_manager], tasks=[project_coordination])
crew.kickoff()Task Search and Management
Section titled “Task Search and Management”from crewai import Agent, Task, Crew
task_analyst = Agent( role="Task Analyst", goal="Analyze task patterns and optimize team productivity", backstory="An AI assistant that analyzes task data to improve team efficiency.", apps=['clickup'])
# Task to analyze and optimize task distributiontask_analysis = Task( description=""" Search for all tasks assigned to team members in the last 30 days, analyze completion patterns, and create optimization recommendations """, agent=task_analyst, expected_output="Task analysis report with optimization recommendations")
crew = Crew( agents=[task_analyst], tasks=[task_analysis])
crew.kickoff()Getting Help
Section titled “Getting Help”Need Help?
Contact our support team for assistance with ClickUp integration setup or troubleshooting.