> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/clickup.md).

# Clickup

ClickUp is a project management and productivity platform. Connect to manage tasks, checklists, folders, lists, docs, and comments from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| ClickUp   | OAuth sign-in  |

#### ClickUp

Connect to ClickUp to access your tasks, lists, and projects. Supports reading tasks, managing lists, and analyzing project data.

**Set up in Clickup**

1. Use a Clickup account with access to the records and operations that your workflow needs.
2. If your organization restricts application access or user consent, have its administrator approve the connection before you sign in.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **ClickUp**.
2. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

StackAI obtains the OAuth credentials during sign-in. You do not need to paste an access token or refresh token.

**Provider documentation:** [Setup reference](https://developer.clickup.com/docs/authentication).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Clickup** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

| Action                             | Purpose                                                                                                                                       | Required inputs                      |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| Delete Checklist                   | Delete a checklist from a task.                                                                                                               | Checklist Id                         |
| Edit Checklist                     | Rename a task checklist, or reorder a checklist so it appears above or below other checklists on a task.                                      | Checklist Id                         |
| Create Checklist Item              | Add a line item to a task checklist.                                                                                                          | Checklist Id                         |
| Delete Checklist Item              | Delete a line item from a task checklist.                                                                                                     | Checklist Id, Checklist Item Id      |
| Edit Checklist Item                | Update an individual line item in a task checklist.                                                                                           | Checklist Id, Checklist Item Id      |
| Delete Comment                     | Delete a task comment.                                                                                                                        | Comment Id                           |
| Update Comment                     | Replace the content of a task commment, assign a comment, and mark a comment as resolved.                                                     | Comment Id                           |
| Get Threaded Comments              | View threaded comments.                                                                                                                       | Comment Id                           |
| Create Threaded Comment            | Create a threaded comment.                                                                                                                    | Comment Id                           |
| Delete Folder                      | Delete a Folder from your Workspace.                                                                                                          | Folder Id                            |
| Get Folder                         | View the Lists within a Folder.                                                                                                               | Folder Id                            |
| Update Folder                      | Rename a Folder.                                                                                                                              | Folder Id                            |
| Get Folder Available Fields        | View the Custom Fields you have access to in a specific Folder.                                                                               | Folder Id, Content-Type              |
| Remove Guest From Folder           | Revoke a guest's access to a Folder.                                                                                                          | Folder Id, Guest Id                  |
| Add Guest To Folder                | Share a Folder with a guest.                                                                                                                  | Folder Id, Guest Id                  |
| Get Lists                          | View the Lists within a Folder.                                                                                                               | Folder Id                            |
| Create List                        | Add a new List to a Folder.                                                                                                                   | Folder Id                            |
| Create Folder List From Template   | Create a new list using a list template in a folder This request runs synchronously by default with return\_immediately=true.                 | Folder Id, Template Id               |
| Get Folder Views                   | View the task and page views available for a Folder.                                                                                          | Folder Id                            |
| Create Folder View                 | Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Folder.                                       | Folder Id                            |
| Delete Goal                        | Remove a Goal from your Workspace.                                                                                                            | Goal Id, Content-Type                |
| Get Goal                           | View the details of a Goal including its Targets.                                                                                             | Goal Id                              |
| Update Goal                        | Rename a Goal, set the due date, replace the description, add or remove owners, and set the Goal color.                                       | Goal Id                              |
| Create Key Result                  | Add a Target to a Goal.                                                                                                                       | Goal Id                              |
| Get Teams                          | This endpoint is used to view User Groups in your Workspace.                                                                                  | Team Id                              |
| Delete Team                        | This endpoint is used to remove a User Group from your Workspace.                                                                             | Group Id                             |
| Update Team                        | This endpoint is used to manage User Groups, which are groups of users within your Workspace.                                                 | Group Id                             |
| Delete Key Result                  | Delete a target from a Goal.                                                                                                                  | Key Result Id                        |
| Edit Key Result                    | Update a Target.                                                                                                                              | Key Result Id                        |
| Delete List                        | Delete a List from your Workspace.                                                                                                            | List Id, Content-Type                |
| Get List                           | View information about a List.                                                                                                                | List Id                              |
| Update List                        | Rename a List, update the List Info description, set a due date/time, set the List's priority, set an assignee, set or remove the List color. | List Id                              |
| Get List Comments                  | View the comments added to a List.                                                                                                            | List Id                              |
| Create List Comment                | Add a comment to a List.                                                                                                                      | List Id                              |
| Get Accessible Custom Fields       | View the Custom Fields you have access to in a specific List.                                                                                 | List Id, Content-Type                |
| Remove Guest From List             | Revoke a guest's access to a List.                                                                                                            | List Id, Guest Id                    |
| Add Guest To List                  | Share a List with a guest.                                                                                                                    | List Id, Guest Id                    |
| Get List Members                   | Get Workspace members who have access to a List.                                                                                              | List Id                              |
| Get Tasks                          | View the tasks in a List.                                                                                                                     | List Id                              |
| Create ClickUp Task                | Create a new task.                                                                                                                            | List Id                              |
| Remove Task From List              | Remove a task from an additional List.                                                                                                        | List Id, Task Id                     |
| Add Task To List                   | Add a task to an additional List.                                                                                                             | List Id, Task Id                     |
| Create Task From Template          | Create a new task using a task template.                                                                                                      | List Id, Template Id                 |
| Get List Views                     | View the task and page views available for a List.                                                                                            | List Id                              |
| Create List View                   | Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a List.                                         | List Id                              |
| Get Access Token                   | These are the routes for authing the API and going through the OAuth flow.                                                                    | Client Id, Client Secret, Code       |
| Delete Space                       | Delete a Space from your Workspace.                                                                                                           | Space Id                             |
| Get Space                          | View the Spaces available in a Workspace.                                                                                                     | Space Id                             |
| Update Space                       | Rename, set the Space color, and enable ClickApps for a Space.                                                                                | Space Id                             |
| Get Space Available Fields         | View the Custom Fields you have access to in a specific Space.                                                                                | Space Id, Content-Type               |
| Get Folders                        | View the Folders in a Space.                                                                                                                  | Space Id                             |
| Create Folder                      | Add a new Folder to a Space.                                                                                                                  | Space Id                             |
| Create Folder From Template        | Create a new Folder using a Folder template within a Space.                                                                                   | Space Id, Template Id                |
| Get Folderless Lists               | View the Lists in a Space that aren't located in a Folder.                                                                                    | Space Id                             |
| Create Folderless List             | Add a new List in a Space.                                                                                                                    | Space Id                             |
| Create Space List From Template    | Create a new List using a List template within a Space.                                                                                       | Space Id, Template Id                |
| Get Space Tags                     | View the task Tags available in a Space.                                                                                                      | Space Id, Content-Type               |
| Create Space Tag                   | Add a new task Tag to a Space.                                                                                                                | Space Id                             |
| Delete Space Tag                   | Delete a task Tag from a Space.                                                                                                               | Space Id, Tag Name                   |
| Edit Space Tag                     | Update a task Tag.                                                                                                                            | Space Id, Tag Name                   |
| Get Space Views                    | View the task and page views available for a Space.                                                                                           | Space Id                             |
| Create Space View                  | Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Space.                                        | Space Id                             |
| Delete ClickUp Task                | Delete a task from your Workspace.                                                                                                            | Task Id, Content-Type                |
| Get ClickUp Task                   | View information about a task.                                                                                                                | Task Id                              |
| Update ClickUp Task                | Update a task by including one or more fields in the request body.                                                                            | Task Id                              |
| Create Task Attachment             | Upload a file to a task as an attachment.                                                                                                     | Task Id                              |
| Create Checklist                   | Add a new checklist to a task.                                                                                                                | Task Id                              |
| Get Task Comments                  | View task comments.                                                                                                                           | Task Id                              |
| Create Task Comment                | Add a new comment to a task.                                                                                                                  | Task Id                              |
| Delete Dependency                  | Remove the dependency relationship between two or more tasks.                                                                                 | Task Id, Depends On, Dependency Of   |
| Add Dependency                     | Set a task as waiting on or blocking another task.                                                                                            | Task Id                              |
| Remove Custom Field Value          | Remove the data from a Custom Field on a task.                                                                                                | Task Id, Field Id                    |
| Set Custom Field Value             | Add data to a Custom field on a task.                                                                                                         | Task Id, Field Id                    |
| Remove Guest From Task             | Revoke a guest's access to a task.                                                                                                            | Task Id, Guest Id                    |
| Add Guest To Task                  | Share a task with a guest.                                                                                                                    | Task Id, Guest Id                    |
| Delete Task Link                   | Remove the link between two tasks.                                                                                                            | Task Id, Links To                    |
| Add Task Link                      | This is the equivalent of the feature \_Task Links\_ in the right-hand sidebar of a Task.                                                     | Task Id, Links To                    |
| Get Task Members                   | View the people who have access to a task.                                                                                                    | Task Id                              |
| Remove Tag From Task               | Remove a Tag from a task.                                                                                                                     | Task Id, Tag Name, Content-Type      |
| Add Tag To Task                    | Add a Tag to a task.                                                                                                                          | Task Id, Tag Name, Content-Type      |
| Gettrackedtime                     | Note: This is a legacy time tracking endpoint.                                                                                                | Task Id, Content-Type                |
| Tracktime                          | Note: This is a legacy time tracking endpoint.                                                                                                | Task Id                              |
| Deletetimetracked                  | Note: This is a legacy time tracking endpoint.                                                                                                | Task Id, Interval Id, Content-Type   |
| Edittimetracked                    | Note: This is a legacy time tracking endpoint.                                                                                                | Task Id, Interval Id                 |
| Get Authorized Teams               | View the Workspaces available to the authenticated user.                                                                                      | None listed                          |
| Get Filtered Team Tasks            | View the tasks that meet specific criteria from a Workspace.                                                                                  | Team Id                              |
| Gettimeentrieswithinadaterange     | View time entries filtered by start and end date.                                                                                             | Team Id, Content-Type                |
| Create A Time Entry                | Create a time entry.                                                                                                                          | Team Id                              |
| Startatime Entry                   | Start a timer for the authenticated user.                                                                                                     | Team Id                              |
| Get Custom Items                   | View the custom task types available in a Workspace.                                                                                          | Team Id                              |
| Get Custom Roles                   | View the Custom Roles available in a Workspace.                                                                                               | Team Id                              |
| Get Team Available Fields          | View the Custom Fields you have access to in a specific Workspace.                                                                            | Team Id, Content-Type                |
| Get Goals                          | View the Goals available in a Workspace.                                                                                                      | Team Id                              |
| Create Goal                        | Add a new Goal to a Workspace.                                                                                                                | Team Id                              |
| Create User Group                  | This endpoint creates a User Group within a Workspace.                                                                                        | Team Id                              |
| Invite Guest To Workspace          | Invite a guest to join a Workspace.                                                                                                           | Team Id                              |
| Remove Guest From Workspace        | Revoke a guest's access to a Workspace.                                                                                                       | Team Id, Guest Id                    |
| Get Guest                          | View information about a guest.                                                                                                               | Team Id, Guest Id                    |
| Edit Guest On Workspace            | Rename and configure options for a guest.                                                                                                     | Team Id, Guest Id                    |
| Get Workspaceplan                  | View the current Plan for the specified Workspace.                                                                                            | Team Id                              |
| Get Workspaceseats                 | View the used, total, and available member and guest seats for a Workspace.                                                                   | Team Id                              |
| Shared Hierarchy                   | View the tasks, Lists, and Folders that have been shared with the authenticated user.                                                         | Team Id                              |
| Get Spaces                         | View the Spaces avialable in a Workspace.                                                                                                     | Team Id                              |
| Create Space                       | Add a new Space to a Workspace.                                                                                                               | Team Id                              |
| Get Task Templates                 | View the task templates available in a Workspace.                                                                                             | Team Id, Page, Content-Type          |
| Getrunningtimeentry                | View a time entry that's currently tracking time for the authenticated user.                                                                  | Team Id, Content-Type                |
| Stopatime Entry                    | Stop a timer that's currently running for the authenticated user.                                                                             | Team Id, Content-Type                |
| Removetagsfromtimeentries          | Remove labels from time entries.                                                                                                              | Team Id                              |
| Getalltagsfromtimeentries          | View all the labels that have been applied to time entries in a Workspace.                                                                    | Team Id, Content-Type                |
| Addtagsfromtimeentries             | Add a label to a time entry.                                                                                                                  | Team Id                              |
| Changetagnamesfromtimeentries      | Rename an time entry label.                                                                                                                   | Team Id                              |
| Deleteatime Entry                  | Delete a time entry from a Workspace.                                                                                                         | Team Id, Timer Id, Content-Type      |
| Getsingulartimeentry               | View a single time entry.                                                                                                                     | Team Id, Timer Id, Content-Type      |
| Updateatime Entry                  | Update the details of a time entry.                                                                                                           | Team Id, Timer Id                    |
| Gettimeentryhistory                | View a list of changes made to a time entry.                                                                                                  | Team Id, Timer Id, Content-Type      |
| Invite User To Workspace           | Invite someone to join your Workspace as a member.                                                                                            | Team Id                              |
| Remove User From Workspace         | Deactivate a user from a Workspace.                                                                                                           | Team Id, User Id                     |
| Get User                           | View information about a user in a Workspace.                                                                                                 | Team Id, User Id                     |
| Edit User On Workspace             | Update a user's name and role.                                                                                                                | Team Id, User Id                     |
| Get Team Views                     | View the task and page views available at the Everything Level of a Workspace.                                                                | Team Id                              |
| Create Team View                   | Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view at the Everything Level of a Workspace.            | Team Id                              |
| Get Webhooks                       | View the webhooks created via the API for a Workspace.                                                                                        | Team Id                              |
| Create Webhook                     | Set up a webhook to monitor for events.                                                                                                       | Team Id                              |
| Get Authorized User                | View the details of the authenticated user's ClickUp account.                                                                                 | None listed                          |
| Delete View                        | Use this tool to delete delete view                                                                                                           | View Id                              |
| Get View                           | View information about a specific task or page view.                                                                                          | View Id                              |
| Update View                        | Rename a view, update the grouping, sorting, filters, columns, and settings of a view.                                                        | View Id                              |
| Get Chat View Comments             | View comments from a Chat view.                                                                                                               | View Id                              |
| Create Chat View Comment           | Add a new comment to a Chat view.                                                                                                             | View Id                              |
| Get View Tasks                     | See all visible tasks in a view in ClickUp.                                                                                                   | View Id, Page                        |
| Delete Webhook                     | Delete a webhook to stop monitoring the events and locations of the webhook.                                                                  | Webhook Id                           |
| Update Webhook                     | Update a webhook to change the events to be monitored.                                                                                        | Webhook Id                           |
| Search Docs                        | View the Docs in your Workspace.                                                                                                              | Workspaceid                          |
| Create Doc                         | Create a new Doc.                                                                                                                             | Workspaceid                          |
| Get Doc                            | View information about a Doc.                                                                                                                 | Workspaceid, Docid                   |
| Get Doc Page Listing               | View the PageListing for a Doc.                                                                                                               | Workspaceid, Docid                   |
| Get Doc Pages                      | View pages belonging to a Doc.                                                                                                                | Workspaceid, Docid                   |
| Create Page                        | Create a page in a Doc.                                                                                                                       | Workspaceid, Docid                   |
| Get Page                           | View the information about a page in a Doc.                                                                                                   | Workspaceid, Docid, Pageid           |
| Edit Page                          | Edit a page in a Doc.                                                                                                                         | Workspaceid, Docid, Pageid           |
| Create Workspace Audit Log         | Create Workspace-level audit logs.                                                                                                            | Workspace Id                         |
| Get Chat Channels                  | This endpoint retrieves the Channels in a Workspace.                                                                                          | Workspace Id                         |
| Create Chat Channel                | This endpoint creates a new Channel not tied to a Space, Folder, or List.                                                                     | Workspace Id                         |
| Create Direct Message Chat Channel | This endpoint creates a new Direct Message between up to 10 users.                                                                            | Workspace Id                         |
| Create Location Chat Channel       | This endpoint creates a Channel and when a Channel already exists on the requested location, it returns it.                                   | Workspace Id                         |
| Delete Chat Channel                | This endpoint deletes a Channel.                                                                                                              | Workspace Id, Channel Id             |
| Get Chat Channel                   | This endpoint retrieves a specific Channel given its ID.                                                                                      | Workspace Id, Channel Id             |
| Update Chat Channel                | This endpoint updates a single Channel.                                                                                                       | Workspace Id, Channel Id             |
| Get Chat Channel Followers         | This endpoint retrieves followers of a specific Channel given its ID.                                                                         | Workspace Id, Channel Id             |
| Get Chat Channel Members           | This endpoint retrieves members of a specific Channel given its ID.                                                                           | Workspace Id, Channel Id             |
| Get Chat Messages                  | This endpoint retrieves messages for a specified Channel.                                                                                     | Workspace Id, Channel Id             |
| Create Chat Message                | This endpoint creates a top level message.                                                                                                    | Workspace Id, Channel Id             |
| Delete Chat Message                | This endpoint deletes a message.                                                                                                              | Workspace Id, Message Id             |
| Patch Chat Message                 | This endpoint updates a message.                                                                                                              | Workspace Id, Message Id             |
| Get Chat Message Reactions         | This endpoint retrieves reactions for a message                                                                                               | Workspace Id, Message Id             |
| Create Chat Reaction               | This endpoint creates a message reaction using lower case emoji names.                                                                        | Workspace Id, Message Id             |
| Delete Chat Reaction               | This endpoint deletes a message reaction.                                                                                                     | Workspace Id, Message Id, Reaction   |
| Get Chat Message Replies           | This endpoint retrieves replies to a message.                                                                                                 | Workspace Id, Message Id             |
| Create Reply Message               | This endpoint creates a reply message.                                                                                                        | Workspace Id, Message Id             |
| Get Chat Message Tagged Users      | This endpoint retrieves tagged users for a message                                                                                            | Workspace Id, Message Id             |
| Update Privacy And Access          | Update the privacy and access settings of an object or location in the Workspace.                                                             | Workspace Id, Object Type, Object Id |

### Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/clickup.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
