Docs · static mirror — the interactive version loads with JavaScript.

ClickUp

Source: https://runstack.engineer/docs/toolkits/clickup

Tasks, lists, docs, chat, goals, time tracking, webhooks and teams.

Tools (164):

ToolDescription
clickupGetAccessTokenExchanges a ClickUp OAuth 2.0 authorization code (obtained after user consent) for an access token.
clickupCreateChatChannelTool 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.
clickupCreateChatMessageTool to send a message in a ClickUp chat channel. Use when you need to post messages to team chat channels. Supports both regular messages and structured posts with optional assignments, followers, and reactions.
clickupCreateChatReactionTool to add a reaction to a ClickUp chat message. Use when you need to react to a message with an emoji.
clickupCreateDirectMessageChannelTool to create a direct message channel in ClickUp. Use when you need to start a direct message conversation with up to 15 users. A Self DM is created when no user IDs are provided.
clickupCreateLocationChatChannelTool to create a Channel on a Space, Folder, or List in ClickUp. Use when you need to create a location-based chat channel.
clickupCreateReplyMessageTool to create a reply to a chat message in ClickUp. Use when replying to an existing chat message. Requires workspace_id, message_id, type, and content.
clickupDeleteChatChannelTool to delete a chat channel in ClickUp. Use when you need to permanently remove a chat channel from a workspace.
clickupDeleteChatMessageTool to delete a chat message in ClickUp. Use when you need to permanently remove a specific message from a workspace chat.
clickupDeleteChatReactionTool 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.
clickupGetChatChannelRetrieves details for a specific chat channel in a ClickUp Workspace. Use when you need information about a particular chat channel.
clickupGetChatChannelFollowersTool to retrieve followers of a ClickUp chat channel. Use when you need to list users following a specific channel in a workspace.
clickupGetChatChannelMembersTool to get members of a chat channel. Use when you need to retrieve the list of members in a specific ClickUp chat channel.
clickupGetChatChannelsTool to retrieve chat channels in a ClickUp workspace. Use when you need to list available chat channels, DMs, or group chats in a workspace. Supports pagination via cursor and filtering by follower status, closed channels, and recent activity.
clickupGetChatMessageReactionsTool to retrieve reactions on a ClickUp chat message. Use when you need to see who reacted to a message and with what emoji.
clickupGetChatMessageRepliesRetrieves replies to a chat message in ClickUp. Use when you need to fetch responses to a specific message in a workspace chat.
clickupGetChatMessagesTool to retrieve messages from a ClickUp chat channel. Use when you need to fetch chat messages for a specific channel within a workspace.
clickupGetChatMessageTaggedUsersTool 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.
clickupGetSubtypesTool to retrieve post subtype IDs (Announcement, Discussion, Idea, Update) for a ClickUp Workspace. Use when you need subtype IDs to send messages with type: post.
clickupUpdateChatChannelTool to update a ClickUp chat channel's properties including name, topic, description, visibility, and location. Use when you need to modify an existing chat channel's settings. The endpoint requires both workspace_id and channel_id.
clickupUpdateChatMessageTool to update a ClickUp chat message's content, assignee, or resolved status via the v3 API. Use when you need to edit an existing chat message.
clickupUpdateWorkspaceAclUpdates privacy and access control list (ACL) permissions for a workspace object or location. Use this to make objects private/public or manage user/team permissions for spaces, folders, lists, tasks, and other ClickUp objects.
clickupCreateChecklistCreates 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 custom_task_ids is true, team_id is also required).
clickupCreateChecklistItemCreates a new checklist item within a specified, existing checklist, optionally setting the item's name and assigning it to a user.
clickupDeleteChecklistPermanently deletes an existing checklist identified by its checklist_id.
clickupDeleteChecklistItemPermanently deletes an existing item, identified by checklist_item_id, from an existing checklist, identified by checklist_id.
clickupUpdateChecklistUpdates an existing checklist's name or position, identified by its checklist_id.
clickupUpdateChecklistItemUpdates an existing checklist item, allowing modification of its name, assignee, resolution status, or parent item for nesting.
clickupCreateChatViewCommentPosts a new comment to a specified ClickUp Chat view; the 'view_id' must correspond to an existing and accessible Chat view.
clickupCreateListCommentAdds 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.
clickupCreateTaskCommentAdds a comment to a ClickUp task; team_id is required if custom_task_ids is true.
clickupCreateThreadedCommentTool to create a threaded reply to a comment in ClickUp. Use when you need to respond to an existing comment with context.
clickupDeleteCommentDeletes an existing comment from a task using its comment_id.
clickupGetChatViewCommentsRetrieves 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.
clickupGetListCommentsRetrieves comments for a specific ClickUp List, supporting pagination using start (timestamp) and start_id (comment ID) to fetch earlier comments; omits them for the latest 25.
clickupGetTaskCommentsRetrieves up to 25 comments for a specified task, supporting pagination using start and start_id to fetch older comments.
clickupGetThreadedCommentsRetrieves threaded replies to a parent comment. Use when you need to fetch conversation threads under a specific comment.
clickupUpdateCommentUpdates an existing task comment's text, assignee (who must be a valid workspace member), or resolution status, requiring a valid existing comment_id.
clickupClickUpUpdateDocPageTool to update/edit a ClickUp Doc page's title and/or content via the v3 Docs API. Use when you need to modify a Doc page's name or content programmatically.
clickupCreateDocTool to create a new ClickUp Doc in a Workspace (v3 Docs API) and return the new doc_id for follow-up page/content operations. Use when you need to create a new document in ClickUp.
clickupCreateDocPageTool 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 sub-page under a parent page.
clickupGetDocContentTool to fetch the full content of a ClickUp Doc including metadata and all page contents in markdown format. Use when you need to read or summarize a Doc's content given workspace_id and doc_id.
clickupGetDocPageContentTool to fetch a single ClickUp Doc page's content and metadata by workspace_id + doc_id + page_id (v3 Docs API). Use when you need to read the content of a specific page without fetching the entire Doc.
clickupGetDocPageListingTool to fetch the page listing structure of a ClickUp Doc by workspace_id and doc_id. Use when you need to discover the hierarchical structure of pages and subpages within a Doc without fetching the actual content.
clickupGetDocPagesPublicTool to fetch pages belonging to a ClickUp Doc. Use when you need to list all pages in a doc with their content and structure.
clickupSearchDocsTool to search and list Docs metadata in a ClickUp workspace. Use after confirming the workspace ID to quickly locate relevant meeting notes before fetching pages.
clickupAttachmentsUploadFileToTaskAsAttachmentDEPRECATED: Use create_task_attachment to upload a file to a task; requires multipart/form-data.
clickupCreateTaskAttachmentUploads a file as an attachment to a specified ClickUp task using multipart/form-data.
clickupCreateFolderCreates a new ClickUp Folder within the specified Space, which must exist and be accessible.
clickupDeleteFolderPermanently and irreversibly deletes a specified folder and all its contents (Lists, Tasks) if the folder_id exists.
clickupGetFolderRetrieves detailed information about a specific folder in ClickUp.
clickupGetFoldersRetrieves Folders within a specified ClickUp Space, ensuring space_id is valid, with an option to filter by archived status.
clickupUpdateFolderUpdates the name of an existing folder in ClickUp.
clickupCreateGoalCreates a new goal in a ClickUp Team (Workspace).
clickupCreateKeyResultCreates a new Key Result (Target) for a specified Goal in ClickUp to define and track measurable objectives towards achieving that Goal.
clickupDeleteGoalPermanently removes an existing Goal, identified by its goal_id, from the Workspace.
clickupDeleteKeyResultDeletes an existing Key Result, also referred to as a Target within a Goal, identified by its key_result_id.
clickupGetGoalRetrieves detailed information for an existing ClickUp Goal, specified by its unique goal_id.
clickupGetGoalsRetrieves goals for a specified ClickUp Workspace (Team); the team_id must be valid and accessible.
clickupUpdateGoalUpdates attributes of an existing ClickUp goal, identified by its goal_id.
clickupUpdateKeyResultUpdates an existing key result's progress or note in ClickUp, where the key result measures progress towards a goal.
clickupCreateFolderlessListCreates a new folderless list (a list not part of any Folder) directly within a specified ClickUp Space.
clickupCreateListCreates 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. If you need to create a list directly in a Space (without placing it in a folder), use the 'CLICKUP_CREATE_FOLDERLESS_LIST' action with space_id instead.
clickupCreateListFromTemplateCreates a new list from a template in a specified ClickUp folder. Use this when you need to instantiate a list based on an existing template within a folder structure.
clickupDeleteListPermanently deletes an existing List and all its contents; this action is destructive and irreversible via the API.
clickupGetFolderlessListsRetrieves all Lists within a specified Space that are not located in any Folder.
clickupGetListRetrieves detailed information for an existing List in ClickUp, identified by its unique list_id.
clickupGetListMembersRetrieves all members of a specific, existing ClickUp List by its ID.
clickupGetListsRetrieves all lists within a specified, existing ClickUp folder, optionally filtering by archived status.
clickupUpdateListUpdates attributes of an existing ClickUp list, such as its name, content, due date, priority, assignee, or color status, identified by its list_id.
clickupCreateSpaceCreates a new ClickUp Space within a specified Workspace, allowing feature configuration which defaults to Workspace settings if unspecified.
clickupCreateSpaceTagCreates a new tag (name, foreground color, background color) in an existing ClickUp Space.
clickupDeleteSpacePermanently deletes a specified Space in ClickUp; this action is irreversible as the Space cannot be recovered via the API.
clickupDeleteSpaceTagDeletes 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, tag_tag_bg) is generally required for successful deletion.
clickupGetSpaceRetrieves detailed information for an existing Space in a ClickUp Workspace, identified by its unique space_id.
clickupGetSpacesRetrieves Spaces for a Team ID; member information for private Spaces is returned only if the authenticated user is a member.
clickupGetSpaceTagsRetrieves all tags for tasks within a specified ClickUp Space, requiring a valid space_id.
clickupUpdateSpaceUpdates an existing ClickUp Space, allowing modification of its name, color, privacy, and feature settings (ClickApps).
clickupUpdateSpaceTagUpdates an existing tag's name and colors in a ClickUp Space; requires current tag name for identification, and new values for tag name, foreground color, and background color, all of which are mandatory for the update.
clickupAddDependencyAdds a 'waiting on' or 'blocking' dependency to a task, requiring either depends_on (task becomes waiting on) or dependency_of (task becomes blocking), but not both; team_id is required if custom_task_ids is true.
clickupAddTagToTaskAdds an existing tag to a specified task; team_id is required if custom_task_ids is true.
clickupAddTaskLinkLinks two existing and accessible ClickUp tasks, identified by task_id (source) and links_to (target).
clickupAddTaskToListAdds an existing task to an additional ClickUp List; the 'Tasks in Multiple Lists' ClickApp must be enabled in the Workspace for this.
clickupCreateTaskCreates 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.
clickupCreateTaskFromTemplateCreates a new task in a specified ClickUp list from a task template, using the provided name for the new task.
clickupDeleteDependencyRemoves a dependency relationship for a task. Provide exactly one of: depends_on to remove a 'waiting on' dependency (task_id is blocked by another task), or dependency_of to remove a 'blocking' dependency (another task is blocked by task_id). team_id is required if custom_task_ids is true.
clickupDeleteTaskPermanently deletes a task, using its standard ID or a custom task ID (requires custom_task_ids=true and team_id).
clickupDeleteTaskLinkDeletes 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.
clickupGetAccessibleCustomFieldsRetrieves all accessible Custom Field definitions for a specified ClickUp List using its list_id.
clickupGetBulkTasksTimeInStatusRetrieves the time spent in each status for multiple tasks; requires the 'Total time in Status' ClickApp to be enabled in the Workspace.
clickupGetCustomTaskTypesRetrieves all custom task types available within a specified Workspace (team_id).
clickupGetFilteredTeamTasksRetrieves a paginated list of tasks (up to 100 per page) from a specified workspace based on various filter criteria, respecting user access permissions. Unexpectedly missing tasks may indicate permission restrictions rather than filter issues. Task comments are not included; use CLICKUP_GET_TASK_COMMENTS for complete context. No keyword/text search is supported; filter client-side on returned res
clickupGetFolderAvailableFieldsTool 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. Only returns folder-level custom fields, not list-level fields.
clickupGetSpaceAvailableFieldsRetrieves all custom fields available in a ClickUp Space, identified by space_id. Returns Space-level custom fields only.
clickupGetTaskRetrieves comprehensive details for a ClickUp task by its ID, supporting standard or custom task IDs (requires team_id for custom IDs).
clickupGetTaskMembersRetrieves users with explicit access (directly assigned or shared) to a specific existing task, excluding users with inherited permissions.
clickupGetTasksRetrieves tasks from a specified ClickUp list; only tasks whose home is the given list_id are returned. Closed and archived tasks are excluded by default. Key task attributes may appear only in the response custom_fields array, not top-level fields. Fields like space, folder, list, and custom_type may be absent; apply null checks. High-volume paginated calls may return HTTP 429; honor th
clickupGetTaskTemplatesRetrieves task templates for a specified Workspace (Team ID), supporting pagination.
clickupGetTaskTimeInStatusRetrieves the duration a task has spent in each status, provided the 'Total time in Status' ClickApp is enabled for the Workspace.
clickupGetTeamAvailableFieldsRetrieves all custom fields available in a ClickUp Workspace (Team), identified by team_id. Returns Workspace-level custom fields only.
clickupMoveTaskToHomeListTool to move a task to a new home List using ClickUp Public API v3. Use when you need to change a task's home list (not just add to additional lists).
clickupRemoveCustomFieldValueRemoves an existing value from a Custom Field on a specific task; this does not delete the Custom Field definition or its predefined options.
clickupRemoveTagFromTaskRemoves 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.
clickupRemoveTaskFromListRemoves a task from an extra list (not its home list); the 'Tasks in Multiple Lists' ClickApp must be enabled.
clickupSetCustomFieldValueSets or updates a Custom Field's value for a task; the new value (with type-dependent structure, e.g., {'value': 'text'} or {'value': 123, 'value_options': {'currency_type':'USD'}}) is provided in the JSON request body.
clickupUpdateTaskUpdates attributes of an existing task; team_id is required if custom_task_ids is true, use a single space (' ') for description to clear it, and provide at least one modifiable field.
clickupAddTagsToTimeEntriesAssociates a list of specified tags with one or more time entries within a given Team (Workspace).
clickupCreateATimeEntryCreates a new time entry for a specified team.
clickupDeleteTimeEntryDeletes an existing time entry, specified by timer_id, from a Workspace identified by team_id.
clickupDeleteTimeTrackedDeletes a time-tracked interval from a task; use this legacy endpoint for older time tracking systems.
clickupGetAllTagsFromTimeEntriesRetrieves all unique tags applied to time entries within a specified ClickUp Team (Workspace).
clickupGetRunningTimeEntryRetrieves 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 be empty if no entry is active.
clickupGetTimeEntriesInDateRangeRetrieves 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 omitted); active timers are indicated by negative durations in the response.
clickupGetTimeEntryFetches a specific time entry by its ID for a given team; a negative duration in the response indicates an active timer.
clickupGetTimeEntryHistoryRetrieves the modification history for an existing time entry within a specific ClickUp Team (Workspace).
clickupGetTrackedTimeRetrieves tracked time for a task using a legacy endpoint; prefer newer Time Tracking API endpoints for managing time entries.
clickupRemoveTagsFromTimeEntriesRemoves tags from specified time entries in a team, without deleting the tags from the workspace.
clickupStartTimeEntryStarts a new time entry (timer) in the specified Team (Workspace), optionally associating it with a task, adding a description, setting billable status, or applying tags (tags feature requires Business Plan or higher).
clickupStopTimeEntryStops the authenticated user's currently active time entry in the specified Team (Workspace), which requires an existing time entry to be running.
clickupTrackTimeRecords a time entry for a task using ClickUp's legacy time tracking system; newer endpoints are generally recommended.
clickupUpdateTimeEntryUpdates an existing ClickUp time entry. Requires team_id (workspace ID) and timer_id (time entry ID). Optional fields: description, tags, tag_action, start/end times, duration, tid (task ID), billable status. Note: start and end times should be provided together. This is an Advanced Time Tracking feature that may require a Business Plan or higher.
clickupUpdateTimeEntryTagUpdates the name, background color, and/or foreground color for an existing time entry tag, identified by its current name and team_id.
clickupUpdateTimeTrackedEdits 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 required if custom_task_ids is true.
clickupAddGuestToFolderAdds a guest to a folder with specified permissions; requires a ClickUp Enterprise Plan.
clickupAddGuestToListShares a ClickUp List with an existing guest user, granting them specified permissions; requires the Workspace to be on the ClickUp Enterprise Plan.
clickupAddGuestToTaskAssigns a guest to a task with specified permissions; requires ClickUp Enterprise Plan, and team_id if custom_task_ids is true.
clickupAuthorizationGetWorkSpaceListDEPRECATED: Use get_authorized_teams_workspaces instead to retrieve Workspaces (Teams) accessible to the authenticated user.
clickupCreateTeamCreates 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 guests as paid members may incur extra charges.
clickupDeleteTeamPermanently deletes an existing Team (user group) from the Workspace using its group_id.
clickupGetAuthorizedTeamsWorkspacesRetrieves a list of Workspaces (Teams) the authenticated user can access.
clickupGetAuthorizedUserRetrieves the details of the currently authenticated ClickUp user.
clickupGetCustomRolesRetrieves all Custom Roles, which allow granular permission configurations, for a specified Workspace (Team).
clickupGetGuestCall this to retrieve detailed information for a specific guest within a Team (Workspace), ensuring the guest_id is valid for the given team_id; this action requires the ClickUp Enterprise Plan.
clickupGetSharedHierarchyRetrieves the hierarchy of tasks, Lists, and Folders shared with the authenticated user within an existing ClickUp Team (Workspace), identified by its team_id.
clickupGetTeamsRetrieves user groups (Teams) from a ClickUp Workspace, typically requiring team_id (Workspace ID), with an option to filter by group_ids.
clickupGetUserRetrieves detailed information for a specific user within a ClickUp Workspace (Team), available only for Workspaces on the ClickUp Enterprise Plan.
clickupGetWorkspacePlanRetrieves the details of the current subscription plan for a specified ClickUp Workspace.
clickupGetWorkspaceSeatsRetrieves seat utilization (used, total, available for members/guests) for a ClickUp Workspace (Team) ID, which must be for an existing Workspace.
clickupInviteGuestToWorkspaceInvites a guest by email to a ClickUp Workspace (Team) on an Enterprise Plan, setting initial permissions and optionally a custom role; further access configuration for specific items may require separate actions.
clickupInviteUserToWorkspaceInvites a user via email to a ClickUp Workspace (Team), optionally granting admin rights or a custom role; requires an Enterprise Plan for the Workspace.
clickupRemoveGuestFromFolderRevokes a guest's access to a specific ClickUp Folder, optionally unsharing items explicitly shared with them within it; requires an Enterprise Plan.
clickupRemoveGuestFromListRevokes 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.
clickupRemoveGuestFromTaskRevokes a guest's access to a specific task; only available for Workspaces on the ClickUp Enterprise Plan.
clickupRemoveGuestFromWorkspacePermanently removes a guest from a specified Workspace, revoking all their access; this destructive operation requires the Workspace to be on the ClickUp Enterprise Plan.
clickupRemoveUserFromWorkspaceDeactivates a user from a specified ClickUp Workspace, revoking their access (user can be reactivated later); requires the Workspace to be on an Enterprise Plan.
clickupUpdateGuestOnWorkspaceModifies the details and permissions of an existing guest user within a specific Workspace.
clickupUpdateTeamUpdates an existing ClickUp User Group (Team) using its group_id; note that adding a view-only guest as a paid member may incur charges.
clickupUpdateUserOnWorkspaceUpdates a user's username, admin status, or custom role in a Workspace; requires the Workspace to be on an Enterprise Plan.
clickupCreateFolderViewCreates a new, highly customizable view within a specific ClickUp folder using its folder_id.
clickupCreateListViewCreates a new, customizable view (e.g., list, board, calendar) within a specified ClickUp List, requiring an existing list_id accessible by the user.
clickupCreateSpaceViewCreates a customizable view (e.g., List, Board, Gantt) within a specified ClickUp Space, allowing configuration of grouping, sorting, filtering, and display settings.
clickupCreateWorkspaceEverythingLevelViewCreates a new, customizable view (e.g., List, Board) at the 'Everything' level for a specified Team (Workspace ID), encompassing all tasks within that Workspace.
clickupDeleteViewPermanently and irreversibly deletes an existing View in ClickUp, identified by its view_id.
clickupGetFolderViewsRetrieves all configured views (like List, Board, Calendar) for a specified, existing Folder in ClickUp.
clickupGetListViewsRetrieves all task and page views for a specified and accessible ClickUp List.
clickupGetSpaceViewsRetrieves all task and page views for a specified Space ID in ClickUp.
clickupGetViewFetches details for a specific ClickUp view, identified by its view_id, which must exist.
clickupGetViewTasksRetrieves all tasks visible in a specified ClickUp view, respecting its applied filters, sorting, and grouping.
clickupGetWorkspaceEverythingLevelViewsRetrieves all task and page views at the 'Everything Level' (a comprehensive overview of all tasks across all Spaces) for a specified ClickUp Workspace.
clickupUpdateViewUpdates an existing ClickUp view's settings such as name, type, grouping, or filters; ensure parent_id and parent_type define a valid hierarchy, and that specified field names (e.g. for sorting, columns) are valid within the ClickUp workspace.
clickupCreateWebhookCreates 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 Space, Folder, List, or Task; the endpoint must accept requests from dynamic IPs.
clickupDeleteWebhookPermanently removes an existing webhook, specified by its ID, thereby ceasing all its event monitoring and notifications.
clickupGetWebhooksFetches webhooks for a Team (Workspace), returning only those created by the authenticated user via API, for a team_id they can access.
clickupUpdateWebhookUpdates the endpoint URL, monitored events, and status of an existing webhook, identified by its webhook_id.