ClickUp
Connect to ClickUp to access your tasks, lists, and projects. Supports reading tasks, managing lists, and analyzing project data.
At Stack AI, security and privacy of our customer's data is our top priority. Today, we are thrilled to announce that Stack AI is now SOC 2 Type II and HIPAA compliant.
Connect to ClickUp to access your tasks, lists, and projects. Supports reading tasks, managing lists, and analyzing project data.
Delete a checklist from a task.
1 input parameter
3 output parameters
Rename a task checklist, or reorder a checklist so it appears above or below other checklists on a task.
2 input parameters
3 output parameters
Add a line item to a task checklist.
2 input parameters
3 output parameters
Delete a line item from a task checklist.
2 input parameters
3 output parameters
Update an individual line item in a task checklist. \ \ You can rename it, set the assignee, mark it as resolved, or nest it under another checklist item.
3 input parameters
3 output parameters
Delete a task comment.
1 input parameter
3 output parameters
Replace the content of a task commment, assign a comment, and mark a comment as resolved.
2 input parameters
3 output parameters
View threaded comments. The parent comment is not included.
1 input parameter
3 output parameters
Create a threaded comment.
2 input parameters
3 output parameters
Delete a Folder from your Workspace.
1 input parameter
3 output parameters
View the Lists within a Folder.
1 input parameter
3 output parameters
Rename a Folder.
2 input parameters
3 output parameters
View the Custom Fields you have access to in a specific Folder. Get Folder Custom Fields only returns Custom Fields created at the Folder level. Custom Fields created at the List level are not included.
2 input parameters
3 output parameters
Revoke a guest's access to a Folder. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
3 input parameters
3 output parameters
Share a Folder with a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
4 input parameters
3 output parameters
View the Lists within a Folder.
2 input parameters
3 output parameters
Add a new List to a Folder.
2 input parameters
3 output parameters
Create a new list using a list template in a folder This request runs synchronously by default with `return_immediately=true`. The request returns the future List ID immediatly, but the List might not created at the time of the request returning. Small temmplates can be applied syncronously, which guarantees that all sub objects are created. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.
3 input parameters
3 output parameters
View the task and page views available for a Folder.
1 input parameter
3 output parameters
Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Folder.
2 input parameters
3 output parameters
Remove a Goal from your Workspace.
2 input parameters
3 output parameters
View the details of a Goal including its Targets.
1 input parameter
3 output parameters
Rename a Goal, set the due date, replace the description, add or remove owners, and set the Goal color.
2 input parameters
3 output parameters
Add a Target to a Goal.
2 input parameters
3 output parameters
This endpoint is used to view [User Groups](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) in your Workspace.\ \ In our API documentation, `team_id` refers to the ID of a Workspace, and `group_id` refers to the ID of a User Group.
2 input parameters
3 output parameters
This endpoint is used to remove a [User Group](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) from your Workspace.\ \ In our API documentation, `team_id` refers to the id of a Workspace, and `group_id` refers to the id of a user group.
1 input parameter
3 output parameters
This endpoint is used to manage [User Groups](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups), which are groups of users within your Workspace.\ \ In our API, `team_id` in the path refers to the Workspace ID, and `group_id` refers to the ID of a User Group.\ \ **Note:** Adding a guest with view-only permissions to a User Group automatically converts them to a paid guest.\ \ If you don't have any paid guest seats available, a new member seat is automatically added to increase the number of paid guest seats.\ \ This incurs a prorated charge based on your billing cycle.
2 input parameters
3 output parameters
Delete a target from a Goal.
1 input parameter
3 output parameters
Update a Target.
2 input parameters
3 output parameters
Delete a List from your Workspace.
2 input parameters
3 output parameters
View information about a List.
1 input parameter
3 output parameters
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.
2 input parameters
3 output parameters
View the comments added to a List. \ \ If you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\ \ Use the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.
3 input parameters
3 output parameters
Add a comment to a List.
2 input parameters
3 output parameters
View the Custom Fields you have access to in a specific List.
2 input parameters
3 output parameters
Revoke a guest's access to a List.\ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
3 input parameters
3 output parameters
Share a List with a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
4 input parameters
3 output parameters
Get Workspace members who have access to a List.
1 input parameter
3 output parameters
View the tasks in a List. Responses are limited to 100 tasks per page. You can only view task information of tasks you can access. \ \ This endpoint only includes tasks where the specified `list_id` is their home List. Tasks added to the `list_id` with a different home List are not included in the response.
23 input parameters
3 output parameters
Create a new task.
4 input parameters
3 output parameters
Remove a task from an additional List. You can't remove a task from its home List. \ \ ***Note:** This endpoint requires the [Tasks in Multiple List ClickApp](https://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists) to be enabled.*
2 input parameters
3 output parameters
Add a task to an additional List. \ \ ***Note:** This endpoint requires the [Tasks in Multiple List ClickApp](https://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists) to be enabled.*
2 input parameters
3 output parameters
Create a new task using a task template.
3 input parameters
3 output parameters
View the task and page views available for a List.<br> Views and required views are separate responses.
1 input parameter
3 output parameters
Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a List.
2 input parameters
3 output parameters
These are the routes for authing the API and going through the [OAuth flow](doc:authentication).\ \ Applications utilizing a personal API token don't use this endpoint.\ \ ***Note:** OAuth tokens are not supported when using the [**Try It** feature](doc:trytheapi) of our Reference docs. You can't try this endpoint from your web browser.*
3 input parameters
3 output parameters
Delete a Space from your Workspace.
1 input parameter
3 output parameters
View the Spaces available in a Workspace.
1 input parameter
3 output parameters
Rename, set the Space color, and enable ClickApps for a Space.
2 input parameters
3 output parameters
View the Custom Fields you have access to in a specific Space. Get Space Custom Fields only returns Custom Fields created at the Space level. Custom Fields created at the Folder and List level are not included.
2 input parameters
3 output parameters
View the Folders in a Space.
2 input parameters
3 output parameters
Add a new Folder to a Space.
2 input parameters
3 output parameters
Create a new Folder using a Folder template within a Space. This endpoint allows you to create a folder with all its nested assets (lists, tasks, etc.) from a predefined template. This request can be run asynchronously or synchronously via the `return_immediately` parameter.
3 input parameters
3 output parameters
View the Lists in a Space that aren't located in a Folder.
2 input parameters
3 output parameters
Add a new List in a Space.
2 input parameters
3 output parameters
Create a new List using a List template within a Space. This request can be run asynchronously or synchronously via the `return_immediately` parameter.
3 input parameters
3 output parameters
View the task Tags available in a Space.
2 input parameters
3 output parameters
Add a new task Tag to a Space.
2 input parameters
3 output parameters
Delete a task Tag from a Space.
3 input parameters
3 output parameters
Update a task Tag.
3 input parameters
3 output parameters
View the task and page views available for a Space.
1 input parameter
3 output parameters
Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Space.
2 input parameters
3 output parameters
Delete a task from your Workspace.
4 input parameters
3 output parameters
View information about a task. You can only view task information of tasks you can access. \ \ Tasks with attachments will return an "attachments" response. \ \ Docs attached to a task are not returned.
5 input parameters
3 output parameters
Update a task by including one or more fields in the request body.
4 input parameters
3 output parameters
Upload a file to a task as an attachment. Files stored in the cloud cannot be used in this API request.\ \ ***Note:** This request uses multipart/form-data as the content type.*
4 input parameters
3 output parameters
Add a new checklist to a task.
4 input parameters
3 output parameters
View task comments. \ \ If you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\ \ Use the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.
5 input parameters
3 output parameters
Add a new comment to a task.
4 input parameters
3 output parameters
Remove the dependency relationship between two or more tasks.
5 input parameters
3 output parameters
Set a task as waiting on or blocking another task.
4 input parameters
3 output parameters
Remove the data from a Custom Field on a task. This does not delete the option from the Custom Field.
4 input parameters
3 output parameters
Add data to a Custom field on a task. \ \ You'll need to know the `task_id` of the task you want to update, and the universal unique identifier (UUID) `field_id` of the Custom Field you want to set. \ \ You can use [Get Accessible Custom Fields](ref:getaccessiblecustomfields) or the [Get Task](ref:gettask) endpoint to find the `field_id`.
5 input parameters
3 output parameters
Revoke a guest's access to a task. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
5 input parameters
3 output parameters
Share a task with a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
6 input parameters
3 output parameters
Remove the link between two tasks.
4 input parameters
3 output parameters
This is the equivalent of the feature _Task Links_ in the right-hand sidebar of a Task. It allows you to link two tasks together. General links or links to other objects than tasks are not supported.
4 input parameters
3 output parameters
View the people who have access to a task. Responses do not include people with inherited Hierarchy permission to the task.
1 input parameter
3 output parameters
Remove a Tag from a task. This does not delete the Tag from the Space.
5 input parameters
3 output parameters
Add a Tag to a task.
5 input parameters
3 output parameters
***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*
4 input parameters
3 output parameters
***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*
4 input parameters
3 output parameters
***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*
5 input parameters
3 output parameters
***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*
5 input parameters
3 output parameters
View the Workspaces available to the authenticated user.
None
3 output parameters
View the tasks that meet specific criteria from a Workspace. Responses are limited to 100 tasks per page. \ \ You can only view task information of tasks you can access. \ \ Our Try It modal currently supports filtering by two or more Lists, Folders, or Spaces. To filter by a single List, Folder, or Space, we recommend using a free app like [Postman](https://www.postman.com/) to test our public API.
26 input parameters
3 output parameters
View time entries filtered by start and end date. \ \ By default, this endpoint returns time entries from the last 30 days created by the authenticated user. \ \ To retrieve time entries for other users, you must include the `assignee` query parameter. \ \ Only one of the following location filters can be included at a time: `space_id`, `folder_id`, `list_id`, or `task_id`. \ \ ***Note:** A time entry that has a negative duration means that timer is currently running for that user.*
14 input parameters
3 output parameters
Create a time entry. \ \ ***Note:** A time entry that has a negative duration means that timer is currently running for that user.*
4 input parameters
3 output parameters
Start a timer for the authenticated user.
4 input parameters
3 output parameters
View the custom task types available in a Workspace.
1 input parameter
3 output parameters
View the Custom Roles available in a Workspace.
2 input parameters
3 output parameters
View the Custom Fields you have access to in a specific Workspace. Get Workspace Custom Fields only returns Custom Fields created at the Workspace level. Custom Fields created at the Space, Folder, and List level are not included.
2 input parameters
3 output parameters
View the Goals available in a Workspace.
2 input parameters
3 output parameters
Add a new Goal to a Workspace.
2 input parameters
3 output parameters
This endpoint creates a [User Group](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) within a Workspace.\ \ User Groups are used to organize and manage users within a Workspace.\ \ In the API documentation, `team_id` refers to the Workspace ID, and `group_id` refers to the User Group ID.\ \ **Note:** Adding a guest with view-only permissions to a Team automatically converts them to a paid guest.\ \ If no paid guest seats are available, an additional member seat will be added, increasing the number of paid guest seats.\ \ This change incurs a prorated charge based on the billing cycle.
2 input parameters
3 output parameters
Invite a guest to join a Workspace. To invite a member to your Workspace, use the [Invite User to Workspace](ref:inviteusertoworkspace) endpoint. \ \ You'll also need to grant the guest access to specific items using the following endpoints: [Add Guest to Folder](ref:addguesttofolder), [Add Guest to List](ref:addguesttolist), or [Add Guest to Task](ref:addguesttotask). \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
2 input parameters
3 output parameters
Revoke a guest's access to a Workspace. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
2 input parameters
3 output parameters
View information about a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
2 input parameters
3 output parameters
Rename and configure options for a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
3 input parameters
3 output parameters
View the current [Plan](https://clickup.com/pricing) for the specified Workspace.
1 input parameter
3 output parameters
View the used, total, and available member and guest seats for a Workspace.
1 input parameter
3 output parameters
View the tasks, Lists, and Folders that have been shared with the authenticated user.
1 input parameter
3 output parameters
View the Spaces avialable in a Workspace. You can only get member info in private Spaces.
2 input parameters
3 output parameters
Add a new Space to a Workspace.
2 input parameters
3 output parameters
View the task templates available in a Workspace.
3 input parameters
3 output parameters
View a time entry that's currently tracking time for the authenticated user. \ \ ***Note:** A time entry that has a negative duration means that timer is currently running for that user.*
3 input parameters
3 output parameters
Stop a timer that's currently running for the authenticated user.
2 input parameters
3 output parameters
Remove labels from time entries. This does not remove the label from a Workspace.
2 input parameters
3 output parameters
View all the labels that have been applied to time entries in a Workspace.
2 input parameters
3 output parameters
Add a label to a time entry.
2 input parameters
3 output parameters
Rename an time entry label.
2 input parameters
3 output parameters
Delete a time entry from a Workspace.
3 input parameters
3 output parameters
View a single time entry. \ \ ***Note:** A time entry that has a negative duration means that timer is currently running for that user.*
5 input parameters
3 output parameters
Update the details of a time entry.
4 input parameters
3 output parameters
View a list of changes made to a time entry.
3 input parameters
3 output parameters
Invite someone to join your Workspace as a member. To invite someone as a guest, use the [Invite Guest](ref:inviteguesttoworkspace) endpoint.\ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
2 input parameters
3 output parameters
Deactivate a user from a Workspace. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
2 input parameters
3 output parameters
View information about a user in a Workspace. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
3 input parameters
3 output parameters
Update a user's name and role. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*
3 input parameters
3 output parameters
View the task and page views available at the Everything Level of a Workspace.
1 input parameter
3 output parameters
Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view at the Everything Level of a Workspace.
2 input parameters
3 output parameters
View the webhooks created via the API for a Workspace. This endpoint returns webhooks created by the authenticated user.
1 input parameter
3 output parameters
Set up a webhook to monitor for events.<br> We do not have a dedicated IP address for webhooks. We use our domain name and dynamic addressing.
2 input parameters
3 output parameters
View the details of the authenticated user's ClickUp account.
None
3 output parameters
Use this tool to delete delete view
1 input parameter
3 output parameters
View information about a specific task or page view.
1 input parameter
3 output parameters
Rename a view, update the grouping, sorting, filters, columns, and settings of a view.
2 input parameters
3 output parameters
View comments from a Chat view. \ \ If you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\ \ Use the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.
3 input parameters
3 output parameters
Add a new comment to a Chat view.
2 input parameters
3 output parameters
See all visible tasks in a view in ClickUp.
2 input parameters
3 output parameters
Delete a webhook to stop monitoring the events and locations of the webhook.
1 input parameter
3 output parameters
Update a webhook to change the events to be monitored.
2 input parameters
3 output parameters
View the Docs in your Workspace. You can only view information of Docs you can access.
9 input parameters
3 output parameters
Create a new Doc.
2 input parameters
3 output parameters
View information about a Doc.
2 input parameters
3 output parameters
View the PageListing for a Doc.
3 input parameters
3 output parameters
View pages belonging to a Doc.
4 input parameters
3 output parameters
Create a page in a Doc.
3 input parameters
3 output parameters
View the information about a page in a Doc. Due to markdown format limitations, some content elements [will not be displayed exactly as they appear in ClickUp.](doc:docsimportexportlimitations/)
4 input parameters
3 output parameters
Edit a page in a Doc.
4 input parameters
3 output parameters
Create Workspace-level audit logs. Audit logs can only be created by the Workspace owner on Enterprise Plans.
2 input parameters
3 output parameters
This endpoint retrieves the Channels in a Workspace.
8 input parameters
3 output parameters
This endpoint creates a new Channel not tied to a Space, Folder, or List. If a Channel with the specified name already exists it returns it.
2 input parameters
3 output parameters
This endpoint creates a new Direct Message between up to 10 users. If a Direct Message between those users already exists it returns it.
2 input parameters
3 output parameters
This endpoint creates a Channel and when a Channel already exists on the requested location, it returns it.
2 input parameters
3 output parameters
This endpoint deletes a Channel. Applies to Channels tied to a Space, Folder, or List or not tied to locations.
2 input parameters
3 output parameters
This endpoint retrieves a specific Channel given its ID.
3 input parameters
3 output parameters
This endpoint updates a single Channel.
3 input parameters
3 output parameters
This endpoint retrieves followers of a specific Channel given its ID.
4 input parameters
3 output parameters
This endpoint retrieves members of a specific Channel given its ID.
4 input parameters
3 output parameters
This endpoint retrieves messages for a specified Channel.
5 input parameters
3 output parameters
This endpoint creates a top level message.
3 input parameters
3 output parameters
This endpoint deletes a message.
2 input parameters
3 output parameters
This endpoint updates a message.
3 input parameters
3 output parameters
This endpoint retrieves reactions for a message
4 input parameters
3 output parameters
This endpoint creates a message reaction using lower case emoji names.
3 input parameters
3 output parameters
This endpoint deletes a message reaction.
3 input parameters
3 output parameters
This endpoint retrieves replies to a message.
5 input parameters
3 output parameters
This endpoint creates a reply message.
3 input parameters
3 output parameters
This endpoint retrieves tagged users for a message
4 input parameters
3 output parameters
Update the privacy and access settings of an object or location in the Workspace. Note that sharing an item may incur charges.
4 input parameters
3 output parameters