ClickUp

ClickUp unifies tasks, docs, goals, and chat in a single platform, allowing teams to plan, organize, and collaborate across projects with customizable workflows clickup · 164 tools · 21 triggers

Connect it

run auth clickup
run auth clickup --scope team    # shared with the organization

Or from the Integrations page in the console. See Connections for personal versus shared, and who may remove one.

Use it

run clickup          # common commands
run clickup --all    # every command

import { clickup } from "@boxd/run";

Common tools

Tool	What it does
`create-doc`	Tool to create a new ClickUp Doc in a Workspace (v3 Docs API) and return the new doc_id for follow-up page/content operations.
`create-doc-page`	Tool to create a page in a ClickUp Doc (v3 Docs API). Use when you need to add a new page to an existing document, either as a root page or as a…
`create-folder`	Creates a new ClickUp Folder within the specified Space, which must exist and be accessible.
`create-list`	Creates a new list in ClickUp within an existing folder. This action requires a folder_id - lists cannot be created directly in a Space using this action.
`create-task`	Creates a new ClickUp task in a specific list, optionally as a subtask if a `parent` task ID (which cannot be a subtask itself and must be in the same list) is provided.
`create-task-comment`	Adds a comment to a ClickUp task; `team_id` is required if `custom_task_ids` is true.
`create-threaded-comment`	Tool to create a threaded reply to a comment in ClickUp. Use when you need to respond to an existing comment with context.
`delete-chat-channel`	Tool to delete a chat channel in ClickUp. Use when you need to permanently remove a chat channel from a workspace.
`delete-task`	Permanently deletes a task, using its standard ID or a custom task ID (requires `custom_task_ids=true` and `team_id`).
`get-doc-page-content`	Tool to fetch a single ClickUp Doc page’s content and metadata by workspace_id + doc_id + page_id (v3 Docs API).
`get-task`	Retrieves comprehensive details for a ClickUp task by its ID, supporting standard or custom task IDs (requires `team_id` for custom IDs).
`move-task-to-home-list`	Tool to move a task to a new home List using ClickUp Public API v3.
`update-task`	Updates attributes of an existing task; `team_id` is required if `custom_task_ids` is true, use a single space (” ”) for `description` to clear it…

All 164 tools

Tool	What it does
`add-dependency`	Adds a ‘waiting on’ or ‘blocking’ dependency to a task, requiring either `depends_on` (task becomes waiting on) or `dependency_of` (task becomes…
`add-guest-to-folder`	Adds a guest to a folder with specified permissions; requires a ClickUp Enterprise Plan.
`add-guest-to-list`	Shares a ClickUp List with an existing guest user, granting them specified permissions; requires the Workspace to be on the ClickUp Enterprise Plan.
`add-guest-to-task`	Assigns a guest to a task with specified permissions; requires ClickUp Enterprise Plan, and `team_id` if `custom_task_ids` is true.
`add-tags-to-time-entries`	Associates a list of specified tags with one or more time entries within a given Team (Workspace).
`add-tag-to-task`	Adds an existing tag to a specified task; team_id is required if custom_task_ids is true.
`add-task-link`	Links two existing and accessible ClickUp tasks, identified by `task_id` (source) and `links_to` (target).
`add-task-to-list`	Adds an existing task to an additional ClickUp List; the “Tasks in Multiple Lists” ClickApp must be enabled in the Workspace for this.
`attachments-upload-file-to-task-as-attachment`	DEPRECATED: Use `create_task_attachment` to upload a file to a task; requires `multipart/form-data`.
`authorization-get-work-space-list`	DEPRECATED: Use `get_authorized_teams_workspaces` instead to retrieve Workspaces (Teams) accessible to the authenticated user.
`click-up-update-doc-page`	Tool to update/edit a ClickUp Doc page’s title and/or content via the v3 Docs API.
`create-time-entry`	Creates a new time entry for a specified team.
`create-chat-channel`	Tool to create a chat channel in a ClickUp workspace. Use when you need to set up a new communication channel for team collaboration with configurable visibility.
`create-chat-message`	Tool to send a message in a ClickUp chat channel. Use when you need to post messages to team chat channels.
`create-chat-reaction`	Tool to add a reaction to a ClickUp chat message. Use when you need to react to a message with an emoji.
`create-chat-view-comment`	Posts a new comment to a specified ClickUp Chat view; the ‘view_id’ must correspond to an existing and accessible Chat view.
`create-checklist`	Creates a new checklist with a specified name within an existing task, which can be identified by its standard ID or a custom task ID (if…
`create-checklist-item`	Creates a new checklist item within a specified, existing checklist, optionally setting the item’s name and assigning it to a user.
`create-direct-message-channel`	Tool to create a direct message channel in ClickUp. Use when you need to start a direct message conversation with up to 15 users.
`create-doc`	Tool to create a new ClickUp Doc in a Workspace (v3 Docs API) and return the new doc_id for follow-up page/content operations.
`create-doc-page`	Tool to create a page in a ClickUp Doc (v3 Docs API). Use when you need to add a new page to an existing document, either as a root page or as a…
`create-folder`	Creates a new ClickUp Folder within the specified Space, which must exist and be accessible.
`create-folderless-list`	Creates a new folderless list (a list not part of any Folder) directly within a specified ClickUp Space.
`create-folder-view`	Creates a new, highly customizable view within a specific ClickUp folder using its `folder_id`.
`create-goal`	Creates a new goal in a ClickUp Team (Workspace).
`create-key-result`	Creates a new Key Result (Target) for a specified Goal in ClickUp to define and track measurable objectives towards achieving that Goal.
`create-list`	Creates a new list in ClickUp within an existing folder. This action requires a folder_id - lists cannot be created directly in a Space using this action.
`create-list-comment`	Adds a new comment with specific text to an existing and accessible ClickUp List, assigns it to a user, and sets notification preferences for all list members.
`create-list-from-template`	Creates a new list from a template in a specified ClickUp folder.
`create-list-view`	Creates a new, customizable view (e.g., list, board, calendar) within a specified ClickUp List, requiring an existing list_id accessible by the user.
`create-location-chat-channel`	Tool to create a Channel on a Space, Folder, or List in ClickUp.
`create-reply-message`	Tool to create a reply to a chat message in ClickUp. Use when replying to an existing chat message.
`create-space`	Creates a new ClickUp Space within a specified Workspace, allowing feature configuration which defaults to Workspace settings if unspecified.
`create-space-tag`	Creates a new tag (name, foreground color, background color) in an existing ClickUp Space.
`create-space-view`	Creates a customizable view (e.g., List, Board, Gantt) within a specified ClickUp Space, allowing configuration of grouping, sorting, filtering, and display settings.
`create-task`	Creates a new ClickUp task in a specific list, optionally as a subtask if a `parent` task ID (which cannot be a subtask itself and must be in the same list) is provided.
`create-task-attachment`	Uploads a file as an attachment to a specified ClickUp task using multipart/form-data.
`create-task-comment`	Adds a comment to a ClickUp task; `team_id` is required if `custom_task_ids` is true.
`create-task-from-template`	Creates a new task in a specified ClickUp list from a task template, using the provided name for the new task.
`create-team`	Creates a new team (user group) with specified members in a Workspace; member IDs must be for existing users, and be aware that adding view-only…
`create-threaded-comment`	Tool to create a threaded reply to a comment in ClickUp. Use when you need to respond to an existing comment with context.
`create-webhook`	Creates a ClickUp webhook for a Team (Workspace) to notify a public URL on specified events (at least one, or ’*’ for all), optionally scoped to a…
`create-workspace-everything-level-view`	Creates a new, customizable view (e.g., List, Board) at the ‘Everything’ level for a specified Team (Workspace ID), encompassing all tasks within that Workspace.
`delete-chat-channel`	Tool to delete a chat channel in ClickUp. Use when you need to permanently remove a chat channel from a workspace.
`delete-chat-message`	Tool to delete a chat message in ClickUp. Use when you need to permanently remove a specific message from a workspace chat.
`delete-chat-reaction`	Tool to delete a reaction from a chat message in ClickUp. Use when you need to remove an emoji reaction that was previously added to a chat message.
`delete-checklist`	Permanently deletes an existing checklist identified by its `checklist_id`.
`delete-checklist-item`	Permanently deletes an existing item, identified by `checklist_item_id`, from an existing checklist, identified by `checklist_id`.
`delete-comment`	Deletes an existing comment from a task using its `comment_id`.
`delete-dependency`	Removes a dependency relationship for a task. Provide exactly one of: `depends_on` to remove a ‘waiting on’ dependency (task_id is blocked by another…
`delete-folder`	Permanently and irreversibly deletes a specified folder and all its contents (Lists, Tasks) if the folder_id exists.
`delete-goal`	Permanently removes an existing Goal, identified by its `goal_id`, from the Workspace.
`delete-key-result`	Deletes an existing Key Result, also referred to as a Target within a Goal, identified by its `key_result_id`.
`delete-list`	Permanently deletes an existing List and all its contents; this action is destructive and irreversible via the API.
`delete-space`	Permanently deletes a specified Space in ClickUp; this action is irreversible as the Space cannot be recovered via the API.
`delete-space-tag`	Deletes a Tag from a Space, identified by `tag_name` in path; precise matching of Tag details in the request body (`tag_name_1`, `tag_tag_fg`…
`delete-task`	Permanently deletes a task, using its standard ID or a custom task ID (requires `custom_task_ids=true` and `team_id`).
`delete-task-link`	Deletes an existing link, effectively a dependency or relationship, between two ClickUp tasks; set `custom_task_ids=true` and provide `team_id` if using custom task IDs.
`delete-team`	Permanently deletes an existing Team (user group) from the Workspace using its `group_id`.
`delete-time-entry`	Deletes an existing time entry, specified by `timer_id`, from a Workspace identified by `team_id`.
`delete-time-tracked`	Deletes a time-tracked interval from a task; use this legacy endpoint for older time tracking systems.
`delete-view`	Permanently and irreversibly deletes an existing View in ClickUp, identified by its `view_id`.
`delete-webhook`	Permanently removes an existing webhook, specified by its ID, thereby ceasing all its event monitoring and notifications.
`get-accessible-custom-fields`	Retrieves all accessible Custom Field definitions for a specified ClickUp List using its `list_id`.
`get-access-token`	Exchanges a ClickUp OAuth 2.0 authorization code (obtained after user consent) for an access token.
`get-all-tags-from-time-entries`	Retrieves all unique tags applied to time entries within a specified ClickUp Team (Workspace).
`get-authorized-teams-workspaces`	Retrieves a list of Workspaces (Teams) the authenticated user can access.
`get-authorized-user`	Retrieves the details of the currently authenticated ClickUp user.
`get-bulk-tasks-time-in-status`	Retrieves the time spent in each status for multiple tasks; requires the ‘Total time in Status’ ClickApp to be enabled in the Workspace.
`get-chat-channel`	Retrieves details for a specific chat channel in a ClickUp Workspace.
`get-chat-channel-followers`	Tool to retrieve followers of a ClickUp chat channel. Use when you need to list users following a specific channel in a workspace.
`get-chat-channel-members`	Tool to get members of a chat channel. Use when you need to retrieve the list of members in a specific ClickUp chat channel.
`get-chat-channels`	Tool to retrieve chat channels in a ClickUp workspace. Use when you need to list available chat channels, DMs, or group chats in a workspace.
`get-chat-message-reactions`	Tool to retrieve reactions on a ClickUp chat message. Use when you need to see who reacted to a message and with what emoji.
`get-chat-message-replies`	Retrieves replies to a chat message in ClickUp. Use when you need to fetch responses to a specific message in a workspace chat.
`get-chat-messages`	Tool to retrieve messages from a ClickUp chat channel. Use when you need to fetch chat messages for a specific channel within a workspace.
`get-chat-message-tagged-users`	Tool to retrieve users tagged in a ClickUp chat message. Use when you need to get a list of users mentioned in a specific chat message.
`get-chat-view-comments`	Retrieves comments from a specified Chat view in ClickUp, supporting pagination via `start` and `start_id` to fetch comments older than the default 25 most recent.
`get-custom-roles`	Retrieves all Custom Roles, which allow granular permission configurations, for a specified Workspace (Team).
`get-custom-task-types`	Retrieves all custom task types available within a specified Workspace (team_id).
`get-doc-content`	Tool to fetch the full content of a ClickUp Doc including metadata and all page contents in markdown format.
`get-doc-page-content`	Tool to fetch a single ClickUp Doc page’s content and metadata by workspace_id + doc_id + page_id (v3 Docs API).
`get-doc-page-listing`	Tool to fetch the page listing structure of a ClickUp Doc by workspace_id and doc_id.
`get-doc-pages-public`	Tool to fetch pages belonging to a ClickUp Doc. Use when you need to list all pages in a doc with their content and structure.
`get-filtered-team-tasks`	Retrieves a paginated list of tasks (up to 100 per page) from a specified workspace based on various filter criteria, respecting user access permissions.
`get-folder`	Retrieves detailed information about a specific folder in ClickUp.
`get-folder-available-fields`	Tool to view custom fields available in a ClickUp folder. Use to discover what custom fields can be used when working with tasks in this folder.
`get-folderless-lists`	Retrieves all Lists within a specified Space that are not located in any Folder.
`get-folders`	Retrieves Folders within a specified ClickUp Space, ensuring `space_id` is valid, with an option to filter by archived status.
`get-folder-views`	Retrieves all configured views (like List, Board, Calendar) for a specified, existing Folder in ClickUp.
`get-goal`	Retrieves detailed information for an existing ClickUp Goal, specified by its unique `goal_id`.
`get-goals`	Retrieves goals for a specified ClickUp Workspace (Team); the `team_id` must be valid and accessible.
`get-guest`	Call this to retrieve detailed information for a specific guest within a Team (Workspace), ensuring the `guest_id` is valid for the given `team_id`…
`get-list`	Retrieves detailed information for an existing List in ClickUp, identified by its unique `list_id`.
`get-list-comments`	Retrieves comments for a specific ClickUp List, supporting pagination using `start` (timestamp) and `start_id` (comment ID) to fetch earlier…
`get-list-members`	Retrieves all members of a specific, existing ClickUp List by its ID.
`get-lists`	Retrieves all lists within a specified, existing ClickUp folder, optionally filtering by archived status.
`get-list-views`	Retrieves all task and page views for a specified and accessible ClickUp List.
`get-running-time-entry`	Retrieves the currently active time entry for a user in a Workspace; a negative ‘duration’ in its data indicates it’s running, and the response may…
`get-shared-hierarchy`	Retrieves the hierarchy of tasks, Lists, and Folders shared with the authenticated user within an existing ClickUp Team (Workspace), identified by its `team_id`.
`get-space`	Retrieves detailed information for an existing Space in a ClickUp Workspace, identified by its unique space_id.
`get-space-available-fields`	Retrieves all custom fields available in a ClickUp Space, identified by space_id.
`get-spaces`	Retrieves Spaces for a Team ID; member information for private Spaces is returned only if the authenticated user is a member.
`get-space-tags`	Retrieves all tags for tasks within a specified ClickUp Space, requiring a valid `space_id`.
`get-space-views`	Retrieves all task and page views for a specified Space ID in ClickUp.
`get-subtypes`	Tool to retrieve post subtype IDs (Announcement, Discussion, Idea, Update) for a ClickUp Workspace.
`get-task`	Retrieves comprehensive details for a ClickUp task by its ID, supporting standard or custom task IDs (requires `team_id` for custom IDs).
`get-task-comments`	Retrieves up to 25 comments for a specified task, supporting pagination using `start` and `start_id` to fetch older comments.
`get-task-members`	Retrieves users with explicit access (directly assigned or shared) to a specific existing task, excluding users with inherited permissions.
`get-tasks`	Retrieves tasks from a specified ClickUp list; only tasks whose home is the given list_id are returned.
`get-task-templates`	Retrieves task templates for a specified Workspace (Team ID), supporting pagination.
`get-task-time-in-status`	Retrieves the duration a task has spent in each status, provided the ‘Total time in Status’ ClickApp is enabled for the Workspace.
`get-team-available-fields`	Retrieves all custom fields available in a ClickUp Workspace (Team), identified by team_id.
`get-teams`	Retrieves user groups (Teams) from a ClickUp Workspace, typically requiring `team_id` (Workspace ID), with an option to filter by `group_ids`.
`get-threaded-comments`	Retrieves threaded replies to a parent comment. Use when you need to fetch conversation threads under a specific comment.
`get-time-entries-in-date-range`	Retrieves time entries for a specified Team (Workspace ID) within a date range (defaults to the last 30 days for the authenticated user if dates are…
`get-time-entry`	Fetches a specific time entry by its ID for a given team; a negative duration in the response indicates an active timer.
`get-time-entry-history`	Retrieves the modification history for an existing time entry within a specific ClickUp Team (Workspace).
`get-tracked-time`	Retrieves tracked time for a task using a legacy endpoint; prefer newer Time Tracking API endpoints for managing time entries.
`get-user`	Retrieves detailed information for a specific user within a ClickUp Workspace (Team), available only for Workspaces on the ClickUp Enterprise Plan.
`get-view`	Fetches details for a specific ClickUp view, identified by its `view_id`, which must exist.
`get-view-tasks`	Retrieves all tasks visible in a specified ClickUp view, respecting its applied filters, sorting, and grouping.
`get-webhooks`	Fetches webhooks for a Team (Workspace), returning only those created by the authenticated user via API, for a `team_id` they can access.
`get-workspace-everything-level-views`	Retrieves all task and page views at the ‘Everything Level’ (a comprehensive overview of all tasks across all Spaces) for a specified ClickUp Workspace.
`get-workspace-plan`	Retrieves the details of the current subscription plan for a specified ClickUp Workspace.
`get-workspace-seats`	Retrieves seat utilization (used, total, available for members/guests) for a ClickUp Workspace (Team) ID, which must be for an existing Workspace.
`invite-guest-to-workspace`	Invites a guest by email to a ClickUp Workspace (Team) on an Enterprise Plan, setting initial permissions and optionally a custom role; further…
`invite-user-to-workspace`	Invites a user via email to a ClickUp Workspace (Team), optionally granting admin rights or a custom role; requires an Enterprise Plan for the Workspace.
`move-task-to-home-list`	Tool to move a task to a new home List using ClickUp Public API v3.
`remove-custom-field-value`	Removes an existing value from a Custom Field on a specific task; this does not delete the Custom Field definition or its predefined options.
`remove-guest-from-folder`	Revokes a guest’s access to a specific ClickUp Folder, optionally unsharing items explicitly shared with them within it; requires an Enterprise Plan.
`remove-guest-from-list`	Revokes a guest’s access to a specific List, provided the guest currently has access to this List and the Workspace is on the ClickUp Enterprise Plan.
`remove-guest-from-task`	Revokes a guest’s access to a specific task; only available for Workspaces on the ClickUp Enterprise Plan.
`remove-guest-from-workspace`	Permanently removes a guest from a specified Workspace, revoking all their access; this destructive operation requires the Workspace to be on the ClickUp Enterprise Plan.
`remove-tag-from-task`	Removes a tag from a specified task by disassociating it (does not delete the tag from Workspace), succeeding even if the tag is not on the task.
`remove-tags-from-time-entries`	Removes tags from specified time entries in a team, without deleting the tags from the workspace.
`remove-task-from-list`	Removes a task from an extra list (not its home list); the ‘Tasks in Multiple Lists’ ClickApp must be enabled.
`remove-user-from-workspace`	Deactivates a user from a specified ClickUp Workspace, revoking their access (user can be reactivated later); requires the Workspace to be on an Enterprise Plan.
`search-docs`	Tool to search and list Docs metadata in a ClickUp workspace.
`set-custom-field-value`	Sets or updates a Custom Field’s value for a task; the new value (with type-dependent structure, e.g., `{"value": "text"}` or `{“value”: 123…
`start-time-entry`	Starts a new time entry (timer) in the specified Team (Workspace), optionally associating it with a task, adding a description, setting billable…
`stop-time-entry`	Stops the authenticated user’s currently active time entry in the specified Team (Workspace), which requires an existing time entry to be running.
`track-time`	Records a time entry for a task using ClickUp’s legacy time tracking system; newer endpoints are generally recommended.
`update-chat-channel`	Tool to update a ClickUp chat channel’s properties including name, topic, description, visibility, and location.
`update-chat-message`	Tool to update a ClickUp chat message’s content, assignee, or resolved status via the v3 API.
`update-checklist`	Updates an existing checklist’s name or position, identified by its `checklist_id`.
`update-checklist-item`	Updates an existing checklist item, allowing modification of its name, assignee, resolution status, or parent item for nesting.
`update-comment`	Updates an existing task comment’s text, assignee (who must be a valid workspace member), or resolution status, requiring a valid existing comment_id.
`update-folder`	Updates the name of an existing folder in ClickUp.
`update-goal`	Updates attributes of an existing ClickUp goal, identified by its `goal_id`.
`update-guest-on-workspace`	Modifies the details and permissions of an existing guest user within a specific Workspace.
`update-key-result`	Updates an existing key result’s progress or note in ClickUp, where the key result measures progress towards a goal.
`update-list`	Updates attributes of an existing ClickUp list, such as its name, content, due date, priority, assignee, or color status, identified by its `list_id`.
`update-space`	Updates an existing ClickUp Space, allowing modification of its name, color, privacy, and feature settings (ClickApps).
`update-space-tag`	Updates an existing tag’s name and colors in a ClickUp Space; requires current tag name for identification, and new values for tag name, foreground…
`update-task`	Updates attributes of an existing task; `team_id` is required if `custom_task_ids` is true, use a single space (” ”) for `description` to clear it…
`update-team`	Updates an existing ClickUp User Group (Team) using its `group_id`; note that adding a view-only guest as a paid member may incur charges.
`update-time-entry`	Updates an existing ClickUp time entry. Requires team_id (workspace ID) and timer_id (time entry ID).
`update-time-entry-tag`	Updates the name, background color, and/or foreground color for an existing time entry tag, identified by its current `name` and `team_id`.
`update-time-tracked`	Edits a legacy time-tracked interval for a task (identified by `task_id` and `interval_id`) to update its start/end times and duration; `team_id` is…
`update-user-on-workspace`	Updates a user’s username, admin status, or custom role in a Workspace; requires the Workspace to be on an Enterprise Plan.
`update-view`	Updates an existing ClickUp view’s settings such as name, type, grouping, or filters; ensure `parent_id` and `parent_type` define a valid hierarchy…
`update-webhook`	Updates the endpoint URL, monitored events, and status of an existing webhook, identified by its `webhook_id`.
`update-workspace-acl`	Updates privacy and access control list (ACL) permissions for a workspace object or location.

Triggers (21)

Subscribe with .on(...) in a script. A trigger with required configuration takes it as the second argument.

Trigger	Needs	What fires it
Folder Created	`workspace_id`	Triggers when a new Folder is created.
Folder Deleted	`workspace_id`	Triggers when a Folder is deleted.
Folder Updated	`workspace_id`	Triggers when a Folder is updated (renamed, content edited, etc.).
List Created	`workspace_id`	Triggers when a new List is created.
List Deleted	`workspace_id`	Triggers when a List is deleted.
List Updated	`workspace_id`	Triggers when a List is updated (renamed, content edited, etc.).
Space Created	`workspace_id`	Triggers when a new Space is created in the Workspace.
Space Deleted	`workspace_id`	Triggers when a Space is deleted.
Space Updated	`workspace_id`	Triggers when a Space is updated (renamed, settings changed, etc.).
Task Assignee Updated	`workspace_id`	Triggers when an assignee is added to or removed from a task.
Task Comment Posted	`workspace_id`	Triggers when a comment is added to a task.
Task Comment Updated	`workspace_id`	Triggers when an existing comment on a task is edited.
Task Created	`workspace_id`	Triggers when a new task is created in the configured Workspace.
Task Deleted	`workspace_id`	Triggers when a task is deleted.
Task Due Date Updated	`workspace_id`	Triggers when a task’s due date is set, changed, or cleared.
Task Priority Updated	`workspace_id`	Triggers when a task’s priority changes.
Task Status Updated	`workspace_id`	Triggers when a task’s status changes.
Task Tag Updated	`workspace_id`	Triggers when a tag is added to or removed from a task.
Task Time Estimate Updated	`workspace_id`	Triggers when a task’s time estimate is set, changed, or cleared.
Task Time Tracked Updated	`workspace_id`	Triggers when a time-tracking interval is created, edited, or deleted on a task.
Task Updated	`workspace_id`	Triggers when a task is updated.

Open ClickUp in the console →

Getting started

Guides

Integrations & automations

Use cases

References

Connect it

Use it

Common tools

Triggers (21)

​Connect it

​Use it

​Common tools

​Triggers (21)

Connect it

Use it

Common tools

Triggers (21)