Skip to main content
ClickUp logo
  • Category: productivity
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? Yes
  • Tools: 165
  • Triggers: 21
  • Slug: CLICKUP
  • Version: 20261101_00

Tools

Slug: CLICKUP_ADD_DEPENDENCYAdds 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.

Input Parameters

string
required
Unique identifier of the task to which a dependency relationship will be added.
string
Team ID, required if custom_task_ids is true to look up tasks by custom IDs (unique per team).
string
ID of the task that task_id will depend on (‘waiting on’ relationship). Use this or dependency_of, not both.
string
ID of the task that will depend on task_id (‘blocking’ relationship). Use this or depends_on, not both.
boolean
If true, task_id and related task IDs are custom (text-based), requiring team_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_ADD_GUEST_TO_FOLDERAdds a guest to a folder with specified permissions; requires a ClickUp Enterprise Plan.

Input Parameters

string
required
The unique identifier of the guest user to be added to the folder.
string
required
The unique identifier of the folder to which the guest will be added.
boolean
If true, include shared item details (API default if parameter is omitted); if false, exclude them.
string
required
Permission level for the guest. Options are ‘read’ (view only), ‘comment’, ‘edit’, or ‘create’ (full access).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_ADD_GUEST_TO_LISTShares a ClickUp List with an existing guest user, granting them specified permissions; requires the Workspace to be on the ClickUp Enterprise Plan.

Input Parameters

string
required
The unique identifier of the List to which the guest will be added.
string
required
The unique identifier of the guest user to be added to the List.
boolean
A boolean indicating whether to include details of items shared with the guest in the response. Set to false to exclude these details. If not provided or set to true (the API default), shared item details are included.
string
required
The permission level to be granted to the guest on this List. Accepted values are: read (view-only), comment (can add comments), edit (can edit existing items), or create (full access, including creating new items).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_ADD_GUEST_TO_TASKAssigns a guest to a task with specified permissions; requires ClickUp Enterprise Plan, and team_id if custom_task_ids is true.

Input Parameters

string
required
The unique identifier of the task to which the guest will be added.
string
Required if custom_task_ids is true to correctly identify the task when using a custom task ID.
string
required
The unique identifier of the guest user to be added to the task.
boolean
Optional. If set to false, details of items already shared with the guest will be excluded. The API defaults to true if this parameter is not explicitly set to false.
boolean
Optional. Set to true if you are referencing the task by its custom task ID. If true, team_id must also be provided.
string
required
Permission level for the guest on this task. Must be one of: read (view only), comment (view and comment), edit (view, comment, and edit), or create (full permissions).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_ADD_TAGS_TO_TIME_ENTRIESAssociates a list of specified tags with one or more time entries within a given Team (Workspace).

Input Parameters

array
required
A list of tag objects to add to the time entries. Each object should define the tag, typically including a ‘name’, and optionally ‘tag_fg’ (foreground color hex code) and ‘tag_bg’ (background color hex code).
integer
required
The ID of the Team (Workspace) where the time entries are located.
array
required
A list of unique string identifiers for the time entries to which the tags will be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_ADD_TAG_TO_TASKAdds an existing tag to a specified task; team_id is required if custom_task_ids is true.

Input Parameters

string
required
The ID of the task to which the tag will be added. This can be the standard task ID or a custom task ID if custom_task_ids is set to true.
integer
The ID of the team (formerly Workspace) to which the task belongs. This is required only if custom_task_ids is set to true. For example: custom_task_ids=true&team_id=123.
string
required
The name of the tag to add to the task. The tag must already exist in the workspace.
boolean
A boolean flag indicating whether the task_id provided is a custom task ID. If true, the team_id must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_ADD_TASK_TO_LISTAdds an existing task to an additional ClickUp List; the “Tasks in Multiple Lists” ClickApp must be enabled in the Workspace for this.

Input Parameters

integer
required
Unique identifier of the List to which the task will be added.
string
required
Unique identifier of the task to add to the List (actual task ID, not Custom Task ID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_ATTACHMENTS_UPLOAD_FILE_TO_TASK_AS_ATTACHMENTDEPRECATED: Use create_task_attachment to upload a file to a task; requires multipart/form-data.

Input Parameters

string
required
The unique identifier of the task to which the attachment will be added.
string
The ID of the team. This is required and used only if custom_task_ids is true to help locate the task by its custom ID. For example: custom_task_ids=true&team_id=123.
object
required
The file to be uploaded as an attachment. Note: Files stored in the cloud (URLs) cannot be used - actual file content must be provided.
boolean
If true, indicates that task_id should be interpreted as a custom task ID instead of the default ClickUp task ID. If this is true, team_id must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_AUTHORIZATION_GET_WORK_SPACE_LISTDEPRECATED: Use get_authorized_teams_workspaces instead to retrieve Workspaces (Teams) accessible to the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CLICK_UP_UPDATE_DOC_PAGETool 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.

Input Parameters

string
The new title/name for the page. If not provided, the page name will not be changed.
string
required
The unique identifier for the document containing the page.
string
The new content for the page in markdown format. If not provided, the page content will not be changed. Use this field to update, replace, or append to the page content.
string
required
The unique identifier for the page to update.
string
required
The workspace ID containing the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_A_TIME_ENTRYCreates a new time entry for a specified team.

Input Parameters

integer
Alias for stop. The end time of the time entry, as a Unix timestamp in milliseconds. If both start and end are provided, the API will use these to determine the entry’s actual duration, potentially overriding the duration field sent in the request.
string
The ID of the task to associate this time entry with. If custom_task_ids is true, this should be the custom task ID.
integer
The stop time of the time entry, as a Unix timestamp in milliseconds. If both start and stop are provided, the API will use these to determine the entry’s actual duration, potentially overriding the duration field sent in the request.
array
An array of Tag objects to apply to the time entry. Each Tag object should define ‘name’ (string), ‘tag_fg’ (hex color string for foreground), and ‘tag_bg’ (hex color string for background). This feature is available for users on the ClickUp Business Plan and above.
integer
required
The start time of the time entry, as a Unix timestamp in milliseconds.
string
required
The Workspace ID (also called Team ID in ClickUp API) where the time entry will be added. This goes in the URL path.
string
The ID of the Team, required only if custom_task_ids is set to true. This specifies the team context for the custom task ID. Example: custom_task_ids=true&team_id=123.
integer
The user ID of the person to assign this time entry to. Workspace owners and admins can assign to any user ID. Workspace members can only assign to their own user ID.
boolean
Indicates whether the time entry is billable. Set to true if billable, false or omit if not.
integer
required
The duration of the time entry in milliseconds. Note: If start and end (or stop) times are also provided in the request, the ClickUp API will calculate the duration based on start and end/stop, and this duration field’s value might be ignored or overridden by the server.
string
An optional description for the time entry.
boolean
If true, the tid parameter will be interpreted as a custom task ID. If this is true, the team_id query parameter must also be provided to specify the team context for the custom task ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_CHAT_CHANNELTool 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.

Input Parameters

string
required
The name for the chat channel being created.
string
The topic of the chat channel being created.
array
Optionally specify unique user IDs to add to the channel, up to 100.
string ("PUBLIC" | "PRIVATE")
Visibility level for the chat channel.
string
The description for the chat channel being created.
integer
required
The ID of the Workspace where the chat channel will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_CHAT_MESSAGETool 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.

Input Parameters

string ("message" | "post")
required
The type of message: ‘message’ for regular text messages, ‘post’ for structured posts.
string
required
The full content of the message to be created. Supports markdown formatting.
string
The user ID of the person to assign this message to.
array
List of user IDs to follow this message (max 10).
object
Data for post-type messages.
array
Reactions to add to the message at creation time (max 10).
string
required
The ID of the Channel where the message will be sent.
integer
required
The ID of the Workspace.
string ("text/md" | "text/plain")
Format of the message content.
string
The group ID to assign this message to.
integer
The triaged action applied to the message: 1 or 2.
string
The message triaged action object ID.
integer
The message triaged action object type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_CHAT_REACTIONTool to add a reaction to a ClickUp chat message. Use when you need to react to a message with an emoji.

Input Parameters

string
required
The emoji reaction to add, in shortcode format (e.g., ‘+1’, ‘-1’, ‘thumbsup’, ‘heart’, ‘smile’). Use GitHub-style shortcodes without colons.
string
required
The ID of the chat message to react to.
integer
required
The ID of the Workspace containing the chat message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_CHAT_VIEW_COMMENTPosts a new comment to a specified ClickUp Chat view; the ‘view_id’ must correspond to an existing and accessible Chat view.

Input Parameters

string
required
The unique identifier of the Chat view where the comment will be posted.
boolean
required
If True, notifications for this comment will be sent to all members of the Chat view, including the comment creator. If False, notifications will follow standard ClickUp behavior.
string
required
The text content of the comment to be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_CHECKLISTCreates 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).

Input Parameters

string
required
Name for the new checklist.
string
required
Unique identifier of the task for the new checklist; can be a standard or custom task ID (if custom_task_ids is true).
string
Team’s unique identifier; required only if custom_task_ids is true.
boolean
If true, task_id is treated as a custom task ID, requiring team_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_CHECKLIST_ITEMCreates a named checklist item within a specified existing checklist, optionally assigning it to a user.

Input Parameters

string
required
Name for the new checklist item.
integer
User ID of the ClickUp user to whom this item will be assigned. If omitted, the item will be unassigned.
string
required
UUID of the parent checklist where the new item will be created; this checklist must already exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_DIRECT_MESSAGE_CHANNELTool 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.

Input Parameters

array
The unique user IDs of participants in the direct message chat, up to 15. A Self DM is created when no user IDs are provided.
integer
required
The ID of the Workspace where the direct message channel will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_DOCTool 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.

Input Parameters

string
required
The name/title for the new document.
string
Optional parent location ID (space, folder, or list ID) where the doc should be created. If omitted, the doc will be created at the workspace level.
string ("space" | "folder" | "list")
Type of parent location. Required if parent_id is provided. Must be ‘space’, ‘folder’, or ‘list’.
string
required
The workspace ID where the document will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_DOC_PAGETool 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.

Input Parameters

string
The name of the new page. If not provided, page will be created with an empty name.
string
required
The ID of the doc in format ‘{alphanumeric_prefix}-{number}’ (e.g., ‘2kz0k9bp-1096’). To get a valid doc_id, use CLICKUP_CLICK_UP_SEARCH_DOCS or extract from a ClickUp Doc URL.
string
The content of the new page. Supports markdown or plain text based on content_format.
string
The subtitle of the new page.
integer
required
The ID of the Workspace. Obtain this from the CLICKUP_AUTHORIZATION_GET_WORK_SPACE_LIST or CLICKUP_CLICK_UP_SEARCH_DOCS action.
string ("text/md" | "text/plain")
The format the page content is in. Defaults to ‘text/md’ for markdown.
string
The ID of the parent page. If provided, the new page will be created as a sub-page. If omitted, this will be a root page in the Doc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_FOLDERCreates a new ClickUp Folder within the specified Space, which must exist and be accessible.

Input Parameters

string
required
The name of the Folder to be created.
string
required
Numerical ID of the Space in which to create the Folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_FOLDERLESS_LISTCreates a new folderless list (a list not part of any Folder) directly within a specified ClickUp Space.

Input Parameters

string
required
Name for the new folderless list.
string
List color (e.g., ‘red’, ‘blue_blended’), distinct from task statuses within the list. Null for no color.
string
Description for the list (plain text or markdown).
integer
user_id of the list owner. Null for no specific owner.
integer
Due date for the list (POSIX timestamp in milliseconds).
integer
Priority level: 1 (Urgent), 2 (High), 3 (Normal), 4 (Low). Null to remove priority.
string
required
Identifier of the Space for the new folderless list.
boolean
Indicates if due_date includes time (true) or is all-day (false). Required if due_date is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_FOLDER_VIEWCreates a new, highly customizable view within a specific ClickUp folder using its folder_id.

Input Parameters

string
required
Name for the new view.
string
required
The type of view to create. Options include: list, board, calendar, table, timeline, workload, activity, map, conversation, or gantt.
string
required
Numeric ID of the folder where the new view will be created.
null
This field must be null (None). It is intended for specifying sort direction within divided sections, but its configuration is not fully detailed.
string
Operator for combining filters. The available operator (op) values are AND and OR. Required when any filter parameter is provided.
null
This field must be null (None). It is intended for view division features (e.g., swimlanes) whose specific configuration via this parameter is not fully detailed.
integer
Set a group sort order. Use 1 for ascending (e.g., urgent priority at top of the view, and tasks with no priority at the bottom) or -1 to reverse the order (e.g., tasks with no priority at the top). Required when any grouping parameter is provided.
array
Array of field objects to display as columns in the view. Each element must be an object. Custom Fields require the _cf prefix followed by the Custom Field ID (e.g., _cf_xxxxxxxx).
array
Fields to filter by. Each element represents a filter condition. View the list of available fields in ClickUp’s API documentation. Required when any filter parameter is provided.
Text string to search for within tasks, comments, and subtasks in the view. Required when any filter parameter is provided.
string
Field to group tasks by. Options include: none, status, priority, assignee, tag, or dueDate. When any grouping parameter is provided, grouping__field, grouping__dir, grouping__collapsed, and grouping__ignore are all required.
array
Fields to sort tasks by. Each element must be an object with ‘field’ and ‘dir’ properties. ‘dir’ should be 1 for ascending or -1 for descending. Refer to ClickUp API for the exact structure.
boolean
If true, tasks with no value for the grouping__field will not be grouped and will appear in a separate ‘Ungrouped’ section. Required when any grouping parameter is provided.
array
Array of identifiers for divided sections to collapse by default, or null if no sections should be collapsed.
array
An array of group identifiers (e.g., status names like ‘Open’, assignee IDs as strings like ‘123’) that should be initially collapsed in the view. These identifiers depend on the grouping__field used. Required when any grouping parameter is provided.
boolean
If true, tasks with a closed status are included in the view.
boolean
In ‘Me Mode’, if true, show only comments where the current user is mentioned or assigned.
boolean
In ‘Me Mode’, if true, show only subtasks assigned to the current user.
boolean
If true, display task cover images or image attachments.
boolean
In ‘Me Mode’, if true, show only checklists assigned to the current user.
integer
Controls subtask visibility. Acceptable integer values are 1 (show subtasks as separate tasks), 2 (expand subtasks under parent tasks), or 3 (collapse subtasks under parent tasks).
array
List of user IDs (as strings). Tasks assigned to these users will appear in the ‘Assignees’ section of the team sidebar.
boolean
If true, display task assignees.
boolean
If true, display the List, Folder, and Space location for tasks. When any settings parameter is provided, a complete settings object with all settings keys is required.
boolean
If true, include closed subtasks in the view.
boolean
If true, unassigned tasks will be shown in the team sidebar.
boolean
If true, comments assigned to users will be shown in the team sidebar.
string
Specifies whether to collapse columns with no tasks (e.g., in Board view). Common string values are ‘true’ or ‘false’.
boolean
If true, display parent task names for subtasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_GOALCreates a new goal in a ClickUp Team (Workspace).

Input Parameters

string
required
Name for the goal.
string
required
Hex color string to associate with the goal.
array
required
List of user IDs to be assigned as owners of the goal.
string
required
Numeric ID of the ClickUp Team (Workspace) where the goal will be created.
integer
required
Due date for the goal, as a Unix timestamp in milliseconds.
string
required
Detailed description for the goal.
boolean
required
Set to true if the goal will have multiple owners; false for a single owner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_KEY_RESULTCreates a new Key Result (Target) for a specified Goal in ClickUp to define and track measurable objectives towards achieving that Goal.

Input Parameters

string
required
The name for the new Key Result.
string
required
Specifies the type of the Key Result, which determines how progress is tracked. Supported types: ‘number’, ‘currency’, ‘boolean’, ‘percentage’, ‘automatic’.
string
required
The unit of measurement for Key Results of type ‘number’, ‘currency’, or ‘percentage’ (e.g., ’$’, ’%’, ‘items’). This may not be applicable for ‘boolean’ or ‘automatic’ types where progress is count-based.
array
required
A list of numerical user IDs to be assigned as owners of this Key Result.
string
required
The unique identifier (UUID) of the parent Goal for which this Key Result is being created.
array
required
An array of List UUIDs to link to this Key Result. Can be used with ‘automatic’ type Key Results to track progress based on tasks within these lists.
array
required
An array of task UUIDs to link to this Key Result. Often used when type is ‘automatic’ to track progress via the completion status of these linked tasks.
integer
required
The target value indicating Key Result completion. For ‘boolean’ type, use 1 for true/complete. For ‘automatic’ type, this is often the total count of items to complete (e.g., number of linked tasks).
integer
required
The initial value for tracking Key Result progress. For ‘boolean’ type, use 0 for false/incomplete, 1 for true/complete. For ‘automatic’ type, this is often the initial count (e.g., 0).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_LISTCreates 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.

Input Parameters

string
required
The name to be assigned to the new list.
string
Optional. Defines the list’s color in the ClickUp UI (e.g., ‘red’, ‘blue’). Important: This ‘status’ refers to the visual color of the list itself, not the workflow statuses (like ‘To Do’, ‘In Progress’) of tasks within the list.
string
Optional descriptive content or notes for the list.
integer
Optional. Numerical user ID of the assignee.
integer
Optional due date for the list, represented as a POSIX timestamp in milliseconds. For example, 1695110307000 for September 19, 2023, 07:58:27 AM GMT.
integer
Optional priority level for the list. Integer values map to: 1 (Urgent), 2 (High), 3 (Normal), 4 (Low).
string
required
The unique numerical identifier of the folder where the new list will be created. Note: This action creates a list within an existing folder. A folder_id is required and space_id cannot be used. If you want to create a list directly in a Space (without a folder), use the ‘CLICKUP_CREATE_FOLDERLESS_LIST’ action instead.
boolean
Optional. A boolean flag indicating whether the due_date includes a specific time. If True, the time component of due_date is respected. If False or not provided, the list is considered due on the entire day specified by due_date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_LIST_COMMENTAdds a text comment to a ClickUp List, optionally assigning it to a user and setting the notify-all preference.

Input Parameters

string
required
Unique identifier of the ClickUp list where the comment will be posted.
integer
User ID to assign this comment to, converting it into an actionable item. If omitted, creates an unassigned comment.
boolean
If true, notifications are sent to everyone including the creator. If false or omitted, default notification rules apply.
string
required
Text content of the comment. Supports ClickUp formatting (mentions, markdown).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_LIST_FROM_TEMPLATECreates 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.

Input Parameters

string
required
Name for the new list created from the template.
integer
required
The ID of the folder where the list will be created.
string
required
The ID of the template to use for creating the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_LIST_VIEWCreates a new, customizable view (e.g., list, board, calendar) within a specified ClickUp List, requiring an existing list_id accessible by the user.

Input Parameters

string
required
Name for the new view.
string
required
View type (e.g., list, board, calendar, table, timeline, workload, activity, map, conversation, gantt).
string
required
Numeric ID of the List where the new view will be created.
integer
Direction for secondary grouping: 1 for ascending, -1 for descending.
string
Logical operator for combining filters: AND for all conditions, OR for any condition.
string
Field for secondary grouping (dividing tasks within primary groups).
integer
Group sort order: 1 for ascending (e.g., urgent priority top), -1 for descending (e.g., no priority top).
array
Array of column field objects. Each object must have ‘field’ (e.g., ‘name’, ‘status’, ‘assignee’, ‘dueDate’, or ‘_cf_FIELD_ID’ for Custom Fields).
array
Array of filter field objects. Each object must have ‘field’ (e.g., ‘assignee’, ‘status’, ‘priority’, ‘tags’), ‘op’ (e.g., ‘EQ’, ‘NOT’, ‘IN’, ‘ANY’), and ‘values’ (array of filter values). Required when any filter parameter is provided.
string
Search string to filter tasks by name or content.
string
Field for grouping tasks (e.g., none, status, priority, assignee, tag, dueDate).
array
Array of sort field objects. Each object must have ‘field’ (e.g., ‘dateCreated’, ‘name’, ‘dueDate’, ‘priority’) and optionally ‘dir’ (1 for ascending, -1 for descending).
boolean
If true, hides tasks not falling into any specified group.
array
Array of identifiers for divided sections to collapse by default, or null if no sections should be collapsed.
array
List of group identifiers (e.g., status names, assignee IDs) to collapse by default.
boolean
If true, includes closed tasks in the view.
boolean
If true, enables ‘Me Mode’ for comments, filtering to tasks where the current user is involved in comments.
boolean
If true, enables ‘Me Mode’ for subtasks, filtering to subtasks assigned to the current user.
boolean
If true, displays cover images or image attachments for tasks.
boolean
If true, enables ‘Me Mode’ for checklists, filtering to tasks with checklists assigned to the current user.
integer
Subtask visibility: 1 (separate tasks), 2 (expanded under parent), 3 (collapsed under parent).
array
List of user IDs for quick assignee filtering in the team sidebar.
boolean
If true, shows assignees’ avatars or names on tasks.
boolean
If true, displays task’s location (e.g., List, Folder, Space) in the view.
boolean
If true, displays closed subtasks in the view.
boolean
If true, team sidebar includes filter for unassigned tasks.
boolean
If true, team sidebar includes filter for tasks with assigned comments.
string
Controls collapsing of empty columns. Values like ‘true’, ‘false’, or specific keywords (see ClickUp API).
boolean
If true, displays parent task names alongside subtasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_LOCATION_CHAT_CHANNELTool to create a Channel on a Space, Folder, or List in ClickUp. Use when you need to create a location-based chat channel.

Input Parameters

string
The topic/name of the chat channel being created.
object
required
The location (space, folder, or list) where the channel will be created.
array
Optionally specify unique user IDs to add to the channel, up to 100.
string ("PUBLIC" | "PRIVATE")
Visibility setting for the chat channel.
string
The description for the chat channel being created.
string
required
The ID of the Workspace where the channel will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_REPLY_MESSAGETool 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.

Input Parameters

string ("message" | "post")
required
The type of message.
string
required
The full content of the message to be created.
string
The possible assignee of the message.
array
The ids of the followers of the message.
object
Data for post-type messages.
array
The reactions to the message that exist at creation time.
string
required
The ID of the specified message to reply to.
integer
required
The ID of the Workspace.
string ("text/md" | "text/plain")
Format of the message content.
string
The possible group assignee of the message.
integer
The triaged action applied to the message. 1 or 2.
string
The message triaged action object id.
integer
The message triaged action object type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_SPACECreates a new ClickUp Space within a specified Workspace, allowing feature configuration which defaults to Workspace settings if unspecified.

Input Parameters

string
required
Name for the new Space.
string
required
Numeric ID of the Workspace (Team) for the new Space.
boolean
required
Enable/disable multiple assignees for tasks in this Space.
boolean
Enable/disable Tags. Defaults to Workspace setting if None.
boolean
Enable/disable Checklists. Defaults to Workspace setting if None.
boolean
Enable/disable Due Dates. Defaults to Workspace setting if None.
boolean
Enable/disable Portfolios. Defaults to Workspace setting if None.
boolean
Enable/disable Custom Fields. Defaults to Workspace setting if None.
boolean
Enable/disable Start Date for Due Dates (if Due Dates enabled). Defaults to Workspace setting if None.
boolean
Enable/disable Time Tracking. Defaults to Workspace setting if None.
boolean
Enable/disable Time Estimates. Defaults to Workspace setting if None.
boolean
Enable/disable Dependency Warning (shows conflict warnings). Defaults to Workspace setting if None.
boolean
Enable/disable Remap Dependencies (auto-adjusts task dates). Defaults to Workspace setting if None.
boolean
Enable/disable subtask due date remapping (if Due Dates enabled). Defaults to Workspace setting if None.
boolean
Enable/disable closed subtask due date remapping (if Due Dates & subtask remapping enabled). Defaults to Workspace setting if None.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_SPACE_TAGCreates a new tag (name, foreground color, background color) in an existing ClickUp Space.

Input Parameters

string
required
Numeric ID of the Space to create the tag in.
string
required
Name for the new tag. This parameter maps to the nested tag.name field in the API request.
string
required
Hexadecimal background color for the tag. This parameter maps to the nested tag.tag_bg field in the API request.
string
required
Hexadecimal foreground (text) color for the tag. This parameter maps to the nested tag.tag_fg field in the API request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_SPACE_VIEWCreates a customizable view (e.g., List, Board, Gantt) within a specified ClickUp Space, allowing configuration of grouping, sorting, filtering, and display settings.

Input Parameters

string
required
The name for the new view.
string
required
The type of view to create. Valid options include: list, board, calendar, table, timeline, workload, activity, map, conversation, or gantt.
string
required
The unique identifier of the Space where the new view will be created.
null
Sort order for divided sections. Must be None if included, as sort direction for divisions may not be applicable here.
string
Logical operator (AND or OR) for combining filters. When ANY filter parameter is provided, ALL filter fields (op, fields, search, show_closed) are required. Defaults to ‘AND’ if not specified when other filter fields are present.
null
Field to divide tasks by. Must be None if included, as division by field may not be applicable for Space views via this action.
integer
Group sort order: 1 for ascending, -1 for descending. Required when any grouping parameter is provided.
array
Field identifiers for columns. Use standard field names (e.g., ‘status’) or Custom Field IDs with _cf prefix (e.g., ‘ID_cf’).
array
Fields to apply filters on. When ANY filter parameter is provided, ALL filter fields (op, fields, search, show_closed) are required. Defaults to empty array if not specified when other filter fields are present. Refer to ClickUp API documentation for available filterable fields and their syntax.
string
A search string to filter tasks by keywords or specific criteria within the view. When ANY filter parameter is provided, ALL filter fields (op, fields, search, show_closed) are required. Defaults to empty string if not specified when other filter fields are present.
string
The field to group tasks by. Options include: none, status, priority, assignee, tag, or dueDate. When any grouping parameter is provided, grouping__field, grouping__dir, grouping__collapsed, and grouping__ignore are all required.
array
Fields to sort tasks by (e.g., dueDate, priority). Refer to ClickUp API documentation for a complete list of sortable fields.
boolean
If True, tasks not matching grouping criteria are hidden; otherwise, they are shown in a default group. Required when any grouping parameter is provided.
array
Array of identifiers for divided sections to collapse by default, or null if no sections should be collapsed.
array
A list of string identifiers for groups that should be collapsed by default (e.g., status names like ‘Closed’, or assignee user IDs if grouping by assignee). Required when any grouping parameter is provided.
boolean
If True, closed tasks are included in the view. When ANY filter parameter is provided, ALL filter fields (op, fields, search, show_closed) are required. Defaults to false if not specified when other filter fields are present.
boolean
If True, in ‘Me Mode’, this setting filters for or highlights tasks where the current user has made comments. When ANY settings parameter is provided, ALL settings fields are required. Defaults to false if not specified when other settings fields are present.
boolean
If True, in ‘Me Mode’, this setting filters for or highlights subtasks assigned to the current user. When ANY settings parameter is provided, ALL settings fields are required. Defaults to false if not specified when other settings fields are present.
boolean
If True, displays cover images or image attachments directly on task cards in the view. When ANY settings parameter is provided, ALL settings fields are required. Defaults to true if not specified when other settings fields are present.
boolean
If True, in ‘Me Mode’, this setting filters for or highlights tasks with checklist items assigned to the current user. When ANY settings parameter is provided, ALL settings fields are required. Defaults to false if not specified when other settings fields are present.
integer
How subtasks are displayed: 1 (show as separate tasks), 2 (show expanded under parent task), or 3 (show collapsed under parent task). When ANY settings parameter is provided, ALL settings fields are required. Defaults to 1 if not specified when other settings fields are present.
array
A list of user IDs (as strings) to filter by in the team sidebar.
boolean
If True, displays task assignees in the view (e.g., on task cards). When ANY settings parameter is provided, ALL settings fields are required. Defaults to true if not specified when other settings fields are present.
boolean
If True, displays the task’s location (List, Folder, Space). When ANY settings parameter is provided, ALL settings fields are required. Defaults to false if not specified when other settings fields are present.
boolean
If True, includes closed subtasks in the view according to other filter criteria. When ANY settings parameter is provided, ALL settings fields are required. Defaults to false if not specified when other settings fields are present.
boolean
If True, shows unassigned tasks in the team sidebar.
boolean
If True, shows tasks with comments assigned to the current user in the team sidebar.
string
If ‘true’, collapses empty columns (e.g., status columns with no tasks). Use string ‘true’ or ‘false’. When ANY settings parameter is provided, ALL settings fields are required. Defaults to ‘false’ if not specified when other settings fields are present.
boolean
If True, displays the parent task name next to subtasks for clarity. When ANY settings parameter is provided, ALL settings fields are required. Defaults to false if not specified when other settings fields are present.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_TASKCreates 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.

Input Parameters

string
required
The name of the new task.
array
Tag names to apply.
string
ID of an existing task to be the parent (creating a subtask). Parent must not be a subtask and must be in the same list.
string
Status name for the task. IMPORTANT: Each ClickUp list has its own unique status configuration. Common names like ‘todo’, ‘done’, or ‘in progress’ often do NOT exist - you must use the exact status names (case-sensitive) configured in the target list. To get valid statuses, call GET /list/{list_id} and check the ‘statuses’ array in the response for available status names. If omitted, uses the list’s default status (recommended when valid statuses are unknown).
string
required
The ID of the list where the task will be created.
string
Team ID, required only if custom_task_ids is true.
integer
Due date as a Unix timestamp in milliseconds.
ID of an existing task to link as a dependency.
integer
Priority level: 1 (Urgent), 2 (High), 3 (Normal), 4 (Low).
array
User IDs to assign to the task.
boolean
True to send notifications to all task watchers, including the creator.
integer
Start date as a Unix timestamp in milliseconds.
string
Task’s detailed description.
array
Custom fields to apply. See ClickUp API for structure.
boolean
True if due_date includes a specific time, false if it’s an all-day task.
integer
Estimated time to complete, in milliseconds.
integer
Custom task type ID. Omit or use null for standard tasks (recommended). Custom task types including Milestones (ID 1) are subject to workspace plan quotas. Only specify a custom_item_id if you have confirmed the workspace has available quota for that task type. Use GET /team/{team_id}/custom_item to check available custom task types and their quotas.
boolean
Enables referencing tasks by custom task ID; requires team_id if true.
boolean
True if start_date includes a specific time, false if it’s an all-day task.
boolean
True to enforce filling all required Custom Fields upon creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_TASK_ATTACHMENTUploads a file as an attachment to a specified ClickUp task using multipart/form-data.

Input Parameters

string
required
The unique identifier of the task to which the attachment will be added.
string
The ID of the team. This is required and used only if custom_task_ids is true to help locate the task by its custom ID. For example: custom_task_ids=true&team_id=123.
object
required
The file to be uploaded as an attachment. Note: Files stored in the cloud (URLs) cannot be used - actual file content must be provided.
boolean
If true, indicates that task_id should be interpreted as a custom task ID instead of the default ClickUp task ID. If this is true, team_id must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_TASK_COMMENTAdds a comment to a ClickUp task, assigning it to the supplied user and specifying whether to notify all watchers. Team ID is required when using custom task IDs.

Input Parameters

string
required
Unique task identifier for the comment. Can be standard or custom if custom_task_ids is true.
string
Team ID, required if custom_task_ids is true to locate the task by its custom ID.
integer
required
The user ID of the person to whom this specific comment should be assigned or mentioned. This assigns the comment, not the task.
boolean
required
If true, notifications for this comment will be sent to all users watching the task, including the comment’s creator. If false, notifications will be sent according to standard ClickUp notification rules (e.g., to mentioned users, comment assignee).
string
required
The text content for the comment. Supports ClickUp’s comment formatting (e.g., mentions, markdown).
boolean
Set to true to indicate that the task_id provided is a custom task ID. If true, the team_id must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_TASK_FROM_TEMPLATECreates a new task in a specified ClickUp list from a task template, using the provided name for the new task.

Input Parameters

string
required
Name for the new task created from the template.
string
required
Numeric ID of the ClickUp list for task creation, found in the list’s URL.
string
required
Unique string ID of the task template to use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_TEAMCreates 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.

Input Parameters

string
required
Name for the new team (user group).
array
required
User IDs to be initial members of the new team (user group).
string
required
Workspace ID where the team (user group) will be created (this is referred to as ‘Team ID’ in the ClickUp API).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_THREADED_COMMENTTool to create a threaded reply to a comment in ClickUp. Use when you need to respond to an existing comment with context.

Input Parameters

integer
The user ID of the person to assign this reply to.
string
required
The ID of the parent comment to reply to.
boolean
required
If true, notifications for this reply will be sent to all users watching the parent comment or task. If false, notifications will be sent according to standard ClickUp notification rules.
string
required
The text content of the reply. Supports ClickUp’s comment formatting (e.g., mentions, markdown).
string
The group ID to assign this reply to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_WEBHOOKCreates 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.

Input Parameters

array
required
Event types to subscribe to; use ’*’ for all events on the resource. Examples: ‘taskCreated’, ‘taskUpdated’.
string
Optional. ID of the List to scope the webhook; triggers only for events in this List.
string
Optional. ID of the Task to scope the webhook; triggers only for events for this Task.
string
required
ID of the Team (Workspace) for the webhook.
string
required
Publicly accessible URL for ClickUp to send POST notifications for subscribed events.
string
Optional. ID of the Space to scope the webhook; triggers only for events in this Space.
string
Optional. ID of the Folder to scope the webhook; triggers only for events in this Folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_CREATE_WORKSPACE_EVERYTHING_LEVEL_VIEWCreates a new, customizable view (e.g., List, Board) at the ‘Everything’ level for a specified Team (Workspace ID), encompassing all tasks within that Workspace.

Input Parameters

string
required
Name for the new view.
string
required
Type of view to create (e.g., list, board, calendar).
string
required
Team (Workspace) ID where the ‘Everything’ level view will be created.
null
Sort direction for divided sections: 1 for ascending, -1 for descending.
string
Logical operator for combining filters (AND or OR).
null
Field to divide the view by, creating separate sections (e.g., ‘priority’, ‘status’).
integer
Sort order for grouped tasks: 1 for ascending, -1 for descending.
array
Columns to display and their order. Prefix Custom Fields with _cf. For specific configurations, use a JSON object string.
array
Fields to apply filters on. See ClickUp API docs for filterable fields.
string
Search term to filter tasks by name, description, etc.
string
Field to group tasks by (e.g., status, priority).
array
Fields to sort tasks by. See ClickUp API docs for sortable fields.
boolean
If true, tasks in closed statuses are excluded from grouping.
array
List of division identifiers to be collapsed by default. Must be an array (e.g., []) or null, not a boolean.
array
List of group identifiers (e.g., status names, assignee IDs) to be collapsed by default.
boolean
If true, include tasks with ‘Closed’ status in the view.
boolean
If true, ‘Me Mode’ filters for tasks commented on by the current user.
boolean
If true, ‘Me Mode’ filters for subtasks assigned to the current user.
boolean
If true, show task cover images or attachment previews.
boolean
If true, ‘Me Mode’ filters for tasks where current user is assigned to checklist items.
integer
Subtask display mode: 1 (separate), 2 (expand), 3 (collapse).
array
List of user IDs to filter tasks by in the team sidebar.
boolean
If true, display task assignees.
boolean
If true, display breadcrumb path (Space > Folder > List) for each task.
boolean
If true, show closed subtasks according to settings_show_subtasks.
boolean
If true, team sidebar includes filter for unassigned tasks.
boolean
If true, team sidebar includes filter for tasks with assigned comments.
string
If true, collapse or hide empty columns.
boolean
If true, display parent task name next to subtasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_CHAT_CHANNELTool to delete a chat channel in ClickUp. Use when you need to permanently remove a chat channel from a workspace.

Input Parameters

string
required
The ID of the chat channel to delete.
integer
required
The ID of the Workspace containing the chat channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_CHAT_MESSAGETool to delete a chat message in ClickUp. Use when you need to permanently remove a specific message from a workspace chat.

Input Parameters

string
required
The ID of the specified message.
integer
required
The ID of the Workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_CHAT_REACTIONTool 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.

Input Parameters

string
required
The name of the reaction emoji to remove from the message (e.g., ‘heart’, ‘thumbsup’, ‘smile’). Use the exact emoji name as it appears in ClickUp.
string
required
The ID of the chat message from which to remove the reaction.
string
required
The ID of the Workspace containing the chat message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_CHECKLISTPermanently deletes an existing checklist identified by its checklist_id.

Input Parameters

string
required
The unique identifier (UUID) of the checklist to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_CHECKLIST_ITEMPermanently deletes an existing item, identified by checklist_item_id, from an existing checklist, identified by checklist_id.

Input Parameters

string
required
Unique identifier (UUID) of the checklist containing the item to be deleted.
string
required
Unique identifier (UUID) of the specific checklist item to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_COMMENTDeletes an existing comment from a task using its comment_id.

Input Parameters

string
required
The unique identifier of the comment to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_DEPENDENCYRemoves 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.

Input Parameters

string
required
Identifier of the task from which the dependency relationship will be removed.
string
Numeric team ID, required only when custom_task_ids is true to scope custom task IDs.
string
Identifier of the task that task_id depends on (i.e., task_id is waiting on this task). Provide this to remove a ‘waiting on’ dependency. Mutually exclusive with dependency_of - exactly one must be provided.
string
Identifier of the task that depends on task_id (i.e., this task is blocked by task_id). Provide this to remove a ‘blocking’ dependency. Mutually exclusive with depends_on - exactly one must be provided.
boolean
If true, interprets task_id and the dependency task ID as custom task IDs; team_id also required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_FOLDERPermanently and irreversibly deletes a specified folder and all its contents (Lists, Tasks) if the folder_id exists.

Input Parameters

string
required
The unique numerical identifier of the folder to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_GOALPermanently removes an existing Goal, identified by its goal_id, from the Workspace.

Input Parameters

string
required
The unique identifier (UUID) of the Goal to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_KEY_RESULTDeletes an existing Key Result, also referred to as a Target within a Goal, identified by its key_result_id.

Input Parameters

string
required
The unique identifier (UUID) of the Key Result to be deleted. This is often referred to as a ‘Target’ in the context of Goals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_LISTPermanently deletes an existing List and all its contents; this action is destructive and irreversible via the API.

Input Parameters

string
required
The unique numerical identifier of the List to be deleted. This ID can be found by navigating to the List in ClickUp; the ID is often present in the URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_SPACEPermanently deletes a specified Space in ClickUp; this action is irreversible as the Space cannot be recovered via the API.

Input Parameters

string
required
Unique numerical ID of the Space to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_SPACE_TAGDeletes 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.

Input Parameters

string
required
Numeric identifier of the Space from which the Tag will be deleted.
string
required
Name of the Tag to be deleted, used in the URL path to identify it.
string
Name of the Tag in the request body. Though schema-optional, generally required by the API to match the Tag’s actual name for successful deletion.
string
Background color of the Tag in HEX format (e.g., ‘#FF5733’) in the request body. Though schema-optional, generally required by the API for successful deletion.
string
Foreground (text) color of the Tag in HEX format (e.g., ‘#FFFFFF’) in the request body. Though schema-optional, generally required by the API for successful deletion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_TASKPermanently deletes a task, using its standard ID or a custom task ID (requires custom_task_ids=true and team_id).

Input Parameters

string
required
Unique ID of the task to delete. Can be a standard ID or a custom task ID (if custom, custom_task_ids must be true).
string
Team ID. Required only if custom_task_ids is true to identify the team for the custom task ID.
boolean
Set to true if task_id is a custom ID (requires team_id if true).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_TEAMPermanently deletes an existing Team (user group) from the Workspace using its group_id.

Input Parameters

string
required
The unique string identifier for the Team (user group) to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_TIME_ENTRYDeletes an existing time entry, specified by timer_id, from a Workspace identified by team_id.

Input Parameters

string
required
Unique identifier of the Workspace from which the time entry will be deleted.
string
required
Unique identifier of the time entry to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_TIME_TRACKEDDeletes a time-tracked interval from a task; use this legacy endpoint for older time tracking systems.

Input Parameters

string
required
Task ID; can be standard or custom if custom_task_ids is set to true.
string
The ID of the team. This is required only if custom_task_ids is set to true to correctly identify the task using its custom ID. For example: custom_task_ids=true&team_id=123.
string
required
ID of the time tracking interval (entry) to be deleted.
boolean
Set to true if task_id refers to a custom task ID. If true, team_id must also be provided. If omitted or false, task_id is treated as a standard ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_VIEWPermanently and irreversibly deletes an existing View in ClickUp, identified by its view_id.

Input Parameters

string
required
The unique identifier of the View to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_DELETE_WEBHOOKPermanently removes an existing webhook, specified by its ID, thereby ceasing all its event monitoring and notifications.

Input Parameters

string
required
The unique identifier (UUID) of the webhook to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_ACCESSIBLE_CUSTOM_FIELDSRetrieves all accessible Custom Field definitions for a specified ClickUp List using its list_id.

Input Parameters

string
required
Numeric ID of the specific ClickUp List.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_ACCESS_TOKENExchanges a ClickUp OAuth 2.0 authorization code (obtained after user consent) for an access token.

Input Parameters

string
required
Authorization code from ClickUp’s authorization server, typically a query parameter to your redirect URI after user consent.
string
required
Client ID for your registered ClickUp OAuth application.
string
required
Client Secret for your registered ClickUp OAuth application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_ALL_TAGS_FROM_TIME_ENTRIESRetrieves all unique tags applied to time entries within a specified ClickUp Team (Workspace).

Input Parameters

string
required
The unique numerical identifier of the ClickUp Team (Workspace) for which to retrieve time entry tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACESRetrieves a list of Workspaces (Teams) the authenticated user can access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_AUTHORIZED_USERRetrieves the details of the currently authenticated ClickUp user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_BULK_TASKS_TIME_IN_STATUSRetrieves the time spent in each status for multiple tasks; requires the ‘Total time in Status’ ClickApp to be enabled in the Workspace.

Input Parameters

string
The ID of the team to which the custom task IDs belong. This field is required and used only when the custom_task_ids parameter is set to true.
string
required
A comma-separated string of task IDs (e.g., ‘taskID1,taskID2’) for which to retrieve time in status data. You can include up to 100 task IDs per request.
boolean
Set to true if task_ids refer to custom task IDs instead of standard task IDs. If true, team_id must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_CHAT_CHANNELRetrieves details for a specific chat channel in a ClickUp Workspace. Use when you need information about a particular chat channel.

Input Parameters

string
required
The ID of the specified Channel.
integer
required
The ID of the Workspace.
string ("text/md" | "text/plain")
Format options for the channel description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_CHAT_CHANNEL_FOLLOWERSTool to retrieve followers of a ClickUp chat channel. Use when you need to list users following a specific channel in a workspace.

Input Parameters

integer
The maximum number of results to fetch for this page. Default is 50, max is 100.
string
The cursor to use to fetch the next page of results. Use the next_cursor value from the previous response.
string
required
The ID of the chat channel. Format example: ‘4-90165816748-8’.
integer
required
The ID of the Workspace containing the chat channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_CHAT_CHANNEL_MEMBERSTool to get members of a chat channel. Use when you need to retrieve the list of members in a specific ClickUp chat channel.

Input Parameters

integer
The maximum number of results to fetch for this page. Default is 50, max is 100.
string
The cursor to use to fetch the next page of results.
string
required
The ID of the specified Channel.
integer
required
The ID of the Workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_CHAT_CHANNELSTool 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.

Input Parameters

integer
The maximum number of results to fetch for this page.
string
Used to request the next page of results.
boolean
Only return Channels the user is following.
integer
required
The ID of the Workspace.
string
Specify the types of Channels to return from the request.
boolean
Include DMs/Group DMs that have been explicitly closed.
string ("text/md" | "text/plain")
Format options for channel descriptions.
integer
Only return Channels with at least one message since the given timestamp (Unix milliseconds).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_CHAT_MESSAGE_REACTIONSTool to retrieve reactions on a ClickUp chat message. Use when you need to see who reacted to a message and with what emoji.

Input Parameters

integer
The maximum number of results to fetch for this page. Defaults to 50.
string
The cursor to use to fetch the next page of results. Use the next_cursor from the previous response to paginate through reactions.
string
required
The ID of the specified chat message.
integer
required
The ID of the Workspace containing the chat message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_CHAT_MESSAGE_REPLIESRetrieves replies to a chat message in ClickUp. Use when you need to fetch responses to a specific message in a workspace chat.

Input Parameters

integer
The maximum number of results to fetch for this page.
string
The cursor to use to fetch the next page of results.
string
required
The ID of the specified message.
integer
required
The ID of the Workspace.
string ("text/md" | "text/plain")
Content format for message replies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_CHAT_MESSAGESTool to retrieve messages from a ClickUp chat channel. Use when you need to fetch chat messages for a specific channel within a workspace.

Input Parameters

integer
The maximum number of results to fetch for this page.
string
The cursor to use to fetch the next page of results.
string
required
The ID of the Channel where the messages live.
integer
required
The ID of the Workspace.
string ("text/md" | "text/plain")
Format options for message content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_CHAT_MESSAGE_TAGGED_USERSTool 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.

Input Parameters

integer
The maximum number of results to fetch for this page.
string
The cursor to use to fetch the next page of results.
string
required
The ID of the specified message.
integer
required
The ID of the Workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_CHAT_VIEW_COMMENTSRetrieves 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.

Input Parameters

integer
Unix timestamp (milliseconds) to filter comments created at or after this time. For pagination, typically used with start_id.
string
required
Unique identifier of the Chat view from which to retrieve comments.
string
Comment ID to act as a cursor for pagination, used with start to retrieve comments after this ID that also meet the start time condition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_CUSTOM_ROLESRetrieves all Custom Roles, which allow granular permission configurations, for a specified Workspace (Team).

Input Parameters

string
required
The unique identifier of the Workspace (Team) for which to retrieve custom roles.
boolean
If true, includes members assigned to each custom role in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_CUSTOM_TASK_TYPESRetrieves all custom task types available within a specified Workspace (team_id).

Input Parameters

string
required
Numeric ID of the Workspace (formerly Team) for which to retrieve custom task types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_DOCFetch metadata for one ClickUp Doc without fetching its pages or content.

Input Parameters

string
required
ClickUp Doc ID, such as ‘abc123-456’.
integer
required
Numeric ID of the Workspace containing the Doc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_DOC_CONTENTFetches a ClickUp Doc’s metadata and page content, with options to select pages or return a page listing without content. Page content is returned in a markdown field when available.

Input Parameters

string
required
The unique ClickUp Doc ID in format ‘{alphanumeric_prefix}-{number}’ (e.g., ‘2kz0k9bp-1376’). IMPORTANT: Numeric-only IDs (e.g., ‘4017245840171325375’) are View IDs, NOT Doc IDs, and will fail. To get a valid doc_id, use CLICKUP_CLICK_UP_SEARCH_DOCS or extract from a ClickUp Doc URL (format: app.clickup.com/{workspace_id}/v/dc/{doc_id}).
array
Optional list of specific page IDs to fetch. If provided, only these pages will be retrieved. If omitted, all pages in the doc will be fetched. Page IDs follow the same format as doc_id (e.g., ‘2kz0k9bp-416’).
string
required
The numeric workspace ID containing the document. Obtain this from the CLICKUP_AUTHORIZATION_GET_WORK_SPACE_LIST or CLICKUP_CLICK_UP_SEARCH_DOCS action.
boolean
If true, only fetch the list of pages without their content. Useful for discovering page structure without the full content retrieval overhead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_DOC_PAGE_CONTENTTool 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.

Input Parameters

string
required
The unique ClickUp Doc ID in format ‘{alphanumeric_prefix}-{number}’ (e.g., ‘2kz0k9bp-1376’). To get a valid doc_id, use CLICKUP_CLICK_UP_SEARCH_DOCS or extract from a ClickUp Doc URL.
string
required
The unique page ID to retrieve, following the same format as doc_id (e.g., ‘2kz0k9bp-416’). Obtain from CLICKUP_CLICK_UP_GET_DOC_CONTENT with include_page_listing_only=true or from the Doc’s page structure.
string
required
The numeric workspace ID containing the document. Obtain this from the CLICKUP_AUTHORIZATION_GET_WORK_SPACE_LIST or CLICKUP_CLICK_UP_SEARCH_DOCS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_DOC_PAGE_LISTINGTool 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.

Input Parameters

string
required
The unique ClickUp Doc ID in format ‘{alphanumeric_prefix}-{number}’ (e.g., ‘2kz0k9bp-1096’). To get a valid doc_id, use CLICKUP_CLICK_UP_SEARCH_DOCS or extract from a ClickUp Doc URL.
string
required
The numeric workspace ID containing the document. Obtain this from the CLICKUP_AUTHORIZATION_GET_WORK_SPACE_LIST or CLICKUP_CLICK_UP_SEARCH_DOCS action.
integer
The maximum depth to fetch pages/subpages. A value less than 0 does not limit the depth. Defaults to -1 (unlimited depth).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_DOC_PAGES_PUBLICTool to fetch pages belonging to a ClickUp Doc. Use when you need to list all pages in a doc with their content and structure.

Input Parameters

string
required
The ID of the doc in format ‘{alphanumeric_prefix}-{number}’ (e.g., ‘2kz0k9bp-1096’). To get a valid doc_id, use CLICKUP_CLICK_UP_SEARCH_DOCS or extract from a ClickUp Doc URL.
string
required
The ID of the Workspace. Obtain this from the CLICKUP_AUTHORIZATION_GET_WORK_SPACE_LIST or CLICKUP_CLICK_UP_SEARCH_DOCS action.
string ("text/md" | "text/plain")
Content format options for page content.
integer
The maximum depth to fetch pages/subpages. A value less than 0 does not limit the depth.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_FILTERED_TEAM_TASKSRetrieves a paginated, filtered list of workspace tasks, subject to user access; keyword/text search is not supported. Results contain trimmed task fields and descriptions limited to 200 characters, without comments.

Input Parameters

integer
Page to fetch (starts at 0). Increment until the response’s last_page field is true or the returned tasks list is empty to avoid silently missing tasks.
array
Filter by tag names.
string
Filter by parent task ID to retrieve its subtasks.
boolean
If true, tasks are displayed in reverse order.
string
required
The Workspace ID (called ‘team_id’ in ClickUp API v2). This is a numeric string. To find your Workspace ID, use the ‘Get Authorized Teams (Workspaces)’ endpoint or check Settings > Workspace Settings in the ClickUp UI.
string
Team ID, required if custom_task_ids is true, for custom task ID context. Distinct from the required team_Id path parameter (Workspace ID); do not confuse these — this optional numeric string is only used for custom task ID resolution. Example: ‘9001’.
array
Filter by List IDs. Must be numeric IDs (e.g., ‘123456789’). You can get numeric List IDs from the Get Lists endpoint.
string ("id" | "created" | "updated" | "due_date")
Order tasks by this field. Default: created.
array
Filter by task statuses (e.g., ‘to do’, ‘in progress’). Values must exactly match workspace-configured status strings; mismatches silently return empty results.
boolean
If true, include subtasks. Excluded by default.
array
Filter by assignee User IDs. Must be numeric IDs (e.g., ‘123456789’). You can get numeric User IDs from endpoints like Get List Members or Get Task Members.
array
Filter by Space IDs. Must be numeric IDs (e.g., ‘123456789’). You can get numeric Space IDs from the Get Spaces endpoint.
integer
Filter by due date greater than this Unix timestamp (milliseconds).
integer
Filter by due date less than this Unix timestamp (milliseconds).
array
Filter by Folder (Project) IDs. Must be numeric IDs (e.g., ‘123456789’). You can get numeric Folder IDs from the Get Folders endpoint.
array
Filter by custom item types (e.g., 0 for tasks, 1 for Milestones, other numbers for custom types defined in Workspace).
integer
Filter by completion date greater than this Unix timestamp (milliseconds).
integer
Filter by completion date less than this Unix timestamp (milliseconds).
array
Filter by custom fields. Each string in the list is a JSON object defining a single filter condition. Example for one string in the list: '''{“field_id”: “unique_field_id”, “operator”: ”=”, “value”: “desired_value”}'''. Incorrect field_id values or unsupported operator strings produce 400 errors or silently empty results; retrieve valid field_ids from workspace custom field configuration.
boolean
If true, include closed tasks. Excluded by default.
boolean
Set to true to use custom task IDs in filters instead of global task IDs. Requires team_id for context.
integer
Filter by creation date greater than this Unix timestamp (milliseconds).
integer
Filter by creation date less than this Unix timestamp (milliseconds).
integer
Filter by update date greater than this Unix timestamp (milliseconds).
integer
Filter by update date less than this Unix timestamp (milliseconds).
boolean
If true, return task descriptions in Markdown format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_FOLDERRetrieves detailed information about a specific folder in ClickUp.

Input Parameters

string
required
The unique identifier of the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_FOLDER_AVAILABLE_FIELDSTool 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.

Input Parameters

string
required
The ID of the folder to retrieve available custom fields from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_FOLDERLESS_LISTSRetrieves folderless Lists in a specified ClickUp Space, with an optional archived-status filter.

Input Parameters

boolean
Filter by archived status. Set to true to retrieve archived Lists, false or omit to retrieve unarchived Lists.
string
required
The ID of the Space from which to retrieve folderless Lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_FOLDERSRetrieves Folders within a specified ClickUp Space, ensuring space_id is valid, with an option to filter by archived status.

Input Parameters

boolean
Filter Folders by archived status. True for archived, False for unarchived. Omit to return both.
string
required
The unique numeric identifier of the Space from which to retrieve Folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_FOLDER_VIEWSRetrieves all configured views (like List, Board, Calendar) for a specified, existing Folder in ClickUp.

Input Parameters

integer
required
ID of the Folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_GOALRetrieves detailed information for an existing ClickUp Goal, specified by its unique goal_id.

Input Parameters

string
required
The unique identifier (UUID) of the Goal to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_GOALSRetrieves goals for a specified ClickUp Workspace (Team); the team_id must be valid and accessible.

Input Parameters

string
required
The unique numerical identifier of the Workspace (Team) for which to retrieve goals.
boolean
If true, include completed goals in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_GUESTCall 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.

Input Parameters

string
required
The unique identifier for the Team (Workspace) to which the guest belongs.
string
required
The unique identifier for the guest whose information is to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_LISTRetrieves detailed information for an existing List in ClickUp, identified by its unique list_id.

Input Parameters

string
required
The unique identifier for the List to retrieve. This ID can be found by right-clicking a List in the ClickUp sidebar, selecting ‘Copy link’, and the ID is the last part of the URL after ‘/l/’ or ‘/li/’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_LIST_COMMENTSRetrieves 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.

Input Parameters

integer
Unix timestamp (milliseconds) of a comment’s creation date.
string
required
The unique identifier for the list from which to retrieve comments.
string
ID of a specific comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_LIST_MEMBERSRetrieves all members of a specific, existing ClickUp List by its ID.

Input Parameters

string
required
Unique identifier of the ClickUp List. Found by extracting the numerical ID from the List’s URL in ClickUp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_LISTSRetrieves all lists within a specified, existing ClickUp folder, optionally filtering by archived status.

Input Parameters

boolean
Filter lists by archived status. If true, returns archived lists; if false or omitted, returns unarchived lists.
string
required
The unique identifier of the Folder from which to retrieve lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_LIST_VIEWSRetrieves all task and page views for a specified and accessible ClickUp List.

Input Parameters

string
required
The ID of the List for which to retrieve views. This is the numeric ID of the list, often found at the end of the list’s URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_RUNNING_TIME_ENTRYRetrieves the currently active time entry for a user in a Workspace; a negative duration indicates that the timer is running.

Input Parameters

integer
required
Unique identifier for the Workspace (Team).
integer
Identifier of the user for the time entry; defaults to the authenticated user if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_SHARED_HIERARCHYRetrieves the hierarchy of tasks, Lists, and Folders shared with the authenticated user within an existing ClickUp Team (Workspace), identified by its team_id.

Input Parameters

string
required
Unique numerical ID of the ClickUp Team (Workspace) for which to fetch the shared hierarchy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_SPACERetrieves detailed information for an existing Space in a ClickUp Workspace, identified by its unique space_id.

Input Parameters

string
required
Unique ID of the Space to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_SPACE_AVAILABLE_FIELDSRetrieves all custom fields available in a ClickUp Space, identified by space_id. Returns Space-level custom fields only.

Input Parameters

integer
required
The unique numerical identifier of the Space for which custom fields are to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_SPACESRetrieves Spaces for a ClickUp Team (Workspace), with an optional archived-status filter.

Input Parameters

string
required
Identifier for the Team (Workspace). Obtain valid workspace IDs using the GET /team endpoint.
boolean
Filter by archived status (true for archived, false for active); API default if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_SPACE_TAGSRetrieves all tags for tasks within a specified ClickUp Space, requiring a valid space_id.

Input Parameters

string
required
The unique numerical identifier of the Space for which tags are to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_SPACE_VIEWSRetrieves all task and page views for a specified Space ID in ClickUp.

Input Parameters

string
required
ID of the Space to retrieve views from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_SUBTYPESTool 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.

Input Parameters

string ("post" | "ai" | "syncup" | "ai_via_brain")
required
The type of comment to retrieve subtypes for. Use ‘post’ to get subtype IDs for Announcement, Discussion, Idea, and Update post types.
integer
required
ID of the logged-in user’s Workspace. Obtain this from the get_authorized_teams_workspaces action or similar workspace listing endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TASKRetrieves comprehensive details for a ClickUp task by its ID, supporting standard or custom task IDs (requires team_id for custom IDs).

Input Parameters

string
required
The unique identifier of the task to retrieve. This can be the standard ClickUp task ID or a custom task ID if custom_task_ids is set to true (in which case team_id is also required).
integer
The ID of the team. This parameter is required and used only when custom_task_ids is set to true to identify the custom task ID within that specific team. For example: custom_task_ids=true&team_id=123.
boolean
Set to true to indicate that the task_id provided is a custom task ID. If true, team_id must also be provided. If omitted or false (default), task_id is treated as a standard task ID.
boolean
Set to true to include subtasks in the task details response. If omitted or false (default), subtasks are not included.
boolean
Set to true to return the task description in Markdown format. If omitted or false (default), the description is returned in plain text. For example: ?include_markdown_description=true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TASK_COMMENTSRetrieves up to 25 comments for a specified task, supporting pagination using start and start_id to fetch older comments.

Input Parameters

integer
Unix timestamp (in milliseconds) of the oldest visible comment, used with start_id for paginating older comments.
string
required
Unique identifier of the task. Can be a standard or custom task ID (if custom_task_ids is true).
string
Team ID, required if custom_task_ids is true.
string
ID of the oldest visible comment, used with start for paginating older comments.
boolean
Indicates if task_id is a custom task ID; if true, team_id is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TASK_MEMBERSRetrieves users with explicit access (directly assigned or shared) to a specific existing task, excluding users with inherited permissions.

Input Parameters

string
required
The unique identifier of the task for which to retrieve members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TASKSRetrieves tasks from a specified ClickUp list; only tasks whose home is the given list_id are returned, and closed and archived tasks are excluded by default. Key task attributes may appear in custom_fields, and folder may be absent; high-volume calls may return HTTP 429.

Input Parameters

integer
The page number of results to fetch, starting at 0. Each page can contain up to 100 tasks. Iterate pages until the response last_page flag is true or the returned tasks list is empty to avoid silently missing tasks.
array
Filter tasks by a list of tag names. Use URL encoding for tags with spaces (e.g., ‘this%20tag’).
string
required
The ID of the list to retrieve tasks from. To find the list_id, copy the link to the list from the ClickUp UI; the list_id is the number following ‘/li’ in the URL. Pass as a numeric string (e.g., ‘123456789’).
boolean
Display tasks in reverse order based on the ‘order_by’ field.
boolean
Include or exclude archived tasks.
string
Field to order tasks by. Valid options are: ‘id’, ‘created’, ‘updated’, and ‘due_date’.
array
Filter tasks by their status. Pass a list of status strings. Use URL encoding for statuses with spaces (e.g., ‘to%20do’). To include closed tasks, use the include_closed parameter. Values must match workspace configuration exactly (case-sensitive, including spacing); mismatches return empty results silently.
boolean
Include subtasks in the results.
array
Filter tasks by assignee user IDs. Accepts a single ID or a list of IDs. IDs can be numeric (e.g., 212519251) or strings (e.g., ‘212519251’).
integer
Filter tasks with a due date greater than the provided Unix timestamp in milliseconds.
integer
Filter tasks with a due date less than the provided Unix timestamp in milliseconds.
array
Filter by custom task types. For example: ?custom_items[]=0&custom_items[]=1300. Including 0 returns tasks. Including 1 returns Milestones. Including any other number returns the custom task type as defined in your Workspace.
integer
Filter tasks with a completion date greater than the provided Unix timestamp in milliseconds.
integer
Filter tasks with a completion date less than the provided Unix timestamp in milliseconds.
array
Filter tasks by custom field values. Provide a list of JSON strings, each defining a custom field filter. Example for a single filter: ’[{“field_id”:“field_id_1”,“operator”:”=”,“value”:“field_value_1”}]’. For multiple filters: ’[{“field_id”:“field_id_1”,“operator”:”=”,“value”:“field_value_1”}, {“field_id”:“field_id_2”,“operator”:”<”,“value”:5}]’. See ClickUp API documentation for more on filtering with Custom Fields.
boolean
Include tasks with a closed status. Closed tasks are excluded by default; set to true to include them.
integer
Filter tasks with a creation date greater than the provided Unix timestamp in milliseconds.
integer
Filter tasks with a creation date less than the provided Unix timestamp in milliseconds.
integer
Filter tasks with an update date greater than the provided Unix timestamp in milliseconds.
integer
Filter tasks with an update date less than the provided Unix timestamp in milliseconds.
boolean
Return task descriptions in Markdown format. Use the response text_content field instead when plain text is needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TASK_TEMPLATESRetrieves task templates for a specified Workspace (Team ID), supporting pagination.

Input Parameters

integer
required
Page number for paginating through templates (starts from 0).
string
required
Unique identifier of the Workspace (Team) to retrieve task templates from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TASK_TIME_IN_STATUSRetrieves the duration a task has spent in each status, provided the ‘Total time in Status’ ClickApp is enabled for the Workspace.

Input Parameters

string
required
The unique identifier of the task. This can be the standard task ID or a custom task ID if custom_task_ids is true.
integer
The ID of the team (Workspace) to which the task belongs. This is required only when custom_task_ids is set to true. For example: custom_task_ids=true&team_id=1234567.
boolean
If set to true, the task_id parameter will be interpreted as a custom task ID. When using custom task IDs, the team_id must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TEAM_AVAILABLE_FIELDSRetrieves all custom fields available in a ClickUp Workspace (Team), identified by team_id. Returns Workspace-level custom fields only.

Input Parameters

integer
required
The unique numerical identifier of the Workspace (Team) for which custom fields are to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TEAMSRetrieves user groups (Teams) from a ClickUp Workspace, typically requiring team_id (Workspace ID), with an option to filter by group_ids.

Input Parameters

integer
required
ID of the ClickUp Workspace (Team ID) from which to retrieve user groups. Must be a positive integer greater than 0. Use the CLICKUP_AUTHORIZATION_GET_WORK_SPACE_LIST action to retrieve available workspace IDs.
string
Comma-separated string of user group IDs to filter results; if omitted, all user groups in the Workspace are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_THREADED_COMMENTSRetrieves threaded replies to a parent comment. Use when you need to fetch conversation threads under a specific comment.

Input Parameters

string
required
Unique identifier of the parent comment to retrieve replies for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TIME_ENTRIES_IN_DATE_RANGERetrieves 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.

Input Parameters

string
Filter time entries to include only those associated with tasks in a specific List ID.
string
Filter time entries to include only those associated with a specific task ID. Use with custom_task_ids if referring to a custom ID.
string
required
The Workspace ID (also called Team ID in ClickUp API) for which to retrieve time entries. This goes in the URL path.
string
The ID of the Team (Workspace) to use for context when custom_task_ids is true. This helps resolve custom task IDs. Example: custom_task_ids=true&team_id=123.
string
Filter time entries by user ID(s). For multiple assignees, provide a comma-separated string of user IDs. Example: 1234,9876. Note: Access to other users’ time entries typically requires Workspace Owner/Admin privileges.
integer
The end date of the date range for filtering time entries, specified as a Unix timestamp in milliseconds. If omitted, defaults to the current date.
string
Filter time entries to include only those associated with tasks in a specific Space ID.
string
Filter time entries to include only those associated with tasks in a specific Folder ID.
integer
The start date of the date range for filtering time entries, specified as a Unix timestamp in milliseconds. If omitted, defaults to 30 days prior to the current date.
boolean
Set to true if the task_id parameter refers to a custom task ID. If true, the team_id query parameter must also be provided for context.
boolean
If true, includes task tags in the response for time entries associated with tasks.
boolean
If true, includes the names of the List, Folder, and Space in the response, along with their respective IDs (list_id, folder_id, space_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TIME_ENTRYFetches a specific time entry by its ID for a given team; a negative duration in the response indicates an active timer.

Input Parameters

integer
required
Unique identifier for the Team (Workspace).
string
required
Unique identifier of the time entry. Can be obtained from the ‘Get Time Entries Within a Date Range’ action.
boolean
If true and the time entry is associated with a task, includes task details in the response.
boolean
If true, includes names of the List, Folder, and Space associated with the time entry, alongside their IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TIME_ENTRY_HISTORYRetrieves the modification history for an existing time entry within a specific ClickUp Team (Workspace).

Input Parameters

string
required
Unique identifier for the Team (Workspace) containing the time entry.
string
required
Unique identifier of the time entry for which to retrieve history.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_TRACKED_TIMERetrieves tracked time for a task using a legacy endpoint; prefer newer Time Tracking API endpoints for managing time entries.

Input Parameters

string
required
The ID of the task for which to retrieve tracked time. This can be the standard task ID or a custom task ID if custom_task_ids is set to true.
string
The ID of the team. This is required and used only when the custom_task_ids parameter is set to true. For example: custom_task_ids=true&team_id=123.
boolean
Set to true if the task_id provided is a custom task ID. If true, the team_id must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_USERRetrieves detailed information for a specific user within a ClickUp Workspace (Team), available only for Workspaces on the ClickUp Enterprise Plan.

Input Parameters

string
required
ID of the Team (Workspace) containing the user.
string
required
ID of the user whose details are to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_VIEWFetches details for a specific ClickUp view, identified by its view_id, which must exist.

Input Parameters

string
required
The unique identifier for the ClickUp view to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_VIEW_TASKSRetrieves a page of tasks from a specified ClickUp view, respecting its applied filters, sorting, and grouping. The response indicates whether it is the last page.

Input Parameters

integer
required
The page number of the results to retrieve. Used for pagination if the number of tasks exceeds the limit per page. Starts at 0.
string
required
The unique identifier for a task view from which to retrieve tasks. Only task views are supported: list, board, calendar, table, timeline, workload, activity, map, or gantt. Page views (such as Docs, Whiteboards, and Chat) are not supported and will return an error. To find valid task views, use the Get Space Views, Get Folder Views, or Get List Views actions and filter by view type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_WEBHOOKSFetches webhooks for a Team (Workspace), returning only those created by the authenticated user via API, for a team_id they can access.

Input Parameters

string
required
Unique ID of the Team (Workspace) to retrieve webhooks for. Obtain valid workspace IDs using the ‘get_authorized_teams_workspaces’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_WORKSPACE_EVERYTHING_LEVEL_VIEWSRetrieves all task and page views at the ‘Everything Level’ (a comprehensive overview of all tasks across all Spaces) for a specified ClickUp Workspace.

Input Parameters

integer
required
Numeric ID of the Workspace (often referred to as Team ID) for which to retrieve Everything Level views.
boolean
Filter for archived views. Set to true to include only archived views, false to exclude archived views, or omit to include all views.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_WORKSPACE_PLANRetrieves the details of the current subscription plan for a specified ClickUp Workspace.

Input Parameters

string
required
The unique identifier for the Workspace (formerly known as Team).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_GET_WORKSPACE_SEATSRetrieves seat utilization (used, total, available for members/guests) for a ClickUp Workspace (Team) ID, which must be for an existing Workspace.

Input Parameters

string
required
Numeric ID of the Workspace (Team).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_INVITE_GUEST_TO_WORKSPACEInvites 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.

Input Parameters

string
required
Email address of the guest to invite to the Workspace.
string
required
Unique identifier for the Workspace (Team) to which the guest will be invited.
boolean
required
If true, the guest has permission to edit tags.
integer
Optional ID of a custom role to assign to the guest, for granular permission control beyond default guest permissions. Only available on Business Plus Plan (one custom role) or Enterprise Plan (unlimited custom roles).
boolean
required
If true, the guest has permission to create views.
boolean
required
If true, the guest has permission to see time spent on tasks.
boolean
required
If true, the guest has permission to see time estimated for tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_INVITE_USER_TO_WORKSPACEInvites a user via email to a ClickUp Workspace (Team), optionally granting admin rights or a custom role; requires an Enterprise Plan for the Workspace.

Input Parameters

boolean
required
Grant administrative privileges to the invited user.
string
required
Email address of the user to invite.
string
required
Unique identifier of the Workspace (Team) to which the user will be invited.
integer
Optional custom role ID to assign; if omitted and custom roles are enabled, the default member role is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_MOVE_TASK_TO_HOME_LISTTool 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).

Input Parameters

string
required
The destination list ID to move the task to. This will become the task’s new home list.
string
required
The task ID to move. Use actual task ID, not custom task ID.
string
required
The workspace ID containing the task. Required for v3 endpoint.
array
Array of status mapping objects to map the task’s status from source list to destination list. Each object should contain ‘source_status’ and ‘destination_status’ keys. Required when the task’s current status doesn’t exist in the new list.
boolean
If true, transfer all custom fields from the current list to the destination list. If false or omitted, custom fields are not moved.
array
List of specific custom field IDs to transfer when moving the task. Only applies when move_custom_fields is true. If omitted, all custom fields are moved when move_custom_fields is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_REMOVE_CUSTOM_FIELD_VALUERemoves an existing value from a Custom Field on a specific task; this does not delete the Custom Field definition or its predefined options.

Input Parameters

string
required
Identifier of the task. If custom_task_ids is true, this is the custom task ID; otherwise, it’s the standard task ID.
integer
Numeric ID of the team, required only if custom_task_ids is true to identify the task by its custom ID.
string
required
UUID of the Custom Field whose value will be removed from the task.
boolean
If true, task_id is a custom task ID, and team_id must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_REMOVE_GUEST_FROM_FOLDERRevokes a guest’s access to a specific ClickUp Folder, optionally unsharing items explicitly shared with them within it; requires an Enterprise Plan.

Input Parameters

string
required
Unique identifier of the guest to remove from the Folder.
string
required
Unique identifier of the Folder from which to remove the guest.
boolean
If true, items explicitly shared with the guest within this Folder are also unshared.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_REMOVE_GUEST_FROM_LISTRevokes 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.

Input Parameters

string
required
The unique identifier of the List from which the guest will be removed.
string
required
The unique identifier of the guest to be removed from the List.
boolean
If false, may alter how items shared with the guest are handled or reported during removal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_REMOVE_GUEST_FROM_TASKRevokes a guest’s access to a specific task; only available for Workspaces on the ClickUp Enterprise Plan.

Input Parameters

string
required
The ID of the task from which the guest will be removed. This can be the standard task ID or a custom task ID if custom_task_ids is set to true.
string
The ID of the team. This is required only when custom_task_ids is set to true and you are using a custom task ID. For example: custom_task_ids=true&team_id=123.
string
required
The numeric ID of the guest to be removed from the task.
boolean
Determines whether to include details of items shared with the guest. Set to false to exclude these details. Defaults to true.
boolean
Set to true if you are using a custom task ID for the task_id parameter. If true, team_id must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_REMOVE_GUEST_FROM_WORKSPACEPermanently removes a guest from a specified Workspace, revoking all their access; this destructive operation requires the Workspace to be on the ClickUp Enterprise Plan.

Input Parameters

string
required
Unique numerical identifier for the Workspace (often referred to as ‘Team’ in the ClickUp API) from which the guest is to be removed. This ID specifies the scope of the removal operation.
string
required
Unique numerical identifier for the guest user whose access to the specified Workspace will be revoked. This ID targets the specific guest for removal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_REMOVE_TAG_FROM_TASKRemoves 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.

Input Parameters

string
required
The ID of the task from which the tag will be removed. This can be the standard task ID or a custom task ID if custom_task_ids is set to true.
string
The Workspace (Team) ID associated with the task.
string
required
The name of the tag to remove from the task. Tag names are case-sensitive.
boolean
Set to true if you are using a custom task ID (instead of the default task ID) to identify the task. If true, the team_id must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_REMOVE_TAGS_FROM_TIME_ENTRIESRemoves tags from specified time entries in a team, without deleting the tags from the workspace.

Input Parameters

array
required
List of tags to remove, typically identified by name (e.g., {'name': 'tag_name'}).
string
required
The unique identifier for the Team (Workspace) that owns the time entries.
array
required
List of time entry IDs from which to remove tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_REMOVE_TASK_FROM_LISTRemoves a task from an extra list (not its home list); the ‘Tasks in Multiple Lists’ ClickApp must be enabled.

Input Parameters

string
required
Unique numerical identifier of the list from which the task will be removed. This must be an extra list for the task, not its home list.
string
required
Unique identifier of the task to be removed from the specified list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_REMOVE_USER_FROM_WORKSPACEDeactivates a user from a specified ClickUp Workspace, revoking their access (user can be reactivated later); requires the Workspace to be on an Enterprise Plan.

Input Parameters

string
required
The unique numeric identifier of the Workspace (Team) from which the user will be deactivated.
string
required
The unique numeric identifier of the user to be deactivated from the Workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_SEARCH_DOCSLists Docs metadata in a ClickUp workspace, with cursor pagination. Results can be inspected to locate relevant documents before fetching their pages.

Input Parameters

integer
Maximum results per page. Default: 50, max: 100.
string
Cursor from previous response to fetch next page.
string
required
ID of the ClickUp Workspace to list Docs from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_SET_CUSTOM_FIELD_VALUESets 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.

Input Parameters

string
required
The value to set for the Custom Field. Structure depends on field type: Text/Short Text: string (e.g., ‘Hello’). Number/Currency/Emoji(Rating): number (e.g., 42). Checkbox: boolean (true/false). Dropdown: option UUID string from type_config.options (e.g., ‘7a4e5845-8496-4b9f-9097-843b9c737692’). Date: Unix timestamp in milliseconds (e.g., 1645502400000). Email: valid email string. Phone: string with country code (e.g., ‘+1 123 456 7890’). URL: valid URL string. Labels: array of label UUIDs from type_config (e.g., [‘label_id_1’, ‘label_id_2’]). Users/Tasks: object with ‘add’ and/or ‘rem’ arrays of IDs (e.g., {‘add’: [‘id1’], ‘rem’: [‘id2’]}). Location: object with ‘location’ (lat/lng) and ‘formatted_address’ (e.g., {‘location’: {‘lat’: -28.0, ‘lng’: 153.4}, ‘formatted_address’: ‘Gold Coast, Australia’}). Manual Progress: object with ‘current’ value (e.g., {‘current’: 50}).
string
required
Task ID to update. Standard ID, or Custom Task ID if custom_task_ids is true.
string
Team ID, required if custom_task_ids is true.
string
required
UUID of the Custom Field to update (must be in standard UUID format with hyphens, e.g., ‘0f079e26-feef-410d-8e8d-2a21a057ee5e’). Obtainable via ‘Get Accessible Custom Fields’ or ‘Get Task’ endpoints.
object
Optional settings for certain field types. For Date fields: {‘time’: true} to display time in ClickUp UI. For Currency fields: {‘currency_type’: ‘USD’} to specify currency.
boolean
If true, task_id is treated as a Custom Task ID, and team_id is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_START_TIME_ENTRYStarts 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).

Input Parameters

string
The ID of the task to associate with this time entry. If custom_task_ids is true, this should be the custom task ID.
array
Array of tag objects (each with “name”, optionally “tag_bg”, “tag_fg” for colors) to apply. This feature requires Business Plan or higher. E.g., [{"name": "Urgent", "tag_bg": "#FF0000"}].
string
required
The Workspace ID (also called Team ID in ClickUp API) for this time entry. This goes in the URL path.
string
The ID of the team for resolving custom task IDs. Required only if custom_task_ids is set to true. For example: custom_task_ids=true&team_id=123.
boolean
Specifies if the time entry is billable.
string
Description for the time entry.
boolean
If set to true, the tid field will be interpreted as a custom task ID. Requires team_id query parameter to be set for custom task ID resolution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_STOP_TIME_ENTRYStops the authenticated user’s currently active time entry in the specified Team (Workspace), which requires an existing time entry to be running.

Input Parameters

string
required
The unique numeric identifier of the Team (Workspace) where the time entry is being tracked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_TRACK_TIMERecords a time entry for a task using ClickUp’s legacy time tracking system; newer endpoints are generally recommended.

Input Parameters

integer
required
The end time of the time entry, as a Unix timestamp in milliseconds.
integer
required
The duration of the time entry, in milliseconds. If start and end are both provided, this time field is ignored. If time is passed with start but no end, then end will be calculated. If time is passed with end but no start, then start will be calculated.
integer
required
The start time of the time entry, as a Unix timestamp in milliseconds.
string
required
The unique identifier of the task to track time for.
string
The ID of the team. Required and used only if custom_task_ids is set to true to identify the task by its custom ID. For example: custom_task_ids=true&team_id=123.
boolean
If true, the task_id is treated as a custom task ID. Requires team_id to be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_CHAT_CHANNELTool 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.

Input Parameters

string
The updated name of the Chat channel.
string
The updated topic of the Chat channel.
object
Location information for the chat channel.
string
required
The ID of the specified Channel.
string ("PUBLIC" | "PRIVATE")
Visibility setting for chat channel.
string
The updated description of the Chat channel.
integer
required
The ID of the Workspace.
string ("text/md" | "text/plain")
Content format for channel messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_CHAT_MESSAGETool 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.

Input Parameters

string
The full content of the message to be updated. Maximum 40,000 characters. If not provided, message content will not be changed.
string
The possible assignee of the message. User ID as string.
boolean
The resolved status of the message. Set to true to mark as resolved, false to mark as unresolved.
object
Post data subtype information.
string
required
The ID of the message to update.
string
required
The ID of the Workspace containing the chat message. Numeric string.
string ("text/md" | "text/plain")
Content format enum for chat messages.
string
The possible group assignee of the message. Team/group ID as string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_CHECKLISTUpdates an existing checklist’s name or position, identified by its checklist_id.

Input Parameters

string
New name for the checklist.
integer
New 0-indexed display order for the checklist on a task (e.g., 0 for top).
string
required
The unique identifier (UUID) of the checklist to be edited.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_CHECKLIST_ITEMUpdates an existing checklist item, allowing modification of its name, assignee, resolution status, or parent item for nesting.

Input Parameters

string
The new name for the checklist item.
string
The checklist_item_id of an existing item within the same checklist to nest this item under.
string
The integer user ID to assign to this checklist item. To unassign, consult ClickUp API documentation for the appropriate value (e.g., 0 or null).
boolean
Set to true to mark the item as resolved, or false to mark it as unresolved.
string
required
The unique identifier (UUID) of the checklist containing the item to be edited.
string
required
The unique identifier (UUID) of the checklist item to be edited.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_COMMENTUpdates an existing task comment by ID, supplying its text, assignee, and resolution status.

Input Parameters

integer
required
User ID of the assignee for the comment.
boolean
required
Set to true to mark the comment as resolved, or false to mark it as unresolved.
string
required
The unique identifier of the comment to be updated.
string
required
The new text content for the comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_FOLDERUpdates the name of an existing folder in ClickUp.

Input Parameters

string
required
New name for the folder.
string
required
Unique identifier of the folder to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_GOALUpdates an existing ClickUp goal by ID. Requires its name, description, due date, color, and lists of owners to add and remove.

Input Parameters

string
required
New name for the goal.
string
required
New color (hex code).
string
required
Unique identifier (UUID) of the goal to update.
integer
required
New due date (Unix timestamp in milliseconds).
array
required
User IDs to add as owners.
array
required
User IDs to remove as owners.
string
required
New description for the goal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_GUEST_ON_WORKSPACEModifies the details and permissions of an existing guest user within a specific Workspace.

Input Parameters

string
required
The unique identifier of the Workspace (Team) where the guest belongs. Example: 123456.
string
required
The unique identifier of the guest user to be edited. Example: 98765.
string
The new username to assign to the guest. Optional - only include if you want to change the guest’s username.
boolean
Boolean flag to allow or disallow the guest to edit tags. Optional - only include if you want to change this permission.
integer
Identifier of a custom role for the guest. Ensure this ID is valid within the workspace. Optional - only include if you want to assign/change the custom role. (Note: Business Plus Plan supports one custom role; Enterprise Plan supports unlimited).
boolean
Boolean flag to allow or disallow the guest to create views. Optional - only include if you want to change this permission.
boolean
Boolean flag to allow or disallow the guest to see time spent on tasks. Optional - only include if you want to change this permission.
boolean
Boolean flag to allow or disallow the guest to see time estimated for tasks. Optional - only include if you want to change this permission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_KEY_RESULTUpdates an existing ClickUp key result’s progress and note. Both the current progress value and note are required.

Input Parameters

string
required
A note or comment to add or update for the key result.
string
required
The unique identifier (UUID) of the key result to be edited.
integer
required
The current progress of steps for the key result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_LISTUpdates attributes of an existing ClickUp list, such as its name, content, due date, priority, assignee, or color status, identified by its list_id.

Input Parameters

string
New name for the list.
string
Color for the list (e.g., ‘red’ or ‘#FF0000’), visually representing its status (not task status).
string
New description or informational content for the list.
string
required
ID of the list to be updated.
string
User ID to be set as the assignee for the list, replacing any existing assignee.
integer
New due date for the list, as a Unix timestamp in milliseconds (e.g., 1672531199000 for Dec 31, 2022, 11:59:59 PM UTC).
integer
Priority level: 1 (Urgent), 2 (High), 3 (Normal), 4 (Low), or 0 to unset.
boolean
Set to true to remove the list’s color, overriding status; if false, status updates or maintains current color.
boolean
Indicates if due_date includes a specific time; if false, it’s an all-day event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_SPACEUpdates a ClickUp Space’s name, color, privacy, multiple-assignee setting, and optionally its feature settings (ClickApps). The name, color, privacy, and multiple-assignee setting are required.

Input Parameters

string
required
The new name for the Space.
string
required
The new color for the Space, in hexadecimal format.
boolean
required
Whether the Space should be private.
string
required
The ID of the Space to update.
boolean
Whether admins can manage this private Space. This is an Enterprise Plan feature. Must be omitted for non-Enterprise workspaces.
boolean
required
Whether tasks in this Space can have multiple assignees.
boolean
Enable or disable the Tags ClickApp. When any feature parameter is provided, all feature keys must be included (due_dates, time_estimates, time_tracking, remap_dependencies, custom_fields, dependency_warning, tags, checklists, portfolios).
boolean
Enable or disable the Due Dates ClickApp.
boolean
Enable or disable the Checklists ClickApp.
boolean
Enable or disable the Portfolios ClickApp.
boolean
Enable or disable Start Dates for the Due Dates ClickApp.
boolean
Enable or disable the Custom Fields ClickApp.
boolean
Enable or disable the Time Tracking ClickApp.
boolean
Enable or disable the Time Estimates ClickApp.
boolean
Enable or disable remapping of due dates for the Due Dates ClickApp.
boolean
Enable or disable Dependency Warning for the Task Dependencies ClickApp.
boolean
Enable or disable Remap Dependencies for the Task Dependencies ClickApp.
boolean
Enable or disable remapping of closed due dates for the Due Dates ClickApp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_SPACE_TAGUpdates 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.

Input Parameters

string
required
Unique identifier of the Space containing the tag.
string
required
Current name of the tag to edit. This tag must exist within the specified Space.
string
New name to assign to the tag.
string
New background color for the tag, specified as a hexadecimal string (e.g., ‘#000000’).
string
New foreground color for the tag, specified as a hexadecimal string (e.g., ‘#FFFFFF’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_TASKUpdates 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.

Input Parameters

string
New task name.
string
ID of new parent task to make this a subtask; cannot convert subtask to regular task this way.
string
New task status (case-sensitive, must be valid in Workspace).
string
required
Unique task identifier; use custom task ID if custom_task_ids is true.
string
Team ID, required if custom_task_ids is true.
boolean
True to archive, false to unarchive.
integer
New due date (Unix timestamp in milliseconds).
integer
Priority: 1 (Urgent), 2 (High), 3 (Normal), 4 (Low). Omit or None to remove.
integer
New start date (Unix timestamp in milliseconds).
string
New task description; use a single space (” ”) to clear.
boolean
True if due_date includes time, false if all-day.
integer
New time estimate in milliseconds.
array
List of user IDs to add as assignees.
array
List of user IDs to remove as assignees.
integer
Custom task type ID. Use 1 for Milestone, its ID for custom type. Omit/None to make regular task (API’s ‘null’ equivalent).
boolean
If true, task_id is a custom ID and team_id is required.
boolean
True if start_date includes time, false if all-day.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_TEAMUpdates an existing ClickUp User Group (Team) using its group_id; note that adding a view-only guest as a paid member may incur charges.

Input Parameters

string
The new name for the User Group (Team).
string
The new handle for the User Group (Team), used for @mentions (e.g., ‘@developers’).
string
required
The ID of the User Group (Team) to update.
array
A list of user IDs to add to the User Group (Team).
array
A list of user IDs to remove from the User Group (Team).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_TIME_ENTRYUpdates 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.

Input Parameters

integer
New end time (Unix timestamp in milliseconds). If provided, start must also be provided.
string
The ID of the task for this time entry; if custom_task_ids is true, this should be the custom task ID.
array
List of tag objects (e.g., {'name': 'your-tag'}) for the time entry. Time tracking labels are for Business Plan and above users.
integer
New start time (Unix timestamp in milliseconds). If provided, end must also be provided.
string
required
The ID of the Team (Workspace) for the time entry. Path parameter.
boolean
Indicates whether the time entry is billable.
integer
New duration of the time entry in milliseconds; can be an alternative to start and end times.
string
required
The unique identifier of the time entry to update. Path parameter.
string
Specifies how to handle tags (e.g., ‘add’, ‘remove’).
string
A new description for the time entry.
boolean
If true, tid is interpreted as a custom task ID. When true, the team_id path parameter value will also be used as a query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_TIME_ENTRY_TAGUpdates an existing time entry tag in a workspace, identified by its current name. Requires the new name, background color, and foreground color.

Input Parameters

string
required
The current name of the time entry tag to be modified.
string
required
The new background color for the tag, specified as a hexadecimal color code.
string
required
The new foreground (text) color for the tag, specified as a hexadecimal color code.
string
required
The unique identifier of the Team (Workspace) where the time entry tag exists.
string
required
The new name to be assigned to the time entry tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_TIME_TRACKEDEdits 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.

Input Parameters

integer
required
New end date and time for the interval as a Unix timestamp in milliseconds.
integer
required
New total duration of the time interval in milliseconds; typically the difference between end and start.
integer
required
New start date and time for the interval as a Unix timestamp in milliseconds.
string
required
Unique task identifier; refers to custom task ID if custom_task_ids is true.
integer
Team ID, required if custom_task_ids is true.
string
required
Unique identifier of the time interval record to edit.
boolean
If true, task_id is treated as a custom task ID, and team_id must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_USER_ON_WORKSPACEUpdates a user’s username, admin status, or custom role in a Workspace; requires the Workspace to be on an Enterprise Plan.

Input Parameters

boolean
Set true to make user an admin, false to revoke admin privileges. Optional - only include if you want to change admin status.
string
required
Workspace (formerly Team) ID where the user resides.
string
required
ID of the user whose details are to be edited.
string
New username to assign. Optional - only include if you want to change the username.
integer
ID of the custom role to assign, defining their permissions. Optional - only include if you want to change the custom role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_VIEWUpdates 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.

Input Parameters

string
required
The new name for the view.
string
required
The type of the view.
string
required
The unique identifier of the view to be updated.
string
The ID of the Workspace, Space, Folder, or List where the view is located.
null
The direction for dividing the view. Currently, this field may not be actively used or may be deprecated.
string
The operator for combining filters. Available values are AND and OR.
integer
The level of the Hierarchy where the view is created. Options include: Workspace (Everything Level): 7, Space: 4, Folder: 5, List: 6.
null
The field to divide the view by (e.g., to create swimlanes in a board view). Currently, this field may not be actively used or may be deprecated.
integer
The sort order for grouping. Use 1 for ascending (e.g., urgent priority at the top) or -1 for descending (e.g., no priority at the top).
array
Fields to display as columns in the view. Custom Fields require the _cf prefix and their ID (e.g., _cf_custom_field_id).
array
Fields to apply filters on; refer to ClickUp API documentation for available fields.
string
A search string to filter tasks by name or content.
string
The field to group tasks by. Options include: none, status, priority, assignee, tag, or dueDate.
array
Fields to sort tasks by; refer to ClickUp API documentation for available filter fields.
boolean
If true, tasks with no value for the grouping_field will not be grouped.
boolean
Indicates if divided sections should be collapsed. Currently, this field may not be actively used or may be deprecated.
array
A list of group identifiers (e.g., status names or assignee IDs) that should be collapsed by default in the view.
boolean
If true, closed tasks will be included in the view.
boolean
If true, in ‘Me Mode’, only comments where the current user is mentioned or involved will be shown.
boolean
If true, in ‘Me Mode’, only subtasks assigned to the current user will be shown.
boolean
If true, images attached to tasks will be displayed in the view (e.g. cover images in card view).
boolean
If true, in ‘Me Mode’, only checklists assigned to the current user will be shown.
integer
Controls how subtasks are displayed. Acceptable values are 1 (show subtasks as separate tasks), 2 (show subtasks expanded under parent task), or 3 (show subtasks collapsed under parent task).
array
A list of assignee user IDs to feature in the team sidebar.
boolean
If true, assignees will be displayed on tasks.
boolean
If true, task locations (List, Folder, Space) will be displayed.
boolean
If true, closed subtasks will be included in the view.
boolean
If true, unassigned tasks will be shown in the team sidebar.
boolean
If true, assigned comments will be shown in the team sidebar.
string
If true, columns with no tasks will be collapsed (e.g., in Board view). This might accept boolean as a string like ‘true’ or ‘false’.
boolean
If true, parent task names will be displayed for subtasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_WEBHOOKUpdates the endpoint URL, monitored events, and status of an existing webhook, identified by its webhook_id.

Input Parameters

array
required
List of event types to monitor. Use [”*”] to subscribe to all events. Common events include: taskCreated, taskUpdated, taskDeleted, taskStatusUpdated, taskAssigneeUpdated, taskDueDateUpdated, taskTagUpdated, taskMoved, taskCommentPosted, taskCommentUpdated, listCreated, listUpdated, listDeleted, folderCreated, folderUpdated, folderDeleted, spaceCreated, spaceUpdated, spaceDeleted, goalCreated, goalUpdated, goalDeleted, keyResultCreated, keyResultUpdated, keyResultDeleted.
string
required
The desired status of the webhook after the update.
string
required
The new URL where the webhook payloads will be sent.
string
required
The unique identifier of the webhook to be updated. Example: ‘e506-4a29-9d42-26e504e3435e’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKUP_UPDATE_WORKSPACE_ACLUpdates 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.

Input Parameters

array
The user or user group (Team) entries to give, remove, or edit permissions. Each entry must include ‘kind’ (user or user_group) and ‘id’. Optionally include ‘permission_level’ to set specific permissions.
boolean
Set the privacy of the object or location. True for private, false for public.
string
required
The ID of the specific object to update ACL permissions for.
string ("attachment" | "attachmentAccess" | "approval" | "banWorkspace" | "checklist" | "checklistItem" | "checklistTemplateAccess" | "comment" | "commentsLastReadAt" | "customField" | "customFieldAccess" | "customItem" | "customPermissionLevel" | "dashboard" | "dashboardAccess" | "doc" | "docAccess" | "folder" | "folderDescendantsSet" | "folderTemplateAccess" | "form" | "formulaValue" | "foundationalJob" | "goal" | "goalAccess" | "goalFolder" | "goalFolderAccess" | "hierarchy" | "list" | "listDescendantsSet" | "listDescendantsPoints" | "listDescendantsTimeEstimates" | "listTemplateAccess" | "notepad" | "page" | "pageAccess" | "post" | "reminder" | "reminderAccess" | "rolledUpFieldValue" | "scheduledComment" | "space" | "spaceDescendantsSet" | "spaceTemplateAccess" | "task" | "taskAccess" | "taskHistory" | "taskProperty" | "taskTemplateAccess" | "template" | "user" | "userAccess" | "userGroup" | "userHierarchy" | "userPresence" | "view" | "viewAccess" | "viewTemplateAccess" | "whiteboard" | "whiteboardAccess" | "widget" | "workspace" | "workspaceDescendantsSet" | "workscheduleWorkweekSchedule" | "workscheduleScheduleExceptions")
required
The type of object to update ACL permissions for.
string
required
The ID of the Workspace. Numeric string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: CLICKUP_FOLDER_CREATEDType: webhookTriggers when a new Folder is created.

Configuration

string
Restrict events to this Space. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

string
required
Id of the Folder that triggered the event.
integer
required
Numeric Workspace id the Folder lives in.
Slug: CLICKUP_FOLDER_DELETEDType: webhookTriggers when a Folder is deleted.

Configuration

string
Restrict events to this Space. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

string
required
Id of the Folder that triggered the event.
integer
required
Numeric Workspace id the Folder lives in.
Slug: CLICKUP_FOLDER_UPDATEDType: webhookTriggers when a Folder is updated (renamed, content edited, etc.).

Configuration

string
Restrict events to this Space. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

string
required
Id of the Folder that triggered the event.
integer
required
Numeric Workspace id the Folder lives in.
Slug: CLICKUP_LIST_CREATEDType: webhookTriggers when a new List is created.

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

string
required
Id of the List that triggered the event.
integer
required
Numeric Workspace id the List lives in.
Slug: CLICKUP_LIST_DELETEDType: webhookTriggers when a List is deleted.

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

string
required
Id of the List that triggered the event.
integer
required
Numeric Workspace id the List lives in.
Slug: CLICKUP_LIST_UPDATEDType: webhookTriggers when a List is updated (renamed, content edited, etc.).

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

array
Per-field changes on the List — typically a single NameChange (rename). Each change carries its own actor and occurred_at.
string
required
Id of the List that was updated.
integer
required
Numeric Workspace id the List lives in.
Slug: CLICKUP_SPACE_CREATEDType: webhookTriggers when a new Space is created in the Workspace.

Configuration

string
required
Your ClickUp Workspace ID (numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

string
required
Id of the Space that triggered the event.
integer
required
Numeric Workspace id the Space lives in.
Slug: CLICKUP_SPACE_DELETEDType: webhookTriggers when a Space is deleted.

Configuration

string
required
Your ClickUp Workspace ID (numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

string
required
Id of the Space that triggered the event.
integer
required
Numeric Workspace id the Space lives in.
Slug: CLICKUP_SPACE_UPDATEDType: webhookTriggers when a Space is updated (renamed, settings changed, etc.).

Configuration

string
required
Your ClickUp Workspace ID (numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

string
required
Id of the Space that triggered the event.
integer
required
Numeric Workspace id the Space lives in.
Slug: CLICKUP_TASK_ASSIGNEE_UPDATEDType: webhookTriggers when an assignee is added to or removed from a task.changes[] carries AssigneeAddChange and/or AssigneeRemoveChange entries. A single event may bundle multiple adds and/or removes — for example when a workflow re-routes a task between two users in one operation.

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

array
Per-field changes carried by this event. Each entry is a typed change class discriminated on field — match on isinstance() or check change.field to read the typed value. Each change carries its own actor and occurred_at.
string
required
Id of the task this event is about.
integer
required
Numeric Workspace id the task lives in.
Slug: CLICKUP_TASK_COMMENT_POSTEDType: webhookTriggers when a comment is added to a task.changes[] carries one CommentChange entry whose comment field is the typed ClickupComment object (id, text, user, reactions, etc.).

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

array
Per-field changes carried by this event. Each entry is a typed change class discriminated on field — match on isinstance() or check change.field to read the typed value. Each change carries its own actor and occurred_at.
string
required
Id of the task this event is about.
integer
required
Numeric Workspace id the task lives in.
Slug: CLICKUP_TASK_COMMENT_UPDATEDType: webhookTriggers when an existing comment on a task is edited.changes[] carries one CommentChange entry whose comment field is the comment in its updated form.

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

array
Per-field changes carried by this event. Each entry is a typed change class discriminated on field — match on isinstance() or check change.field to read the typed value. Each change carries its own actor and occurred_at.
string
required
Id of the task this event is about.
integer
required
Numeric Workspace id the task lives in.
Slug: CLICKUP_TASK_CREATEDType: webhookTriggers when a new task is created in the configured Workspace.

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

object
A ClickUp user as it appears in webhook payloads. Slimmed to the four fields a customer typically uses; ClickUp’s noise (role, role_subtype, color, initials, profile_picture_key) is dropped on output.
object
A status as it appears in webhook before/after values. Webhook status objects omit the id that GET /task ships, and status can be null to represent the “no prior status” side of a creation event.
string
Millisecond-epoch time of the creation.
string
required
Id of the task that was created.
integer
required
Numeric Workspace id the task lives in.
Slug: CLICKUP_TASK_DELETEDType: webhookTriggers when a task is deleted.ClickUp ships no history_items or actor info on deletes — the payload carries only the task_id and team_id.

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

string
required
Id of the task that was deleted.
integer
required
Numeric Workspace id the task belonged to.
Slug: CLICKUP_TASK_DUE_DATE_UPDATEDType: webhookTriggers when a task’s due date is set, changed, or cleared.changes[] carries DueDateChange entries only; before and after are millisecond-epoch strings or null.

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

array
Per-field changes carried by this event. Each entry is a typed change class discriminated on field — match on isinstance() or check change.field to read the typed value. Each change carries its own actor and occurred_at.
string
required
Id of the task this event is about.
integer
required
Numeric Workspace id the task lives in.
Slug: CLICKUP_TASK_PRIORITY_UPDATEDType: webhookTriggers when a task’s priority changes.changes[] carries PriorityChange entries only.

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

array
Per-field changes carried by this event. Each entry is a typed change class discriminated on field — match on isinstance() or check change.field to read the typed value. Each change carries its own actor and occurred_at.
string
required
Id of the task this event is about.
integer
required
Numeric Workspace id the task lives in.
Slug: CLICKUP_TASK_STATUS_UPDATEDType: webhookTriggers when a task’s status changes.changes[] carries StatusChange entries only — ClickUp pre-filters server-side by event type. Lower traffic than subscribing to CLICKUP_TASK_UPDATED and pattern-matching StatusChange.

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

array
Per-field changes carried by this event. Each entry is a typed change class discriminated on field — match on isinstance() or check change.field to read the typed value. Each change carries its own actor and occurred_at.
string
required
Id of the task this event is about.
integer
required
Numeric Workspace id the task lives in.
Slug: CLICKUP_TASK_TAG_UPDATEDType: webhookTriggers when a tag is added to or removed from a task.changes[] carries TagAddChange and/or TagRemoveChange entries. Adds use ClickUp’s field == "tag", removes use the undocumented field == "tag_removed"; both are normalised into the typed change classes.

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

array
Per-field changes carried by this event. Each entry is a typed change class discriminated on field — match on isinstance() or check change.field to read the typed value. Each change carries its own actor and occurred_at.
string
required
Id of the task this event is about.
integer
required
Numeric Workspace id the task lives in.
Slug: CLICKUP_TASK_TIME_ESTIMATE_UPDATEDType: webhookTriggers when a task’s time estimate is set, changed, or cleared.changes[] carries TimeEstimateChange entries only; before and after are millisecond strings or null.

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

array
Per-field changes carried by this event. Each entry is a typed change class discriminated on field — match on isinstance() or check change.field to read the typed value. Each change carries its own actor and occurred_at.
string
required
Id of the task this event is about.
integer
required
Numeric Workspace id the task lives in.
Slug: CLICKUP_TASK_TIME_TRACKED_UPDATEDType: webhookTriggers when a time-tracking interval is created, edited, or deleted on a task.Fires once per interval-change. Reads ClickUp’s top-level data.description for the lifecycle action and data.interval_id for the correlation key — these are unique to time-tracking events and are present even on Deleted (where history_items is empty).

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

string ("Time Tracking Created" | "Time Tracking Edited" | "Time Tracking Deleted")
required
Which lifecycle action fired this event.
object
A ClickUp user as it appears in webhook payloads. Slimmed to the four fields a customer typically uses; ClickUp’s noise (role, role_subtype, color, initials, profile_picture_key) is dropped on output.
object
A time-tracking interval as it appears in webhook after. Only this fixed set of fields ships in the webhook; description, billable, tags, and task_location require CLICKUP_GET_TIME_ENTRY.
string
required
Stable id of the time entry. The same value flows through this entry’s Created → Edited → Deleted events; use it to correlate across the lifecycle.
string
Millisecond-epoch time of the change; null on Deleted.
string
required
Id of the task the interval is logged on.
integer
required
Numeric Workspace id the task lives in.
Slug: CLICKUP_TASK_UPDATEDType: webhookTriggers when a task is updated.Fires for every kind of update on the task, including comments. If you only care about a specific property changing, prefer the dedicated trigger (CLICKUP_TASK_STATUS_UPDATED, etc.) — those are pre-filtered by ClickUp and produce less traffic.changes[] can carry any FieldChange variant (StatusChange, PriorityChange, AssigneeAddChange, AssigneeRemoveChange, TagAddChange, TagRemoveChange, DueDateChange, TimeEstimateChange, TimeSpentChange, NameChange, ContentChange, CommentChange, CustomFieldChange).

Configuration

string
Restrict events to this Folder. Mutually exclusive with space_id and list_id. Use CLICKUP_GET_FOLDERS to discover valid Folder IDs.
string
Restrict events to this List. Mutually exclusive with space_id and folder_id. Use CLICKUP_GET_LISTS (or CLICKUP_GET_FOLDERLESS_LISTS for folderless lists) to discover valid List IDs.
string
Restrict events to this Space. Mutually exclusive with folder_id and list_id. Use CLICKUP_GET_SPACES to discover valid Space IDs.
string
required
Your ClickUp Workspace ID (the numeric team_id). Use CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES to discover valid Workspace IDs.

Payload

array
Per-field changes carried by this event. Each entry is a typed change class discriminated on field — match on isinstance() or check change.field to read the typed value. Each change carries its own actor and occurred_at.
string
required
Id of the task this event is about.
integer
required
Numeric Workspace id the task lives in.