ClickUp Integration with SmythOS
Want to put your project management on autopilot? Connect ClickUp to SmythOS and empower your agents to create, update, and manage tasks and projects automatically.
List of ClickUp Components
Quickly compare ClickUp components by what they do and their key I/O. Click any component name to jump directly to its detailed guide.
Component | Action | What it Does | Inputs | Key Outputs | Use Case |
---|---|---|---|---|---|
Add Task | Write | Creates a new task in a specified list. | required list_id , name optional description | id , url | Automatically creating a task from a new email. |
Update Task | Write | Updates the properties of an existing task. | required task_id optional status , dates | id , url | Marking a task as "Complete" from another system. |
Get Task | Read | Retrieves the full details of a single task. | required task_id | id , name , status | Checking the status of a task before taking action. |
Get Tasks | Read | Retrieves a list of tasks from a specified list. | required list_id optional page | tasks | Generating a daily summary of all tasks in a list. |
Add Task To List | Write | Adds an existing task to an additional list. | required list_id , task_id | Response | Cross-listing a task in both a team and a personal list. |
Add Assignee To Task | Write | Assigns a user to a specific task. | required task_id , assignee_id | assignees | Auto-assigning tasks based on a round-robin system. |
Delete Task | Write | Permanently deletes a task. | required task_id | Response | Cleaning up automatically created tasks. |
Get Lists | Read | Retrieves all Lists within a specific Folder. | required folder_id | lists | Finding the correct List ID to create a task in. |
Prerequisites
Before you begin, please ensure you have the following:
- An active SmythOS account. (Sign up here).
- A ClickUp account.
- Your personal ClickUp API Token.
Getting Started With ClickUp
The connection between SmythOS and ClickUp is configured using a secure, personal API Token.
Step 1: Get Your ClickUp API Token
- Log in to your ClickUp account.
- Click on your profile avatar in the bottom-left corner to open the User Menu.
- Select Apps.
- Your personal API Token is displayed at the top of this page. Click the Generate button if one doesn't exist, or click Copy to copy your existing token.
Step 2: Store Your API Token in SmythOS Vault
Your API Token is a sensitive credential. Use the SmythOS Vault
to store it securely.
- In your SmythOS dashboard, navigate to the Vault.
- Create a new secret and paste your ClickUp API Token as the value. Give it a memorable name, like
clickup_api_token
. - For more details, see the Vault Documentation.
Step 3: Configure a ClickUp Component
- In your SmythOS agent graph, drag and drop any ClickUp component.
- Click the component to open its Settings panel.
- In the
ClickUp API Token
field, select the secret you saved in the Vault (e.g.,clickup_api_token
). - Your connection is now configured for that component.
Which ClickUp Component Should I Use?
If you need to… | Target | Use this Component | Why this one? |
---|---|---|---|
Create a new to-do item | A list_id and task name | Add Task | The primary method for programmatically creating new tasks. |
Mark a task as "Done" | A task_id | Update Task Status | Specifically designed to change a task's status (e.g., "To Do", "In Progress", "Complete"). |
Get all details for one task | A task_id | Get A Task | Retrieves the full record for a single, known task. |
See all tasks in a project list | A list_id | Get Tasks | Fetches multiple tasks at once, perfect for reporting or processing in a loop. |
Assign a task to someone | A task_id and assignee_id | Add Assignee To Task | The correct way to assign a user to a task. |
Find the ID for a specific List | A folder_id | Get ClickUp Lists | Necessary for finding the list_id required by many other components. |
Component Details
This section provides detailed information for each ClickUp component.
Add Task
Creates a new task in a specified List.
Inputs
Field | Type | Required | Notes |
---|---|---|---|
list_id | string | Yes | The unique ID of the List where the task will be added. |
name | string | Yes | The name or title of the task. |
description | string | Optional | A detailed description of the task. |
priority | integer | Optional | The priority level (1-4, where 1 is Urgent). Default: 3 . |
Outputs
Field | Type | Description |
---|---|---|
id | string | The unique ID of the newly created task. |
url | string | A direct URL to view the task in the ClickUp app. |
list_id | string | The ID of the list the task was added to. |
Response | object | The full, raw JSON response from the ClickUp API. |
{
"component": "clickup.addTask",
"list_id": "901200_abcde",
"name": "Fix login button on homepage",
"description": "A user reported that the login button is unresponsive on the Chrome browser.",
"priority": 1
}
Update Task Status
Updates the status of an existing task (e.g., from "To Do" to "In Progress").
Inputs
Field | Type | Required | Notes |
---|---|---|---|
task_id | string | Yes | The unique ID of the task to update. |
status | string | Yes | The new status for the task. Must match an existing status in the list. |
Outputs
Field | Type | Description |
---|---|---|
task_id | string | The ID of the updated task. |
status | object | An object containing the new status name and color. |
url | string | A direct URL to the updated task. |
Response | object | The raw JSON response from the API. |
Get Tasks
Retrieves a list of tasks from a specific List.
Inputs
Field | Type | Required | Notes |
---|---|---|---|
list_id | string | Yes | The ID of the List from which to retrieve tasks. |
page | integer | Optional | The page number for paginated results. Default: 0 . |
Outputs
Field | Type | Description |
---|---|---|
tasks | array | An array of task objects from the specified list. |
Response | object | The raw JSON response from the API. |
Get A Task
Retrieves detailed information about a single, specific task by its ID.
Inputs
Field | Type | Required | Notes |
---|---|---|---|
task_id | string | Yes | The unique identifier of the task to retrieve. |
Outputs
Field | Type | Description |
---|---|---|
id | string | The ID of the retrieved task. |
name | string | The name of the task. |
status | object | An object containing the current status of the task (e.g., name, color). |
due_date | string | The due date of the task as a Unix timestamp. |
assignees | array | A list of user objects assigned to the task. |
url | string | A direct URL to view the task in the ClickUp app. |
Response | object | The full, raw JSON response from the API, containing all task details. |
Add Task To List
Adds an existing task to an additional List. A task can live in multiple Lists in ClickUp.
Inputs
Field | Type | Required | Notes |
---|---|---|---|
list_id | string | Yes | The ID of the destination List to add the task to. |
task_id | string | Yes | The ID of the existing task to add. |
Outputs
Field | Type | Description |
---|---|---|
Response | object | The raw JSON response from the ClickUp API, confirming the action. |
Headers | object | The HTTP headers from the API response. |
Remove Task From List
Removes a task from a List. If the task only exists in one List, this will not delete the task but will move it to an "orphaned" state.
Inputs
Field | Type | Required | Notes |
---|---|---|---|
list_id | string | Yes | The ID of the List from which the task will be removed. |
task_id | string | Yes | The ID of the task to remove. |
Outputs
Field | Type | Description |
---|---|---|
Response | object | A successful removal returns an empty JSON response. |
Headers | object | The HTTP headers from the API response. |
Add Assignee To Task
Assigns a user to a specific task.
Inputs
Field | Type | Required | Notes |
---|---|---|---|
task_id | string | Yes | The unique ID of the task to update. |
assignee_id | string | Yes | The numeric ID of the user to assign to the task. |
Outputs
Field | Type | Description |
---|---|---|
assignees | array | The updated list of user objects assigned to the task. |
Response | object | The full, raw JSON response containing the updated task details. |
Delete Task
Permanently deletes a task from ClickUp.
Inputs
Field | Type | Required | Notes |
---|---|---|---|
task_id | string | Yes | The unique identifier of the task to be deleted. |
Outputs
Field | Type | Description |
---|---|---|
Response | object | A successful deletion returns an empty response body. |
Headers | object | The HTTP headers from the API response. |
Get Lists
Retrieves all the Lists contained within a specific Folder.
Inputs
Field | Type | Required | Notes |
---|---|---|---|
folder_id | string | Yes | The unique identifier of the Folder to retrieve lists from. |
Outputs
Field | Type | Description |
---|---|---|
lists | array | An array of list objects found within the folder. |
Response | object | The raw JSON response from the API. |
Get Folders
Retrieves all Folders within a specific Space.
Inputs
Field | Type | Required | Notes |
---|---|---|---|
space_id | string | Yes | The unique identifier of the Space to retrieve folders from. |
Outputs
Field | Type | Description |
---|---|---|
folders | array | An array of folder objects found within the space. |
Response | object | The raw JSON response from the API. |
Get Spaces
Retrieves all Spaces within a specific Workspace (Team).
Inputs
Field | Type | Required | Notes |
---|---|---|---|
workspace_id | string | Yes | The unique identifier of the Workspace (Team) to retrieve spaces from. |
Outputs
Field | Type | Description |
---|---|---|
spaces | array | An array of space objects found within the workspace. |
Response | object | The raw JSON response from the API. |
Best Practices & Advanced Tips
- Secure Your API Token: Always store your ClickUp API token in the SmythOS
Vault
. - Understand the Hierarchy: ClickUp's structure is key: Workspace > Space > Folder > List > Task. To create a task in the right place, you often need to find the
list_id
first. Use components likeGet Spaces
,Get Folders
, andGet Lists
to navigate the hierarchy programmatically. - Use Custom Fields: For advanced workflows, you can create Custom Fields in ClickUp (e.g., "Ticket ID," "Customer Email"). While not directly supported by default inputs, you can often update these fields by constructing a custom JSON payload in the
Body
of theUpdate Task
component. - Pagination: When using
Get Tasks
or other list components, remember that the API returns paginated results. You may need to build a loop that increments thepage
input to fetch all tasks if a list contains more than the default limit.
Troubleshooting Common Issues
-
Error:
401 Unauthorized
- Cause: The API Token is incorrect, has been revoked, or is missing.
- Solution: Verify that the API Token in your SmythOS Vault is correct and active. Generate a new token in your ClickUp Apps settings if necessary and update your Vault secret.
-
Error:
404 Not Found
- Cause: An incorrect ID was provided (e.g.,
list_id
,task_id
,folder_id
). - Solution: Double-check all IDs for typos. Use the "Get" components (e.g.,
Get Lists
) to verify that the resource you are trying to access exists and you have its correct ID.
- Cause: An incorrect ID was provided (e.g.,
-
Error:
OAUTH_025
orOAUTH_046
- Cause: This often relates to permissions. The user whose personal API token is being used may not have access to the specific Space, Folder, or List you are trying to interact with.
- Solution: Ensure the user associated with the API token has been invited to and has the necessary permissions for the target resources within ClickUp.
What's Next?
You are now ready to build powerful project management automations with the SmythOS ClickUp Integration!
Consider these ideas:
-
Build an Agent That...
- Functions as a helpdesk. It takes incoming support emails, creates a new task in a "Support" list in ClickUp using
Add Task
, and then assigns it to a team member usingAdd Assignee To Task
. - Manages client onboarding. When a new client is added to your CRM, an agent creates a new List for them in a "Clients" folder, and populates it with a standard set of onboarding tasks.
- Syncs with your calendar. The agent reads your Microsoft Calendar and creates a ClickUp task for every meeting scheduled for the next day.
- Functions as a helpdesk. It takes incoming support emails, creates a new task in a "Support" list in ClickUp using
-
Explore Other Integrations:
- When a task is updated to "In Review" in ClickUp, trigger an agent to send a notification to a Microsoft Teams channel.
- Use an LLM component to summarize a long project brief, then create a new parent task in ClickUp with the summary as the description.
- Connect to a form builder. When a user submits a bug report through a form, create a new, high-priority task in your "Bugs" list.