Skip to Content

ClickUp API

ClickUp API icon
Arcade Starter

Tools that enable LLMs to interact directly with the clickup API.

Author:Arcade
Version:1.0.0
Auth:User authorization via the Clickup auth provider
134tools
PyPI VersionPython VersionsWheel StatusDownloadsLicense

Arcade's ClickupApi toolkit enables seamless interaction with the ClickUp API, allowing developers to manage tasks, views, checklists, and more within their ClickUp workspaces. Capabilities:

  • Create, update, and delete tasks, lists, and views.
  • Add comments and checklists to tasks for effective collaboration.
  • Retrieve and manage time entries, goals, and custom fields.
  • Organize tasks by using tags and dependencies for better workflow management.

OAuth:

  • Provider: ClickUp; Scopes: None.

Secrets: None.

Available tools(134)

134 of 134
Tool nameDescriptionSecrets
Add a new comment to a Chat view. Use this tool to add a comment to a Chat view in ClickUp. This can be used to facilitate discussion and share information in a specific View context.
Add an item to a checklist in ClickUp tasks. Use this tool to add a new line item to an existing checklist within a task in ClickUp. This can be useful for task management and ensuring all steps are documented within a checklist.
Add a new checklist to a task in ClickUp. Use this tool to add a checklist to a specific task in ClickUp by providing the task ID.
Add a comment to a specific list in ClickUp. This tool allows you to add a comment to a specified list in ClickUp. Use it when you need to provide additional information or feedback on a list.
Add a new folderless list to a specified space. This tool is used to create a new list within a specified space in ClickUp without associating it with a folder. It facilitates the organization of tasks directly within the space.
Share a folder with a guest in ClickUp's Enterprise Plan. This tool shares a specific folder with a guest, available only for ClickUp Workspaces on the Enterprise Plan. Use it to collaborate by granting access to specified guests.
Add a guest to a specific list in ClickUp. This tool adds a guest to a list within ClickUp, available only for Enterprise Plan workspaces.
Add a new task tag to a specified space in ClickUp. Use this tool to create a new tag for tasks within a specific space in ClickUp. It's useful for organizing tasks by category or priority.
Add a new view to a ClickUp space. Use this tool to add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a ClickUp Space. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Add a tag to a specific task in ClickUp. Use this tool to assign a tag to a task in ClickUp by specifying the task ID and tag name. It helps in organizing and categorizing tasks efficiently.
Add a label to a specific time entry in ClickUp. This tool is used to attach a label to a time entry for a specific team in ClickUp. It should be called when you want to organize or categorize time entries with tags for better tracking and management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Add a target to a specific goal in ClickUp. Use this tool to add a key result target to an existing goal in ClickUp, enhancing goal tracking and achievement.
Add a new comment to a specific task on ClickUp. This tool allows users to add a new comment to a specified task on ClickUp. It should be called when there's a need to comment on a task, offering a way to communicate updates, feedback, or any relevant information directly related to the task in question.
Add a task to an additional list in ClickUp. This tool adds a specified task to an additional list in ClickUp, requiring the 'Tasks in Multiple List' ClickApp to be enabled. Use this tool to manage tasks across multiple lists efficiently.
Add various views to a ClickUp list. Use this tool to add different types of views (List, Board, Calendar, etc.) to a specific ClickUp list using the list ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Add various view types to a ClickUp folder. Use this tool to add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a specific folder in ClickUp. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Log time entry for a ClickUp task using legacy endpoint. This tool allows logging time entries for a specific ClickUp task using a legacy API endpoint. It should be called when you need to record time spent on tasks, although it's recommended to use the updated Time Tracking API for new implementations.
Configure options for a guest in a workspace. This tool adjusts settings for a guest in a ClickUp workspace, specifically for teams on the Enterprise Plan.
Create a new list in a ClickUp folder. Use this tool to add a new list to a specified folder in ClickUp. Ideal for organizing tasks or projects within a folder.
Creates a new folder from a template in a ClickUp space. This tool creates a new folder using a predefined template within a specified ClickUp space. It can also incorporate nested assets like lists and tasks from the template into the new folder. Templates must be added to your Workspace before use. The operation can be executed asynchronously or synchronously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Add a new Folder to a Space in ClickUp. This tool allows you to create a new folder within a specified space in ClickUp. Use it when you need to organize tasks or projects into a new folder under an existing space.
Create a new list in a folder using a template. Use this tool to create a new list in a ClickUp folder using an existing list template. Ensure the template is added to your Workspace library before invoking this tool. The tool returns the future List ID immediately, though the list creation may continue asynchronously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Create a new list in a ClickUp space using a template. This tool creates a new list within a specified ClickUp space using a provided list template. Publicly shared templates must be added to the Workspace before they can be used. The operation can be performed asynchronously or synchronously based on the 'return_immediately' parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Create a new task in ClickUp. This tool is used to create a new task in a specified list on ClickUp. It should be called when you need to add a task to your ClickUp project management system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Add a new Space to a Workspace. Use this tool to create a new space within a specified workspace on ClickUp. It should be called when a user wants to organize tasks or projects under a new space in their team environment. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Page 1 of 6(25 of 134)

Selected tools

No tools selected.

Click "Show all tools" to add tools.

Requirements

Select tools to see requirements

#

ClickupApi.AddChatViewComment

Add a new comment to a Chat view. Use this tool to add a comment to a Chat view in ClickUp. This can be used to facilitate discussion and share information in a specific View context.

Parameters

ParameterTypeReq.Description
comment_textstringRequiredThe text content of the comment to be added to the Chat view.
send_notifications_to_allbooleanRequiredSet to true to send notifications to everyone, including the comment creator.
view_idstringRequiredThe ID of the Chat view where the comment will be added. Expected as a string.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateChatViewComment'.
#

ClickupApi.AddChecklistItemClickup

Add an item to a checklist in ClickUp tasks. Use this tool to add a new line item to an existing checklist within a task in ClickUp. This can be useful for task management and ensuring all steps are documented within a checklist.

Parameters

ParameterTypeReq.Description
checklist_identifierstringRequiredA unique identifier for the checklist. Must be in UUID format.
assignee_user_idintegerOptionalThe unique ID of the user assigned to the checklist item. This should be an integer value representing the user's ID.
checklist_item_namestringOptionalThe name of the checklist item to be added. This should clearly describe the task or item to be completed.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateChecklistItem'.
#

ClickupApi.AddChecklistToTask

Add a new checklist to a task in ClickUp. Use this tool to add a checklist to a specific task in ClickUp by providing the task ID.

Parameters

ParameterTypeReq.Description
checklist_namestringRequiredThe name or title of the checklist to be added to the task. It should be a descriptive string identifying the purpose or contents of the checklist.
task_identifierstringRequiredA unique identifier for the task to which the checklist will be added. It can be a custom or default task ID.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_id_for_custom_taskintegerOptionalProvide the Workspace ID when 'custom_task_ids' is set to true. It's necessary to reference tasks by custom IDs.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateChecklist'.
#

ClickupApi.AddCommentToList

Add a comment to a specific list in ClickUp. This tool allows you to add a comment to a specified list in ClickUp. Use it when you need to provide additional information or feedback on a list.

Parameters

ParameterTypeReq.Description
assignee_idintegerRequiredThe ID of the user to whom the comment is assigned. This should be an integer value representing the user's unique identifier.
comment_textstringRequiredThe text of the comment to be added to the list. This should contain the message or information you wish to convey.
list_identifierintegerRequiredThe unique ID of the list where the comment will be added.
notify_allbooleanRequiredIf true, notifications are sent to everyone, including the comment creator.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateListComment'.
#

ClickupApi.AddFolderlessListToSpace

Add a new folderless list to a specified space. This tool is used to create a new list within a specified space in ClickUp without associating it with a folder. It facilitates the organization of tasks directly within the space.

Parameters

ParameterTypeReq.Description
list_namestringRequiredThe name of the new list to be created within the space.
space_idintegerRequiredThe unique identifier of the space where the list will be added.
due_date_timestampintegerOptionalAn integer representing the UNIX timestamp for the list's due date. This defines the deadline for the list.
include_due_timebooleanOptionalSet to true if the due date should include a specific time.
list_color_statusstringOptionalSpecifies the color representing the List. This is for visual identification and does not affect task statuses.
list_descriptionstringOptionalA text description for the new list. Use plain text. For markdown, use `markdown_content`.
list_markdown_descriptionstringOptionalMarkdown formatted description for the list. Use this instead of a plain text description.
list_owner_user_idintegerOptionalThe user ID for the list owner to be assigned to the new list.
list_priority_levelintegerOptionalSet the priority level for the list. It should be an integer value indicating the list's urgency or importance.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateFolderlessList'.
#

ClickupApi.AddGuestToFolder

Share a folder with a guest in ClickUp's Enterprise Plan. This tool shares a specific folder with a guest, available only for ClickUp Workspaces on the Enterprise Plan. Use it to collaborate by granting access to specified guests.

Parameters

ParameterTypeReq.Description
folder_idintegerRequiredThe unique integer ID of the folder to be shared with the guest.
guest_identifierintegerRequiredThe unique identifier for the guest to whom the folder will be shared. This should be an integer representing the guest's ID.
guest_permission_levelstringRequiredDefines guest's access level: 'read' for view only, 'comment', 'edit', or 'create' for full access.
include_shared_itemsbooleanOptionalSet to true to include details of items shared with the guest. Default is true.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'AddGuestToFolder'.
#

ClickupApi.AddGuestToList

Add a guest to a specific list in ClickUp. This tool adds a guest to a list within ClickUp, available only for Enterprise Plan workspaces.

Parameters

ParameterTypeReq.Description
guest_idintegerRequiredThe unique identifier for the guest to be added. This should be an integer value.
guest_permission_levelstringRequiredPermission level for the guest on the list. Options are `read`, `comment`, `edit`, or `create`.
list_idintegerRequiredThe identifier of the list to which the guest will be added.
include_shared_detailsbooleanOptionalSet to false to exclude shared item details from the guest view; defaults to true to include them.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'AddGuestToList'.
#

ClickupApi.AddSpaceTaskTag

Add a new task tag to a specified space in ClickUp. Use this tool to create a new tag for tasks within a specific space in ClickUp. It's useful for organizing tasks by category or priority.

Parameters

ParameterTypeReq.Description
space_identifierintegerRequiredThe unique identifier for the space where the tag will be added. It must be an integer.
tag_background_colorstringRequiredHex code representing the background color for the tag. It should be a string in the format '#RRGGBB'.
tag_foreground_colorstringRequiredHex code for the tag's foreground color. It defines the text color of the tag.
tag_namestringRequiredName of the new tag to be added to the space. It should be a descriptive and concise identifier for categorizing tasks.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateSpaceTag'.
#

ClickupApi.AddSpaceView

Add a new view to a ClickUp space. Use this tool to add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a ClickUp Space. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
space_idintegerOptionalThe unique identifier of the ClickUp space where the view will be added. It should be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateSpaceView'.
#

ClickupApi.AddTagToTask

Add a tag to a specific task in ClickUp. Use this tool to assign a tag to a task in ClickUp by specifying the task ID and tag name. It helps in organizing and categorizing tasks efficiently.

Parameters

ParameterTypeReq.Description
content_typestringRequiredSpecifies the media type of the request. Typically set to 'application/json'.
tag_namestringRequiredThe name of the tag to add to the task. This should be a string representing the desired tag.
task_identifierstringRequiredThe unique identifier of the task to which the tag will be added. Can be a custom task ID if specified.
use_custom_task_idsbooleanOptionalSet to true if you want to reference a task using its custom task ID.
workspace_id_if_custom_task_idsintegerOptionalWorkspace ID required when referencing a task by its custom task ID. Only needed if `custom_task_ids=true`.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'AddTagToTask'.
#

ClickupApi.AddTagToTimeEntry

Add a label to a specific time entry in ClickUp. This tool is used to attach a label to a time entry for a specific team in ClickUp. It should be called when you want to organize or categorize time entries with tags for better tracking and management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
workspace_idintegerOptionalThe ID of the workspace where the time entry is located. This is required to specify which team the tag should be added to. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Addtagsfromtimeentries'.
#

ClickupApi.AddTargetToGoal

Add a target to a specific goal in ClickUp. Use this tool to add a key result target to an existing goal in ClickUp, enhancing goal tracking and achievement.

Parameters

ParameterTypeReq.Description
goal_identifierstringRequiredThe unique identifier (UUID) of the goal to which the target will be added.
initial_value_stepsintegerRequiredSpecify the starting value for the target's progress steps, as an integer.
linked_task_idsarray<string>RequiredAn array of task IDs to associate the target with tasks.
list_idsarray<string>RequiredArray of List IDs to associate the target with multiple Lists.
target_namestringRequiredSpecify the name for the target being added to the goal. It should be a descriptive label for easy identification.
target_owners_idsarray<integer>RequiredAn array of user IDs representing the owners of the key result target.
target_steps_endintegerRequiredSpecify the final value for the target steps. It indicates the goal completion threshold.
target_typestringRequiredSpecify the type of target (key result) as one of the following: `number`, `currency`, `boolean`, `percentage`, or `automatic`.
target_unitstringRequiredSpecify the unit for the target if using types like number, currency, or percentage.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateKeyResult'.
#

ClickupApi.AddTaskComment

Add a new comment to a specific task on ClickUp. This tool allows users to add a new comment to a specified task on ClickUp. It should be called when there's a need to comment on a task, offering a way to communicate updates, feedback, or any relevant information directly related to the task in question.

Parameters

ParameterTypeReq.Description
comment_contentstringRequiredThe text of the comment to be added to the task. It should contain any updates, feedback, or relevant information.
send_notifications_to_allbooleanRequiredIf true, notifications will be sent to everyone, including the creator of the comment.
specific_task_idstringRequiredThe ID of the task to add the comment to. Required for identifying the target task.
assignee_groupstringOptionalSpecifies a group of users (as a comma-separated string) to be assigned to the comment. Ensure the group is relevant to the task.
comment_assignee_idintegerOptionalAn integer representing the user ID of the assignee for the comment on the task.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_id_for_custom_taskintegerOptionalProvide the Workspace ID when referencing a task by its custom task ID (set `custom_task_ids` to true).

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateTaskComment'.
#

ClickupApi.AddTaskToClickupList

Add a task to an additional list in ClickUp. This tool adds a specified task to an additional list in ClickUp, requiring the 'Tasks in Multiple List' ClickApp to be enabled. Use this tool to manage tasks across multiple lists efficiently.

Parameters

ParameterTypeReq.Description
target_list_idintegerRequiredThe unique identifier for the target list where the task will be added. This is required to associate the task with the correct list in ClickUp.
task_identifierstringRequiredSpecify the ID of the task to be added to an additional list in ClickUp.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'AddTaskToList'.
#

ClickupApi.AddViewToClickupList

Add various views to a ClickUp list. Use this tool to add different types of views (List, Board, Calendar, etc.) to a specific ClickUp list using the list ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
clickup_list_idintegerOptionalAn integer representing the ID of the ClickUp list to which the view will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateListView'.
#

ClickupApi.AddViewToFolder

Add various view types to a ClickUp folder. Use this tool to add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a specific folder in ClickUp. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
folder_idintegerOptionalThe unique integer ID of the ClickUp folder where the view will be added. Required for specifying the target folder. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateFolderView'.
#

ClickupApi.ClickupLegacyTimeTracking

Log time entry for a ClickUp task using legacy endpoint. This tool allows logging time entries for a specific ClickUp task using a legacy API endpoint. It should be called when you need to record time spent on tasks, although it's recommended to use the updated Time Tracking API for new implementations.

Parameters

ParameterTypeReq.Description
clickup_task_idstringRequiredThe unique identifier of the task for which time is being logged. This can refer to either the standard task ID or a custom task ID if specified.
end_timestampintegerRequiredEpoch timestamp indicating when the time tracking ended for the task.
start_time_unix_epochintegerRequiredThe start time of the time entry in Unix epoch format. This is required to log time for a task.
time_spent_secondsintegerRequiredDuration of time spent on the task in seconds. This is the time you want to log for the specific task.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_idintegerOptionalProvide the Workspace ID when `custom_task_ids` is `true`.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Tracktime'.
#

ClickupApi.ConfigureWorkspaceGuest

Configure options for a guest in a workspace. This tool adjusts settings for a guest in a ClickUp workspace, specifically for teams on the Enterprise Plan.

Parameters

ParameterTypeReq.Description
guest_identifierintegerRequiredThe unique identifier for the guest to be configured in the workspace.
workspace_idintegerRequiredThe unique identifier for the ClickUp workspace where the guest is being configured. This is required for identifying the specific workspace.
allow_guest_to_edit_tagsbooleanOptionalSet to true to allow the guest to edit tags in the workspace; false to disallow.
allow_view_creationbooleanOptionalA boolean to specify if the guest can create views. True allows view creation, false denies it.
allow_viewing_points_estimatedbooleanOptionalSpecify if the guest can view estimated points in the workspace. True allows viewing; false restricts it.
allow_viewing_time_spentbooleanOptionalSet to true to allow the guest to view time spent on tasks, false to restrict.
can_see_time_estimatesbooleanOptionalDetermines if the guest can view time estimates. Use true to allow, false to restrict.
guest_custom_role_idintegerOptionalAn integer representing the custom role ID assigned to the guest in the workspace.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'EditGuestOnWorkspace'.
#

ClickupApi.CreateClickupList

Create a new list in a ClickUp folder. Use this tool to add a new list to a specified folder in ClickUp. Ideal for organizing tasks or projects within a folder.

Parameters

ParameterTypeReq.Description
folder_idintegerRequiredThe unique integer identifier for the folder where the new list will be added.
list_namestringRequiredThe name of the new list to be created within the specified ClickUp folder.
due_date_timestampintegerOptionalThe due date for the list in Unix timestamp format. Determines when the list should be completed.
formatted_list_descriptionstringOptionalProvide a markdown-formatted description for the List. Use this instead of plain text content.
include_time_in_due_datebooleanOptionalSet to true to include a specific time with the due date.
list_assignee_user_idintegerOptionalThe user ID to assign this list to a specific user. This identifies who will be responsible for the list.
list_colorstringOptionalSpecifies the color of the List, not related to task statuses.
list_descriptionstringOptionalA plain text description for the list. Use this to provide details about the list's purpose.
list_priorityintegerOptionalAn integer value indicating the priority of the list, where a higher number typically means higher priority.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateList'.
#

ClickupApi.CreateFolderFromTemplate

Creates a new folder from a template in a ClickUp space. This tool creates a new folder using a predefined template within a specified ClickUp space. It can also incorporate nested assets like lists and tasks from the template into the new folder. Templates must be added to your Workspace before use. The operation can be executed asynchronously or synchronously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
clickup_space_idstringOptionalID of the ClickUp Space where the folder will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
folder_template_idstringOptionalThe ID of the folder template to be used for creating a new folder in a ClickUp space. Ensure the template is added to your Workspace. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateFolderFromTemplate'.
#

ClickupApi.CreateFolderInSpace

Add a new Folder to a Space in ClickUp. This tool allows you to create a new folder within a specified space in ClickUp. Use it when you need to organize tasks or projects into a new folder under an existing space.

Parameters

ParameterTypeReq.Description
folder_namestringRequiredThe name of the new folder to be created in the specified space. It should be a string representing the folder's title.
space_idintegerRequiredThe unique identifier for the ClickUp Space where the folder will be created. It should be an integer.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateFolder'.
#

ClickupApi.CreateListFromFolderTemplate

Create a new list in a folder using a template. Use this tool to create a new list in a ClickUp folder using an existing list template. Ensure the template is added to your Workspace library before invoking this tool. The tool returns the future List ID immediately, though the list creation may continue asynchronously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
folder_identifierstringOptionalThe ID of the folder where the new list will be created using the specified template. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
template_id_for_list_creationstringOptionalID of the template to use for creating a new list in the folder. Ensure the template is added to your Workspace library. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateFolderListFromTemplate'.
#

ClickupApi.CreateListFromTemplate

Create a new list in a ClickUp space using a template. This tool creates a new list within a specified ClickUp space using a provided list template. Publicly shared templates must be added to the Workspace before they can be used. The operation can be performed asynchronously or synchronously based on the 'return_immediately' parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
space_id_for_list_creationstringOptionalID of the ClickUp Space where the new List will be created using the template. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
template_idstringOptionalID of the template to use for creating the list in the specified ClickUp space. It must be accessible in your Workspace. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateSpaceListFromTemplate'.
#

ClickupApi.CreateNewClickupTask

Create a new task in ClickUp. This tool is used to create a new task in a specified list on ClickUp. It should be called when you need to add a task to your ClickUp project management system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
target_list_idintegerOptionalThe ID of the list where the new task will be created. This should be an integer identifying the list in ClickUp. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateTask'.
#

ClickupApi.CreateSpaceInWorkspace

Add a new Space to a Workspace. Use this tool to create a new space within a specified workspace on ClickUp. It should be called when a user wants to organize tasks or projects under a new space in their team environment. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
workspace_idintegerOptionalThe ID of the workspace where the new space will be added. It should be an integer value. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateSpace'.
#

ClickupApi.CreateTaskFromTemplate

Create a task using an existing template. This tool creates a new task in ClickUp using a specified task template from your workspace. Templates must be added to your Workspace before use. Ideal for automating the creation of standardized tasks.

Parameters

ParameterTypeReq.Description
target_list_idintegerRequiredThe ID of the list where the task will be created. This should be an integer associated with the desired list in your workspace.
task_namestringRequiredThe name of the task to be created using the template.
task_template_idstringRequiredA string representing the ID of the task template to be used for task creation. Ensure the template is added to your workspace.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateTaskFromTemplate'.
#

ClickupApi.CreateTeamView

Add various views to a workspace at the Everything Level. This tool allows you to add different types of views such as List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt to a specified workspace within a team. Use this when you need to create or organize views for better workspace management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
workspace_idintegerOptionalThe unique identifier for the workspace where the view will be added. This corresponds to the team or workspace ID. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateTeamView'.
#

ClickupApi.CreateThreadedComment

Create a threaded comment in a ClickUp task. This tool is used to create a threaded comment as a reply to an existing comment in a ClickUp task. It is useful when you want to continue a discussion or provide additional information to a specific comment thread. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
parent_comment_idintegerOptionalThe ID of the parent comment to which the threaded reply will be attached. It should be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateThreadedComment'.
#

ClickupApi.CreateTimeEntry

Create a new time entry for tracking work. Use this tool to log a new time entry for a specific team. If the duration is negative, it indicates that a timer is running for the user. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
team_id_numericintegerOptionalThe numeric ID of the workspace. Required if referencing a task by custom task ID. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
workspace_idintegerOptionalRequired if `custom_task_ids` is true. Provide the Workspace ID for the team. Only used when mode is 'execute'.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task id. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Createatimeentry'.
#

ClickupApi.CreateUserGroup

Create a user group within a ClickUp workspace. Use this tool to organize and manage users by creating a user group within a specific ClickUp workspace. Note that adding a guest with view-only permissions converts them to a paid guest, potentially incurring additional costs.

Parameters

ParameterTypeReq.Description
group_namestringRequiredThe name of the user group to be created within the workspace. This should be a descriptive name to identify the group easily.
user_group_membersarray<integer>RequiredList of user IDs to include in the user group. Each ID should be an integer representing a user within the workspace.
workspace_idintegerRequiredThe unique ID of the ClickUp workspace where the user group will be created.
group_handlestringOptionalA unique string identifier for the user group to be created. This will be used as the group's handle within the workspace.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateUserGroup'.
#

ClickupApi.CreateWorkspaceGoal

Add a new goal to a specified workspace. This tool allows you to create a new goal in a specific workspace by providing the necessary details. Use it to set objectives and track progress within teams.

Parameters

ParameterTypeReq.Description
allow_multiple_ownersbooleanRequiredSet to true to allow a goal to have multiple owners, or false for a single owner.
due_date_timestampintegerRequiredThe due date for the goal as a Unix timestamp in milliseconds. Represents when the goal should be completed.
goal_colorstringRequiredThe color code for the goal. Expected to be a string representing a color, such as a hex code like '#FF5733'.
goal_descriptionstringRequiredA brief explanation of the goal to be added, providing context and details.
goal_namestringRequiredThe name or title of the goal to be added to the workspace.
goal_ownersarray<integer>RequiredArray of user IDs for those assigned to own the goal, allowing multiple owners.
workspace_idintegerRequiredThe ID of the workspace where the goal will be added. This is a numeric value.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateGoal'.
#

ClickupApi.DeleteChecklist

Deletes a checklist from a task in ClickUp. Use this tool to delete a specific checklist from a task in ClickUp by providing the checklist ID. Ideal for when you need to manage or reorganize task checklists.

Parameters

ParameterTypeReq.Description
checklist_idstringRequiredThe unique identifier for the checklist to be deleted. It should be in UUID format.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteChecklist'.
#

ClickupApi.DeleteGoal

Deletes a goal from your workspace in ClickUp. Use this tool to remove a specified goal from your ClickUp workspace by providing the goal ID.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredSpecify the Content-Type header. Typically set to 'application/json'.
goal_identifierstringRequiredThe unique identifier for the goal to be deleted. It must be a valid UUID.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteGoal'.
#

ClickupApi.DeleteGoalTarget

Delete a target from a goal in ClickUp. Use this tool to delete a key result (target) from a goal in ClickUp when a specific target needs to be removed.

Parameters

ParameterTypeReq.Description
goal_target_idstringRequiredThe unique identifier (UUID) of the key result to delete from the goal in ClickUp.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteKeyResult'.
#

ClickupApi.DeleteSpaceTag

Delete a task tag from a space in ClickUp. Use this tool to delete a specific task tag from a designated space in ClickUp. Ideal for cleaning up or reorganizing tags within a space. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
space_identifierintegerOptionalThe unique identifier of the space from which the tag will be deleted. This should be an integer value. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
tag_name_to_deletestringOptionalThe name of the tag to be deleted from the specified space. Ensure this tag name exists in the target space. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteSpaceTag'.
#

ClickupApi.DeleteTask

Delete a task from your ClickUp Workspace. Use this tool to delete a specific task from your ClickUp Workspace by providing the task ID. It should be called when you want to permanently remove a task.

Parameters

ParameterTypeReq.Description
content_typestringRequiredSpecify the media type of the resource. Typically set as 'application/json'.
task_idstringRequiredThe ID of the task to be deleted. This is mandatory and should be a valid task identifier.
use_custom_task_idsbooleanOptionalSet to true if referencing a task by custom task ID is required.
workspace_idintegerOptionalProvide the Workspace ID when referencing a task by its custom task ID. Required if `custom_task_ids` is true.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteTask'.
#

ClickupApi.DeleteTaskChecklistItem

Delete an item from a task checklist in ClickUp. Use this tool to delete a specific line item from a checklist associated with a task. Ideal for managing and updating task checklists by removing unnecessary or completed items.

Parameters

ParameterTypeReq.Description
checklist_identifierstringRequiredThe unique identifier (UUID) for the checklist. Used to specify the checklist from which the item will be deleted.
checklist_item_uuidstringRequiredThe unique identifier (UUID) of the checklist item to be deleted.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteChecklistItem'.
#

ClickupApi.DeleteTaskComment

Delete a comment from a task. Use this tool to delete a specific comment from a task. It should be called when you need to remove a comment based on its unique identifier.

Parameters

ParameterTypeReq.Description
comment_idintegerRequiredThe unique integer identifier of the comment to be deleted.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteComment'.
#

ClickupApi.DeleteTimeEntry

Deletes a time entry from a ClickUp workspace. Use this tool to delete a specific time entry from a ClickUp workspace. This should be called when you need to remove a recorded time entry by specifying the team and timer identifiers.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredSpecify the content type of the request, usually 'application/json'.
timer_ids_to_deleteintegerRequiredComma-separated list of timer IDs to delete.
workspace_idintegerRequiredThe unique identifier for the ClickUp workspace from which you want to delete the time entry.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteatimeEntry'.
#

ClickupApi.DeleteUserGroup

Delete a user group from your ClickUp workspace. This tool removes a user group from your ClickUp workspace based on the provided group ID.

Parameters

ParameterTypeReq.Description
user_group_idstringRequiredThe identifier of the user group to be deleted from the workspace.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteTeam'.
#

ClickupApi.DeleteView

Delete a specified view from ClickUp. Use this tool to delete a specific view in ClickUp by providing the view ID. Useful for managing and organizing views by removing those that are no longer needed.

Parameters

ParameterTypeReq.Description
view_idstringRequiredThe ID of the view to be deleted in ClickUp. Must be provided as a string.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteView'.
#

ClickupApi.DeleteWebhook

Delete a webhook to stop event monitoring. Use this tool to delete a webhook, which will stop monitoring events and locations associated with it. Useful for managing and updating your event tracking preferences.

Parameters

ParameterTypeReq.Description
webhook_idstringRequiredThe unique identifier for the webhook to be deleted. Must be in UUID format.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteWebhook'.
#

ClickupApi.DeleteWorkspaceFolder

Delete a folder from your ClickUp workspace. Use this tool to permanently delete a specific folder from your ClickUp workspace. Ensure you have the correct folder ID before performing this action.

Parameters

ParameterTypeReq.Description
folder_idintegerRequiredThe unique ID of the folder to be deleted from your ClickUp workspace. Ensure this ID is correct to avoid unintended deletions.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteFolder'.
#

ClickupApi.DeleteWorkspaceList

Delete a list from your ClickUp workspace. Use this tool to remove a specific list from your ClickUp workspace when it's no longer needed.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredSpecifies the media type of the request. Typically set to 'application/json'.
workspace_list_idintegerRequiredThe unique integer ID of the list to be deleted from the ClickUp workspace.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteList'.
#

ClickupApi.DeleteWorkspaceSpace

Delete a space from your ClickUp workspace. Use this tool to delete a specific space in your ClickUp workspace by providing the space ID. It permanently removes the space and all associated data.

Parameters

ParameterTypeReq.Description
workspace_space_idintegerRequiredThe unique identifier for the space to delete in your ClickUp workspace. Provide the specific space ID to permanently remove the space and its data.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteSpace'.
#

ClickupApi.EditChecklist

Rename or reorder a task checklist in ClickUp. Use this tool to rename a checklist or change its order within a task in ClickUp. It is suitable when you need to update the checklist name or adjust its position in relation to other checklists in a specific task.

Parameters

ParameterTypeReq.Description
checklist_idstringRequiredThe unique identifier (UUID) of the checklist to be edited or reordered.
checklist_namestringOptionalThe new name for the checklist. Leave empty if you do not wish to rename.
checklist_positionintegerOptionalSpecify the order in which the checklist should appear on a task. Use 0 to place it at the top.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'EditChecklist'.
#

ClickupApi.EditLegacyTimeEntry

Edit a legacy time tracked entry for a task in ClickUp. Use this tool to modify an existing time entry on a specific task using the legacy endpoint in ClickUp. It's recommended to use newer APIs for time tracking, but this can be used for older integrations.

Parameters

ParameterTypeReq.Description
end_time_epochintegerRequiredThe end time of the tracked interval in Unix epoch format. It marks when the time entry should conclude.
legacy_time_interval_idstringRequiredThe unique identifier for the time interval to be edited.
start_timestampintegerRequiredThe start time of the time entry as a Unix timestamp in milliseconds.
task_identifierstringRequiredThe unique identifier of the task for which the legacy time entry is being edited. This is required to specify the task in ClickUp.
time_duration_in_secondsintegerRequiredThe total time duration (in seconds) for the time entry to be updated. This modifies the tracked time for a specific task.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_idintegerOptionalThe Workspace ID required when custom task IDs are used. This must be set if `custom_task_ids` is `true`.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Edittimetracked'.
#

ClickupApi.GetAuthorizedTeams

Retrieve the workspaces for the authenticated user. Use this tool to get a list of workspaces (teams) available to the user who is currently authenticated. It provides an overview of the user's accessible workspaces in ClickUp.

Parameters

No parameters required.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetAuthorizedTeams'.
#

ClickupApi.GetClickupAccessToken

Obtain an OAuth access token for ClickUp API authentication. Use this tool to obtain an OAuth access token for authenticating applications with the ClickUp API. This tool is not for personal API tokens and does not support the 'Try It' feature in browser-based API documentation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetAccessToken'.
#

ClickupApi.GetClickupUserDetails

Get details of the authenticated ClickUp user's account.

Parameters

No parameters required.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetAuthorizedUser'.
#

ClickupApi.GetCurrentRunningTimeEntry

Retrieve the current running time entry for the user. Use this tool to view the time entry that is currently tracking time for the authenticated user. It indicates which timer is actively running. A negative duration suggests an ongoing timer.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredThe MIME type of the content, e.g., 'application/json'. Required for HTTP content negotiation.
workspace_idintegerRequiredThe ID of the workspace to retrieve the running time entry for. It identifies the specific workspace within ClickUp.
assignee_user_idnumberOptionalThe user ID of the time entry assignee for whom the current running timer is being retrieved. This identifies which user's timer is actively running.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Getrunningtimeentry'.
#

ClickupApi.GetFilteredTeamTasks

Retrieve tasks from a workspace based on specified filters. This tool retrieves tasks from a specified workspace that meet certain criteria. The response is limited to 100 tasks per page, and only tasks that the user has access to are returned. The tool is useful for viewing filtered task information from multiple lists, folders, or spaces.

Parameters

ParameterTypeReq.Description
workspace_idintegerRequiredThe ID of the workspace to retrieve tasks from. Must be an integer.
assignee_idsarray<string>OptionalFilter tasks by assignee using their ClickUp user IDs.
custom_task_type_filtersarray<number>OptionalFilter tasks by custom task types. Use `0` for tasks, `1` for Milestones, and other numbers for Workspace-defined types.
display_tasks_in_reverse_orderbooleanOptionalSet to true to display tasks in reverse order.
due_date_beforeintegerOptionalFilter tasks with due dates earlier than the specified Unix timestamp in milliseconds.
due_date_greater_thanintegerOptionalFilter tasks by a due date greater than the specified Unix time in milliseconds.
filter_by_custom_fieldsarray<string>OptionalInclude tasks with specific values in Custom Fields. Provide an array of objects with field_id, operator, and value keys.
filter_by_date_created_beforeintegerOptionalFilter tasks created before this date. Specify as Unix time in milliseconds.
filter_by_date_done_afterintegerOptionalFilter tasks by the completion date after the given Unix time in milliseconds.
filter_by_done_date_beforeintegerOptionalFilter tasks completed before a specific date. Provide the date in Unix time (milliseconds).
filter_by_list_idsarray<string>OptionalAn array of list IDs to filter tasks by. Example: ["1234", "6789"].
filter_by_project_idsarray<string>OptionalAn array of folder IDs to filter tasks by specific folders. For example, ['1234', '6789'].
filter_by_space_idsarray<string>OptionalAn array of space IDs to filter tasks by. Example values: ['1234', '6789'].
filter_by_tagsarray<string>OptionalFilter tasks by tags. Use `%20` for spaces within tags. Example: `urgent%20task`.
filter_by_update_date_beforeintegerOptionalFilter tasks updated before a specific date, provided as Unix time in milliseconds.
filter_by_updated_date_greater_thanintegerOptionalFilter tasks by their updated date, greater than the specified Unix time in milliseconds.
filter_created_date_afterintegerOptionalFilter tasks by creation date greater than the specified Unix time in milliseconds.
include_closed_tasksbooleanOptionalSet to true to include closed tasks, false to exclude them. By default, closed tasks are excluded.
include_markdown_descriptionbooleanOptionalSet to true to return task descriptions in Markdown format. Default is false.
include_subtasksbooleanOptionalSet to true to include subtasks, or false to exclude them. Defaults to false (exclude).
order_tasks_bystringOptionalSpecify the field by which to order tasks. Options include: 'id', 'created', 'updated', 'due_date'. Defaults to 'created'.
page_number_to_fetchintegerOptionalPage number to fetch, starting at 0, in the paginated list of tasks.
parent_task_idstringOptionalInclude the parent task ID to return subtasks in the response.
status_filtersarray<string>OptionalFilter tasks by their statuses. Use '%20' for spaces. Example: ['to%20do', 'in%20progress'].

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetFilteredTeamTasks'.
#

ClickupApi.GetFolderCustomFields

Retrieve accessible custom fields from a folder in ClickUp. This tool retrieves the custom fields that are accessible at the folder level in ClickUp. It's useful when you need to know what folder-level custom fields are available for a specific folder. Custom fields created at the list level aren't included.

Parameters

ParameterTypeReq.Description
content_typestringRequiredThe MIME type of the content being sent. Typically, use 'application/json'.
folder_idintegerRequiredThe unique identifier of the folder to retrieve custom fields from. Must be an integer corresponding to a specific folder in ClickUp.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'getFolderAvailableFields'.
#

ClickupApi.GetFolderlessLists

View Lists in a Space not located in a Folder. Use this tool to retrieve lists within a specified space that are not contained within any folder, providing an organized view of unassigned lists.

Parameters

ParameterTypeReq.Description
space_identifierintegerRequiredThe unique identifier of the space to retrieve the folderless lists from. It should be an integer.
include_archived_listsbooleanOptionalSpecify true to include archived lists, or false to exclude them.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetFolderlessLists'.
#

ClickupApi.GetFolderViews

Retrieve available task and page views for a Folder in ClickUp.

Parameters

ParameterTypeReq.Description
folder_idintegerRequiredThe ID of the folder to retrieve views for. This should be an integer value.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetFolderViews'.
#

ClickupApi.GetGoalDetails

Retrieve detailed information about a specific goal including its targets.

Parameters

ParameterTypeReq.Description
goal_identifierstringRequiredThe unique identifier (UUID) for the goal to retrieve details and targets.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetGoal'.
#

ClickupApi.GetGuestInformation

Retrieve information about a guest in a workspace. This tool is used to view details about a guest in a ClickUp workspace. It is available only for Workspaces on the Enterprise Plan. Use it when you need to obtain guest-related information, such as profile or access details.

Parameters

ParameterTypeReq.Description
guest_identifierintegerRequiredAn integer representing the unique ID of the guest whose information is to be retrieved.
workspace_idintegerRequiredThe ID of the ClickUp workspace. This is required for identifying the specific workspace where the guest information is being retrieved.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetGuest'.
#

ClickupApi.GetListComments

View comments from a specific ClickUp list. Use this tool to retrieve the most recent comments from a specified ClickUp list. It returns up to 25 comments by default. To fetch older comments, utilize the optional parameters `start` and `start_id`.

Parameters

ParameterTypeReq.Description
list_idintegerRequiredThe unique integer identifier of the ClickUp list for which comments are being retrieved.
oldest_comment_idstringOptionalID of the oldest comment to start retrieving additional comments from.
start_date_unix_millisintegerOptionalEnter the date of a list info comment using Unix time in milliseconds to retrieve comments starting from this timestamp.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetListComments'.
#

ClickupApi.GetListMembers

Retrieve members with access to a specific list in ClickUp. Use this tool to get the members of a ClickUp workspace who have access to a specified list. It helps in managing and viewing user access to project resources.

Parameters

ParameterTypeReq.Description
list_idintegerRequiredThe unique identifier for the list in ClickUp. It is required to fetch the members with access to this list.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetListMembers'.
#

ClickupApi.GetListTasks

Retrieve tasks from a specific list in ClickUp. This tool retrieves tasks from a specified list in ClickUp, limited to 100 tasks per page. It includes tasks where the specified list is their home, while also allowing inclusion of tasks from multiple lists by using the `include_timl` parameter. It provides details accessible to the user, including time spent on tasks with time entries.

Parameters

ParameterTypeReq.Description
list_identifierintegerRequiredThe unique identifier for the list. Find it by copying the link and extracting the number following /li in the URL.
custom_task_type_filtersarray<number>OptionalAn array of numbers to filter tasks by custom types. Use 0 for tasks, 1 for Milestones, and other numbers for custom types defined in your Workspace.
date_created_less_thanintegerOptionalFilter tasks created before the specified Unix timestamp in milliseconds.
display_tasks_in_reverse_orderbooleanOptionalSet to true to display tasks in reverse order.
filter_by_assigneesarray<string>OptionalFilter tasks by assignee IDs. Provide an array of assignee IDs to filter tasks assigned to specific users.
filter_by_custom_fieldarray<string>OptionalInclude tasks with specific values in one Custom Field. This can be a Custom Relationship. Provide an array of strings representing the field values.
filter_by_custom_fieldsarray<string>OptionalInclude tasks with specific values in one or more Custom Fields. Use a JSON array of objects, where each object includes 'field_id', 'operator', and 'value'.
filter_by_date_done_beforeintegerOptionalFilter tasks completed before a specified Unix time in milliseconds.
filter_by_statusesarray<string>OptionalFilter tasks by their statuses. Use an array of status strings, such as ['to do', 'in progress'].
filter_by_tagsarray<string>OptionalFilter tasks by a list of tags. Provide an array of strings representing the tags to filter by.
filter_by_watchersarray<string>OptionalAn array of watcher IDs to filter tasks by watchers. Each ID should be a string.
filter_date_created_afterintegerOptionalFilter tasks created after this Unix timestamp in milliseconds.
filter_date_done_afterintegerOptionalFilter tasks completed after a specified date in Unix time (milliseconds).
filter_date_updated_afterintegerOptionalFilter tasks updated after the specified Unix timestamp in milliseconds.
filter_date_updated_less_thanintegerOptionalFilter tasks updated before a specific date, using Unix time in milliseconds.
filter_due_date_beforeintegerOptionalFilter tasks with due dates earlier than the specified Unix time in milliseconds.
filter_due_date_greater_thanintegerOptionalFilter tasks by a due date greater than the provided Unix time in milliseconds.
include_archived_tasksbooleanOptionalSet to true to include archived tasks in the results. By default, archived tasks are excluded.
include_closed_tasksbooleanOptionalSet to true to include closed tasks in the response. Defaults to false to exclude them.
include_markdown_task_descriptionsbooleanOptionalSet to true to return task descriptions in Markdown format.
include_subtasksbooleanOptionalSet to true to include subtasks; false to exclude them. Defaults to false.
include_tasks_in_multiple_listsbooleanOptionalSet to true to include tasks that exist in multiple lists. By default, these tasks are excluded.
order_by_fieldstringOptionalSpecify the field to order tasks by. Options: 'id', 'created', 'updated', 'due_date'. Defaults to 'created'.
page_number_to_fetchintegerOptionalSpecify the page number to fetch tasks from, starting at 0.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetTasks'.
#

ClickupApi.GetListViews

Retrieve available views for a specific list. Use this tool to view the task and page views available for a specific list in ClickUp. It retrieves both regular and required views.

Parameters

ParameterTypeReq.Description
target_list_idintegerRequiredThe unique identifier for the list to retrieve views from. This should be an integer.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetListViews'.
#

ClickupApi.GetSpaceCustomFields

Retrieve custom fields accessible in a specific ClickUp space. This tool retrieves the custom fields available to you in a specified ClickUp space. It returns only the custom fields created at the space level, excluding those at the folder and list levels.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredThe MIME type for the request header, typically 'application/json'.
space_identifierintegerRequiredThe unique identifier for the ClickUp space from which to fetch available custom fields. It should be an integer.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'getSpaceAvailableFields'.
#

ClickupApi.GetSpaceFolders

Retrieve a list of folders from a specified space. Use this tool to view folders within a specific space in ClickUp. It is useful when you need to access or manage the folders in a particular workspace.

Parameters

ParameterTypeReq.Description
space_idintegerRequiredThe unique identifier of the space from which to retrieve folders. This is required to specify which space's folders are being requested.
include_archived_foldersbooleanOptionalSet to true to include archived folders in the results.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetFolders'.
#

ClickupApi.GetSpaceTags

Retrieve task tags for a specified space. Use this tool to view the task tags available within a specific space. It helps in identifying and managing tags associated with tasks.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredThe MIME type of the request. Generally set to 'application/json'.
space_identifierintegerRequiredAn integer representing the ID of the space for which to retrieve task tags. This ID is required to specify the space.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetSpaceTags'.
#

ClickupApi.GetSpaceViews

Retrieve the task and page views for a specified Space. This tool is used to obtain the task and page views available within a specific Space in ClickUp. It should be called when you need to explore or list the views associated with a given space by providing the space ID.

Parameters

ParameterTypeReq.Description
space_identifierintegerRequiredThe unique integer ID of the space for which to retrieve task and page views.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetSpaceViews'.
#

ClickupApi.GetTaskComments

Retrieve comments from a specified task in ClickUp. Use this tool to view comments on a specific task within ClickUp. If no 'start' and 'start_id' parameters are provided, it will return the latest 25 comments. Provide 'start' and 'start_id' to paginate through older comments.

Parameters

ParameterTypeReq.Description
task_identifierstringRequiredSpecify the unique identifier of the task whose comments you want to retrieve.
comment_date_unix_time_msintegerOptionalSpecify the date of a task comment using Unix time in milliseconds for pagination.
comment_start_idstringOptionalThe ID of the earliest comment to start retrieving from, used for pagination.
use_custom_task_idsbooleanOptionalSet to `true` if you want to reference a task by its custom task ID.
workspace_id_for_custom_taskintegerOptionalProvide the Workspace ID when using a custom task ID (requires `custom_task_ids` to be true).

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetTaskComments'.
#

ClickupApi.GetTaskMembers

Retrieve members with direct access to a task. Use this tool to view the people who have direct access to a specific task in ClickUp. It does not include members with inherited permissions through the hierarchy.

Parameters

ParameterTypeReq.Description
task_identifierstringRequiredThe unique identifier of the task to retrieve members for. This ID is necessary to specify the task in question.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetTaskMembers'.
#

ClickupApi.GetTaskTimeInStatus

Retrieve duration of tasks in various statuses. Use this tool to find out how long multiple tasks have remained in each status. The Total Time in Status ClickApp must be enabled by the Workspace owner or an admin.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredThe MIME type of the body of the request. Typically set to 'application/json'.
task_ids_liststringRequiredA list of up to 100 task IDs to check duration in status. Include each task ID separated by commas.
use_custom_task_idsbooleanOptionalSet to true to reference tasks by custom task IDs.
workspace_id_for_custom_task_idsintegerOptionalProvide the Workspace ID if using custom task IDs. Required when `custom_task_ids` is `true`.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetBulkTasks'TimeinStatus'.
#

ClickupApi.GetTeamViews

Retrieve task and page views at the workspace level. Use this tool to view the task and page views available at the Everything Level of a specified workspace in ClickUp.

Parameters

ParameterTypeReq.Description
workspace_idintegerRequiredThe ID of the workspace to retrieve task and page views from in ClickUp.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetTeamViews'.
#

ClickupApi.GetTimeEntriesInDateRange

Retrieve time entries within a specified date range. Use this tool to view time entries filtered by start and end dates. By default, it returns entries from the last 30 days for the authenticated user. To access entries for other users, use the 'assignee' parameter. You may apply location filters with 'space_id', 'folder_id', 'list_id', or 'task_id', but only one at a time. Note: Negative duration entries indicate a running timer.

Parameters

ParameterTypeReq.Description
content_typestringRequiredSpecifies the format of the response content. Usually set to 'application/json'.
workspace_idintegerRequiredSpecify the Workspace ID for filtering time entries when using custom task IDs.
end_date_unix_millisecondsnumberOptionalSpecify the end date in Unix time (milliseconds) to filter time entries up to this point.
filter_by_assigneenumberOptionalFilter by user IDs. Use commas to separate multiple IDs (e.g., '1234,9876'). Only accessible to Workspace Owners/Admins.
folder_idintegerOptionalInclude time entries for tasks in a specific folder by providing its ID. Only one location filter (space, folder, list, or task) can be used at a time.
include_approval_detailsbooleanOptionalInclude detailed approval information for each time entry, such as Approver ID, Approved Time, List of Approvers, and Approval Status.
include_approval_historybooleanOptionalSet to true to include the approval history for each time entry, with status changes, notes, and approvers.
include_location_namesbooleanOptionalInclude the names of the List, Folder, and Space in the response along with their IDs when set to true.
include_only_billable_entriesbooleanOptionalSet to `true` to include only billable time entries, or `false` for non-billable entries.
include_task_tagsbooleanOptionalSet to true to include task tags in the response for associated time entries.
space_idintegerOptionalInclude time entries associated only with tasks in the specified Space using its ID.
specific_list_idintegerOptionalInclude only time entries associated with tasks in a specified List by providing the List ID.
specific_task_idstringOptionalInclude only time entries associated with the specified task.
start_date_in_unix_millisecondsnumberOptionalThe start date of the time entries in Unix time (milliseconds).
use_custom_task_idsbooleanOptionalSet to true to reference tasks by their custom task IDs. Requires specifying the team_id.
workspace_id_for_custom_task_idsintegerOptionalProvide the Workspace ID when referencing a task by its custom task ID, and `custom_task_ids` is set to true.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Gettimeentrieswithinadaterange'.
#

ClickupApi.GetTimeEntryTags

Retrieve all tags from time entries in a workspace. Use this tool to view all labels that have been applied to time entries within a specified workspace.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredThe media type of the resource, usually set to 'application/json'.
workspace_idintegerRequiredThe unique ID of the workspace to retrieve tags from.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Getalltagsfromtimeentries'.
#

ClickupApi.GetTrackedTimeForTask

Fetch tracked time for a specific task. Use this tool to get the tracked time recorded for a specific task in ClickUp. It's useful for retrieving time spent details on tasks, though it doesn't handle new time entries.

Parameters

ParameterTypeReq.Description
set_content_type_headerstringRequiredSet the Content-Type header for the request, typically as 'application/json'.
task_idstringRequiredThe unique identifier for the task whose tracked time you want to retrieve.
use_custom_task_idsbooleanOptionalSet to true to reference tasks by their custom task IDs instead of default IDs.
workspace_idintegerOptionalThe ID of the Workspace to be provided when referencing a task by its custom task ID. Required if `custom_task_ids` is `true`.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Gettrackedtime'.
#

ClickupApi.GetUserGroupsInWorkspace

Retrieve user groups in a ClickUp workspace. Use this tool to view the user groups within a specific ClickUp workspace. It's useful for managing and organizing user permissions and roles within a team environment.

Parameters

ParameterTypeReq.Description
workspace_idintegerRequiredThe ID of the ClickUp workspace to retrieve user groups from.
user_group_idsstringOptionalList one or more User Group IDs to retrieve details about specific user groups in the workspace.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetTeams1'.
#

ClickupApi.GetVisibleTasksInView

Retrieve all visible tasks from a ClickUp view. Use this tool to obtain a list of all tasks that are visible in a specific view within ClickUp. It is useful for task management and organization within the platform.

Parameters

ParameterTypeReq.Description
pagination_page_numberintegerRequiredThe specific page number of tasks to retrieve. Used for pagination in task lists, starting at 1.
view_identifierstringRequiredThe ID of the ClickUp view from which to retrieve visible tasks. Must be a string.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetViewTasks'.
#

ClickupApi.GetWorkspaceCustomRoles

Retrieve custom roles from a specific workspace. This tool is used to retrieve the custom roles available in a specified workspace on ClickUp. It should be called when you need to view or manage roles in a ClickUp workspace.

Parameters

ParameterTypeReq.Description
workspace_idintegerRequiredThe unique identifier for the workspace to retrieve custom roles from.
include_membersbooleanOptionalInclude member details in the response. Set to true to include, false to exclude.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetCustomRoles'.
#

ClickupApi.GetWorkspaceCustomTaskTypes

Retrieve custom task types for a specific workspace. Use this tool to view the custom task types available in a specified workspace. Ideal for gaining insight into workspace-specific configurations and custom workflows.

Parameters

ParameterTypeReq.Description
workspace_idintegerRequiredThe ID of the Workspace to retrieve custom task types for.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetCustomItems'.
#

ClickupApi.GetWorkspacePlan

Retrieve the current subscription plan for a workspace. Use this tool to get details about the current subscription plan for a specified workspace in ClickUp. It should be called when you need to view the plan or pricing details associated with a workspace.

Parameters

ParameterTypeReq.Description
workspace_idstringRequiredThe unique ID for the workspace whose subscription plan you want to retrieve.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetWorkspaceplan'.
#

ClickupApi.GetWorkspaceSeatDetails

Retrieve seat details for a workspace. Use this tool to view the used, total, and available member and guest seats for a specified workspace in ClickUp.

Parameters

ParameterTypeReq.Description
workspace_idstringRequiredThe unique ID of the workspace for which seat details are to be retrieved.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetWorkspaceseats'.
#

ClickupApi.GetWorkspaceSpaces

Retrieve available Spaces in a Workspace. Use this tool to get information about the Spaces available in a specific Workspace identified by its space ID.

Parameters

ParameterTypeReq.Description
workspace_space_idintegerRequiredThe unique identifier for the specific space in the workspace to retrieve details.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetSpace'.
#

ClickupApi.GetWorkspaceUserInfo

Retrieve user information from a specified workspace. Call this tool to get details about a user from a specific workspace on the ClickUp platform. This tool is applicable only to Workspaces that are on the Enterprise Plan.

Parameters

ParameterTypeReq.Description
user_idintegerRequiredThe unique identifier of the user to retrieve information for. This is required to specify which user's information is being accessed in the workspace.
workspace_idintegerRequiredThe unique ID of the Workspace. Used to specify which Workspace's user information is to be retrieved.
show_shared_itemsbooleanOptionalSet to `true` to include details of shared items; `false` excludes them by default.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetUser'.
#

ClickupApi.GetWorkspaceWebhooks

Retrieve webhooks for a workspace. Use this tool to view the webhooks created via the API for a specific Workspace. It returns webhooks created by the authenticated user.

Parameters

ParameterTypeReq.Description
workspace_idintegerRequiredThe ID of the Workspace to retrieve the webhooks for.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetWebhooks'.
#

ClickupApi.InviteGuestToWorkspace

Invite a guest to join a ClickUp workspace. This tool is used to invite a guest to a ClickUp workspace on an Enterprise Plan. Ensure the guest has access to specific items in the workspace using additional endpoints.

Parameters

ParameterTypeReq.Description
guest_emailstringRequiredThe email address of the guest to be invited to the workspace. Ensure it is correctly formatted.
workspace_idintegerRequiredThe integer ID of the Workspace to which the guest will be invited.
allow_guest_to_create_viewsbooleanOptionalIndicates if the guest can create views in the workspace. Accepts a boolean value.
allow_tag_editingbooleanOptionalSet to true if the guest should be allowed to edit tags in the workspace.
allow_view_time_spentbooleanOptionalAllow the guest to view time spent in the workspace. Accepts a boolean value: true to allow, false to deny.
can_view_estimated_timesbooleanOptionalSet to true to allow the guest to view estimated times for tasks.
can_view_points_estimatedbooleanOptionalSet to true to allow the guest to view estimated points for tasks.
custom_role_idintegerOptionalThe ID of the custom role to assign to the guest. Must be an integer value.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'InviteGuestToWorkspace'.
#

ClickupApi.InviteUserToWorkspace

Invite a user to your ClickUp Workspace as a member. Use this tool to invite someone to your ClickUp Workspace as a member. This is suitable for Workspaces on the Enterprise Plan. For inviting guests, use the appropriate tool instead.

Parameters

ParameterTypeReq.Description
invite_as_adminbooleanRequiredIndicate if the user should be invited as an admin. True for admin, False for regular member.
user_emailstringRequiredThe email address of the user to be invited to the Workspace. Must be a valid email format.
workspace_idintegerRequiredThe unique ID of the workspace to which the user is being invited.
custom_role_idintegerOptionalThe ID of the custom role to assign to the user in the Workspace. Must be an integer.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'InviteUserToWorkspace'.
#

ClickupApi.LinkTasksClickup

Link two ClickUp tasks together. This tool allows you to link two tasks in ClickUp via the Task Links feature in the right-hand sidebar of a task. It should be called when you need to associate tasks directly, but does not support linking to other types of objects.

Parameters

ParameterTypeReq.Description
source_task_idstringRequiredThe ID of the task from which the link will be initiated.
task_to_link_tostringRequiredThe ID of the task to link to the initiating task.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_id_for_custom_taskintegerOptionalProvide the Workspace ID if referencing a task by custom task id (when custom_task_ids is true).

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'AddTaskLink'.
#

ClickupApi.MergeTasksInClickup

Merge multiple tasks into a target task in ClickUp. Use this tool to merge several tasks into a specified target task within ClickUp. The target task is identified by the task_id, with source tasks provided in the request. This is useful when consolidating tasks for better project management.

Parameters

ParameterTypeReq.Description
source_task_ids_to_mergearray<string>RequiredArray of task IDs to merge into the target task in ClickUp.
target_task_idstringRequiredID of the target task into which other tasks will be merged.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'mergeTasks'.
#

ClickupApi.RemoveCustomFieldValue

Remove a custom field value from a ClickUp task. Use this tool to remove the data from a custom field on a ClickUp task without deleting the field option itself.

Parameters

ParameterTypeReq.Description
custom_field_idstringRequiredUUID of the custom field to be removed from the task. Example: b8a8-48d8-a0c6-b4200788a683
task_identifierstringRequiredThe unique identifier of the task from which you want to remove the custom field value.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_idintegerOptionalProvide the Workspace ID when referencing a task by custom task id.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'RemoveCustomFieldValue'.
#

ClickupApi.RemoveGuestFromFolder

Revoke a guest's access to a specified folder. Use this tool to remove a guest's access to a specific folder in ClickUp workspaces on the Enterprise Plan.

Parameters

ParameterTypeReq.Description
folder_identifierintegerRequiredThe unique identifier for the folder from which the guest's access should be revoked. This ID is essential to specify the exact folder within the ClickUp workspace.
guest_identifierintegerRequiredThe unique numeric ID of the guest to be removed from the folder. This is required to identify which guest's access is being revoked.
include_shared_itemsbooleanOptionalSet to true to include details of items shared with the guest. Defaults to true.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'RemoveGuestFromFolder'.
#

ClickupApi.RemoveGuestFromList

Revoke a guest's access to a specific list in ClickUp. This tool removes a guest's access from a specified list within ClickUp. It is available only for Workspaces on the Enterprise Plan.

Parameters

ParameterTypeReq.Description
guest_user_idintegerRequiredThe unique identifier of the guest whose access is to be revoked from the list.
list_identifierintegerRequiredThe unique identifier for the list from which the guest's access will be revoked. This must be an integer.
include_shared_detailsbooleanOptionalSet to `true` to include details of items shared with the guest. Default is `true`.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'RemoveGuestFromList'.
#

ClickupApi.RemoveGuestFromTask

Revoke a guest's access to a specific task in ClickUp. Use this tool to remove a guest from a task in ClickUp. This action is available only for Workspaces on the Enterprise Plan.

Parameters

ParameterTypeReq.Description
guest_idintegerRequiredThe ID of the guest to remove from the task. This is a required integer value.
task_idstringRequiredThe unique identifier of the task from which the guest's access should be revoked. This is required to specify the task.
include_shared_detailsbooleanOptionalSet to `true` to include details of items shared with the guest. Default is `true`.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_id_for_custom_taskintegerOptionalProvide the Workspace ID when referencing a task by its custom task ID. This is required if 'custom_task_ids' is set to 'true'.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'RemoveGuestFromTask'.
#

ClickupApi.RemoveGuestFromWorkspace

Revoke a guest's access to a ClickUp workspace. Remove a guest from a ClickUp workspace. Available only for Workspaces on the Enterprise Plan.

Parameters

ParameterTypeReq.Description
guest_idintegerRequiredThe unique identifier for the guest to be removed from the workspace. This should be an integer value.
workspace_idintegerRequiredThe unique ID of the ClickUp workspace from which the guest will be removed. This is an integer.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'RemoveGuestFromWorkspace'.
#

ClickupApi.RemoveTagFromTask

Remove a tag from a specific task in ClickUp. Use this tool to remove a specified tag from a task in ClickUp without deleting the tag from the space.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredSpecifies the media type of the request. Commonly set to 'application/json'.
tag_name_to_removestringRequiredThe name of the tag to remove from the specified task.
task_idstringRequiredThe unique identifier of the task from which the tag will be removed. Use the task's regular ID unless custom task IDs are enabled.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID, or false to use the standard ID.
workspace_id_for_custom_taskintegerOptionalThe Workspace ID required when referencing a task by its custom ID (if custom_task_ids is true).

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'RemoveTagFromTask'.
#

ClickupApi.RemoveTagsFromTimeEntries

Remove labels from specific time entries. Use this tool to remove labels from time entries without affecting the labels in the Workspace. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
workspace_idintegerOptionalThe unique ID of the Workspace from which to remove labels from time entries. Must be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Removetagsfromtimeentries'.
#

ClickupApi.RemoveTaskDependency

Remove a dependency relationship between tasks. This tool is used to remove the dependency relationship between two or more tasks in ClickUp. Call this when two tasks that are currently dependent on one another need to be independent.

Parameters

ParameterTypeReq.Description
dependent_task_idstringRequiredThe task ID that is dependent on another. Provide a valid task ID as a string.
depends_on_task_idstringRequiredThe ID of the task that another task depends on. Provide a valid task ID to specify the dependent task.
task_id_to_remove_dependencystringRequiredSpecify the task ID from which the dependency is to be removed. This is required to identify the task involved in the dependency relationship.
use_custom_task_idsbooleanOptionalSet to true if referencing tasks by their custom task IDs is desired.
workspace_idintegerOptionalProvide the Workspace ID when using custom task IDs by setting `custom_task_ids` to `true`.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'DeleteDependency'.
#

ClickupApi.RemoveTaskFromAdditionalList

Remove a task from an additional list in ClickUp. Use this tool to remove a task from an additional list, not the task's home list. Requires the 'Tasks in Multiple Lists' feature to be enabled in ClickUp.

Parameters

ParameterTypeReq.Description
additional_list_idintegerRequiredThe ID of the additional list from which the task should be removed. This is required for identifying the secondary list, not the task's home list.
task_identifierstringRequiredThe unique identifier for the task to be removed from the additional list.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'RemoveTaskFromList'.
#

ClickupApi.RemoveTimeEntry

Delete a specific time entry from a task. Use this tool to delete a specific time tracking entry from a task. It's useful for managing or correcting time logs by removing unwanted entries.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredSpecify the media type of the resource (usually 'application/json').
interval_id_for_removalstringRequiredThe unique identifier of the time entry to delete from a task.
task_identifierstringRequiredThe identifier of the task from which to delete the time entry. This must match the task ID used in ClickUp.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_idintegerOptionalProvide the Workspace ID when `use_custom_task_ids` is `true`. Required to identify the workspace in ClickUp.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Deletetimetracked'.
#

ClickupApi.RemoveUserFromWorkspace

Remove a user from a ClickUp workspace. Use this tool to deactivate a user from a ClickUp workspace, applicable for Workspaces on the Enterprise Plan.

Parameters

ParameterTypeReq.Description
user_idintegerRequiredThe ID of the user to be deactivated from the workspace.
workspace_idintegerRequiredThe ID of the Workspace in ClickUp from which the user will be removed.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'RemoveUserFromWorkspace'.
#

ClickupApi.RenameClickupFolder

Rename a folder in ClickUp. Use this tool to update the name of a folder in ClickUp by specifying the folder ID and the new name.

Parameters

ParameterTypeReq.Description
folder_id_clickupintegerRequiredThe unique identifier for the ClickUp folder you wish to rename.
new_folder_namestringRequiredSpecify the new name for the folder. This is the name that the folder will be renamed to in ClickUp.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'UpdateFolder'.
#

ClickupApi.RenameTimeEntryLabel

Rename a time entry label in ClickUp. Use this tool to change the name of a label associated with time entries for a specific team in ClickUp.

Parameters

ParameterTypeReq.Description
current_label_namestringRequiredThe current name of the time entry label that needs to be renamed.
foreground_color_for_tagstringRequiredSpecify the hexadecimal foreground color for the tag (e.g., '#FFFFFF').
label_background_colorstringRequiredHex code for the new background color of the label (e.g., '#FFFFFF').
new_label_namestringRequiredThe new name for the time entry label to be applied in ClickUp.
workspace_idintegerRequiredThe ID of the workspace where the label is located. This is required to specify the team in ClickUp whose label you want to rename.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Changetagnamesfromtimeentries'.
#

ClickupApi.RetrieveAvailableSpaces

View available Spaces in a Workspace. The tool retrieves the Spaces within a specified Workspace, providing member info for private Spaces if applicable.

Parameters

ParameterTypeReq.Description
workspace_idintegerRequiredThe ID of the workspace to retrieve available spaces from.
include_archived_spacesbooleanOptionalSet to true to include archived Spaces in the results. Otherwise, only active Spaces are returned.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetSpaces'.
#

ClickupApi.SetTaskDependency

Set a task as waiting on or blocking another task. Use this tool to establish a dependency between tasks in ClickUp, either setting a task as waiting on another or as blocking one.

Parameters

ParameterTypeReq.Description
task_id_of_dependencystringRequiredThe ID of the task that is waiting on or blocking another task.
dependent_task_idstringOptionalThe ID of the task that the specified task depends on or is blocking. This establishes the task dependency relationship.
depends_on_task_idstringOptionalSpecify the task ID that this task depends on or is blocked by. It should be a valid task ID in ClickUp.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_idintegerOptionalProvide the Workspace ID when `custom_task_ids` is true. Necessary for task identification.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'AddDependency'.
#

ClickupApi.SetupClickupWebhook

Set up a ClickUp webhook to monitor events. Use this tool to create a webhook in ClickUp, enabling monitoring of events for a specific team. Useful for triggering actions or notifications based on certain events within a ClickUp team.

Parameters

ParameterTypeReq.Description
event_typesarray<string>RequiredAn array of event types to subscribe to, or use `*` to subscribe to all events. Refer to ClickUp documentation for available options.
webhook_urlstringRequiredThe URL where the webhook will send POST requests. Must be reachable to receive event data.
workspace_idintegerRequiredThe ID of the workspace where the webhook will be set up. Use this to specify the team context for monitoring.
folder_idintegerOptionalSpecify the folder ID in ClickUp for which the webhook is to be created. It should be an integer value representing the folder.
space_identifierintegerOptionalThe numeric ID of the space within a ClickUp workspace for which the webhook is set up.
specific_task_idstringOptionalUnique identifier for a specific task to monitor. Leave empty if not targeting a specific task.
target_list_idintegerOptionalThe ID of the list in ClickUp for which you want to set up a webhook.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'CreateWebhook'.
#

ClickupApi.ShareTaskWithGuest

Share a task with a guest in the ClickUp Workspace. This tool shares a specified task with a guest, available only on ClickUp's Enterprise Plan.

Parameters

ParameterTypeReq.Description
guest_idintegerRequiredThe unique identifier for the guest to share the task with.
guest_permission_levelstringRequiredDefines the level of access for the guest. Options: 'read', 'comment', 'edit', 'create'.
task_idstringRequiredThe unique identifier for the task to share with the guest.
include_shared_detailsbooleanOptionalSet to `true` to include details of items shared with the guest. Defaults to `true`.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_id_when_custom_task_ids_enabledintegerOptionalProvide the Workspace ID when referencing tasks by custom task IDs. Required if `custom_task_ids` is `true`.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'AddGuestToTask'.
#

ClickupApi.StartTimerClickup

Start a timer for the authenticated ClickUp user. Use this tool to initiate a timer for the authenticated user in ClickUp. It is ideal for tracking time on specific tasks or projects. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
workspace_identifierintegerOptionalThe Workspace ID required when custom task IDs are used. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
workspace_idintegerOptionalProvide the Workspace ID when `custom_task_ids` is `true`. Required for task referencing. Only used when mode is 'execute'.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'StartatimeEntry'.
#

ClickupApi.StopTimerEntry

Stops a running timer for the authenticated user. Use this tool to stop a currently running timer for the authenticated user on ClickUp. This action is initiated for a specific team, requiring the team ID.

Parameters

ParameterTypeReq.Description
content_typestringRequiredSpecifies the media type of the request. Usually 'application/json'.
workspace_idintegerRequiredThe ID of the workspace where the timer is running. Required to stop the timer.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'StopatimeEntry'.
#

ClickupApi.TaskStatusDuration

Get the duration a task spends in each status. Use this tool to find out how long a task has been in each status. Ensure that the 'Total time in Status' ClickApp is enabled by the Workspace owner or admin before using this tool.

Parameters

ParameterTypeReq.Description
content_typestringRequiredSpecify the content type for the API request, typically 'application/json'.
task_identifierstringRequiredThe unique identifier for the task you want to query. Use this to specify which task's status duration you are interested in.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_idintegerOptionalThe Workspace ID must be provided when referencing a task by its custom task ID and `custom_task_ids` is set to `true`.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetTask'sTimeinStatus'.
#

ClickupApi.UpdateChecklistItem

Modify or update a specific task checklist item. This tool updates an individual line item in a task checklist. It can rename the item, set the assignee, mark it as resolved, or nest it under another item.

Parameters

ParameterTypeReq.Description
checklist_item_uuidstringRequiredThe UUID for the specific checklist item to be updated.
checklist_unique_identifierstringRequiredThe UUID of the checklist to update. Example: b8a8-48d8-a0c6-b4200788a683.
assign_item_to_userstringOptionalThe user ID to which the checklist item will be assigned. This should be a string representing a valid user identifier in ClickUp.
checklist_item_namestringOptionalThe new name for the checklist item. Provide a string to rename the item.
mark_as_resolvedbooleanOptionalBoolean to mark the checklist item as resolved (true) or unresolved (false).
parent_checklist_item_idstringOptionalInclude another item's `checklist_item_id` to nest this item under it.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'EditChecklistItem'.
#

ClickupApi.UpdateClickupList

Update the details of a ClickUp list. Use this tool to rename a ClickUp list, update its description, set a due date or time, change the priority, assign someone, or modify the list color.

Parameters

ParameterTypeReq.Description
list_identifierstringRequiredThe unique identifier of the ClickUp list to update. This is a required string field.
list_namestringRequiredThe new name for the ClickUp list. This should be a string value.
formatted_list_descriptionstringOptionalFormatted description of the list using Markdown syntax instead of plain text.
include_due_date_timebooleanOptionalSet to true to include a specific time with the due date.
list_assignee_idstringOptionalThe ID of the user to assign to the list. Provide a valid user ID string.
list_colorstringOptionalSpecify the color of the list. This refers to the List color rather than task statuses.
list_description_contentstringOptionalThe plain text description to update for the ClickUp list. Use this instead of markdown for simple text updates.
list_due_dateintegerOptionalSet the list's due date as a Unix timestamp in milliseconds, representing the time the list is due.
list_priorityintegerOptionalSet the list's priority as an integer. Usually, 1 is high, 2 is medium, and 3 is low priority.
remove_list_colorbooleanOptionalSet to `true` to remove the List color; default is `false`.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'UpdateList'.
#

ClickupApi.UpdateClickupSpace

Update space attributes in ClickUp. Use this tool to rename a ClickUp space, change its color, and enable or disable ClickApps for it. Call this when you need to modify the settings of an existing space. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
space_identifierintegerOptionalThe unique identifier for the ClickUp space to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'UpdateSpace'.
#

ClickupApi.UpdateClickupWebhookEvents

Update a ClickUp webhook to modify monitored events. Use this tool to update the events a ClickUp webhook monitors, allowing for changes to event tracking as needed.

Parameters

ParameterTypeReq.Description
monitored_eventsstringRequiredA comma-separated list of events for the webhook to monitor. Use valid event names as per ClickUp webhook documentation.
webhook_endpoint_urlstringRequiredThe URL where the webhook should send POST requests for the events. Must be a valid and accessible URL.
webhook_identifierstringRequiredThe unique identifier for the webhook to be updated, formatted as a UUID.
webhook_statusstringRequiredSpecify the new status of the webhook. Use 'active' to enable or 'inactive' to disable it.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'UpdateWebhook'.
#

ClickupApi.UpdateGoalDetails

Update goal details such as name, due date, and owners. Use this tool to rename a goal, set its due date, update its description, manage owners, or change its color in ClickUp.

Parameters

ParameterTypeReq.Description
goal_colorstringRequiredSet the color of the goal. Accepts a string representing the color, such as a hex code.
goal_descriptionstringRequiredThe new description for the goal. This should provide an overview or details of the goal's purpose.
goal_due_dateintegerRequiredAn integer representing the new due date for the goal, usually in Unix timestamp format.
goal_idstringRequiredThe unique identifier for the goal to be updated. This is a UUID.
goal_namestringRequiredThe new name for the goal. This will replace the current goal name.
new_owners_to_addarray<integer>RequiredList of user IDs to add as new owners for the goal.
remove_owners_user_idsarray<integer>RequiredArray of user IDs to be removed as owners of the goal.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'UpdateGoal'.
#

ClickupApi.UpdateKeyResultTarget

Update the target of a specific key result. Use this tool to update the target value of a specified key result. It should be called when there's a need to modify the target associated with a key result in ClickUp.

Parameters

ParameterTypeReq.Description
current_steps_valueintegerRequiredThe current number of steps completed for the key result target. Provide an integer value.
key_result_identifierstringRequiredUnique identifier for the key result to be updated, provided as a UUID.
note_update_descriptionstringRequiredText for the note associated with the key result. Use to add or update content related to the key result.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'EditKeyResult'.
#

ClickupApi.UpdateTaskComment

Update a task comment in ClickUp. Use this tool to replace a task comment's content, assign it, or mark it as resolved in ClickUp.

Parameters

ParameterTypeReq.Description
assignee_user_idintegerRequiredThe ID of the user to assign the comment to. This should be a numeric user ID in ClickUp.
comment_identifierintegerRequiredThe unique identifier of the comment to update. It must be an integer.
mark_comment_as_resolvedbooleanRequiredSet to true to mark the comment as resolved; false to leave it unresolved. Accepts a boolean value.
new_comment_contentstringRequiredThe new content for the task comment. This will replace the existing comment text.
assign_to_groupintegerOptionalAssign the comment to a group by providing the group's ID.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'UpdateComment'.
#

ClickupApi.UpdateTaskCustomField

Update a custom field value for a specific task in ClickUp. Use this tool to add data to a custom field on a task. Requires the `task_id` of the task and the `field_id` of the custom field. Retrieve `field_id` using the 'Get Accessible Custom Fields' or 'Get Task' endpoints. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
task_idstringOptionalThe ID of the task to be updated with new custom field data. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
custom_field_uuidstringOptionalThe UUID of the custom field to update for a specific task. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
workspace_idintegerOptionalProvide the Workspace ID when referencing a task by its Custom Task ID (`custom_task_ids` must be true). Only used when mode is 'execute'.
use_custom_task_id_referencebooleanOptionalSet to `true` to reference a task using its Custom Task ID. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'SetCustomFieldValue'.
#

ClickupApi.UpdateTaskInClickup

Update task details in ClickUp. Use this tool to update specific fields of a task in ClickUp by providing the task ID and desired changes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
task_identifierstringOptionalThe ID of the task to be updated. Provide either the standard task ID or a custom task ID if 'custom_task_ids' is true. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
workspace_id_for_custom_taskintegerOptionalProvide the Workspace ID when referencing a task by its custom task ID (requires `custom_task_ids` set to true). Only used when mode is 'execute'.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'UpdateTask'.
#

ClickupApi.UpdateTaskTag

Update a task tag in a ClickUp space. Use this tool to update the details of a task tag within a specified ClickUp space. It is helpful for managing and organizing tasks by modifying existing tags.

Parameters

ParameterTypeReq.Description
background_color_of_tagstringRequiredThe background color for the task tag. It should be a valid hex color code (e.g., #FFFFFF).
current_tag_namestringRequiredThe current name of the tag to be updated in the ClickUp space.
new_tag_namestringRequiredThe new name for the task tag to be updated in the ClickUp space. It must be a string representing the desired tag name after the update.
space_idintegerRequiredThe unique identifier of the ClickUp space where the tag will be updated. This is required to specify which space's tag needs modification.
tag_foreground_colorstringRequiredThe foreground (text) color of the tag in a valid color format (e.g., HEX).

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'EditSpaceTag'.
#

ClickupApi.UpdateTimeEntry

Update the details of a time entry. This tool updates specific details of a time entry in ClickUp. Use it when you need to modify data such as the duration, description, or other attributes of an existing time entry. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
workspace_idintegerOptionalThe Workspace ID is required when referencing a task by its custom task ID. Provide it if `custom_task_ids` is set to `true`. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
team_identifierintegerOptionalThe ID of the workspace (team) where the time entry is located. This is an integer value. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
timer_idintegerOptionalThe unique identifier of the time entry to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
use_custom_task_idsbooleanOptionalSet to true to reference tasks by custom task IDs instead of standard IDs. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'UpdateatimeEntry'.
#

ClickupApi.UpdateUserGroup

Update and manage user groups within a ClickUp Workspace. Use this tool to update user groups in your ClickUp Workspace. Useful for managing team membership, permissions, or configurations. Note that adding a guest with view-only permissions will incur additional charges as they convert to paid guests.

Parameters

ParameterTypeReq.Description
user_group_idstringRequiredThe unique identifier of the User Group within the Workspace. This ID is required to specify which group to update.
add_member_idsarray<integer>OptionalAn array of user IDs to add to the User Group. Each ID should be an integer.
handle_identifierstringOptionalA unique identifier or handle for the User Group. This is used to reference the group within ClickUp.
remove_members_idsarray<integer>OptionalAn array of integer IDs representing the users to be removed from the User Group.
user_group_namestringOptionalThe new name for the User Group within the ClickUp Workspace. This should be a string representing the desired name.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'UpdateTeam'.
#

ClickupApi.UpdateUserWorkspaceDetails

Update a user's name and role in a ClickUp workspace. This tool updates a user's name and role within a specific ClickUp workspace. It's only available to Workspaces on the Enterprise Plan. Use it to change user details in a team.

Parameters

ParameterTypeReq.Description
assign_admin_rolebooleanRequiredSet to true to assign the user as an admin in the workspace, otherwise false.
custom_role_idintegerRequiredAn integer representing the custom role ID to assign to the user in the workspace. This is required for users with specific roles.
user_identifierintegerRequiredThe unique identifier for the user within the workspace. This value is required to specify which user's details need updating.
user_namestringRequiredThe new full name of the user to be updated in the ClickUp workspace.
workspace_idintegerRequiredThe ID of the ClickUp workspace where the user's details will be updated.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'EditUserOnWorkspace'.
#

ClickupApi.UpdateViewSettings

Update the settings and configuration of a view. Rename, regroup, sort, filter, and modify columns and settings of a view when needing to adjust its configuration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
view_identifierstringOptionalThe unique identifier for the view to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'UpdateView'.
#

ClickupApi.ViewChatComments

Retrieve the most recent comments from a Chat view. This tool fetches comments from a Chat view in ClickUp. It returns the 25 most recent comments if no parameters are provided. To access older comments, use `start` and `start_id` parameters.

Parameters

ParameterTypeReq.Description
chat_view_idstringRequiredThe unique identifier for the Chat view to retrieve comments from. It should be a string, typically '105'.
comment_start_date_unix_msintegerOptionalThe start date of a Chat view comment in Unix time (milliseconds) to fetch older comments.
start_comment_idstringOptionalThe comment ID to start retrieving older comments from in the Chat view. Use this to fetch comments beyond the most recent 25.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetChatViewComments'.
#

ClickupApi.ViewFolderLists

Retrieve lists contained in a specified folder. Call this tool to access all the lists that are organized under a specific folder in ClickUp by providing the folder ID.

Parameters

ParameterTypeReq.Description
folder_idintegerRequiredThe unique identifier for the folder whose lists you want to retrieve. This must be an integer.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetFolder'.
#

ClickupApi.ViewListCustomFields

Retrieve accessible custom fields for a specific list. Use this tool to view the custom fields you have access to in a specific list. This is useful for understanding which custom fields are available for use or modification in your lists.

Parameters

ParameterTypeReq.Description
content_typestringRequiredThe MIME type of the request body, typically set to 'application/json'.
list_idintegerRequiredThe unique identifier of the list to retrieve accessible custom fields for.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetAccessibleCustomFields'.
#

ClickupApi.ViewListDetails

Retrieve details of a specific list in ClickUp. Use this tool to get detailed information about a specific list in ClickUp by providing the list ID. It helps in obtaining metadata and current status of the list.

Parameters

ParameterTypeReq.Description
list_idintegerRequiredThe unique ID of the list to view details. Right-click the list in your ClickUp sidebar, select 'Copy link', and paste the URL's last string.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetList'.
#

ClickupApi.ViewListsInFolder

Retrieve lists from a specific folder. Use this tool to view all the lists contained within a specified folder by providing the folder ID. It should be called when you need to access or manage lists within a folder within ClickUp.

Parameters

ParameterTypeReq.Description
folder_idintegerRequiredThe unique identifier for the folder whose lists are to be retrieved. This is required to specify which folder's lists to view.
include_archived_listsbooleanOptionalSpecify whether to include archived lists. Set to true to include and false to exclude.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetLists'.
#

ClickupApi.ViewSharedHierarchy

View shared tasks, lists, and folders. Use this tool to view tasks, lists, and folders shared with the authenticated user in a specified team.

Parameters

ParameterTypeReq.Description
workspace_idintegerRequiredThe Workspace ID to view shared tasks, lists, and folders.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'SharedHierarchy'.
#

ClickupApi.ViewTaskDetails

Retrieve detailed information about a specific task. Use this tool to get detailed information on a task you have access to in ClickUp, including any attachments associated with the task.

Parameters

ParameterTypeReq.Description
task_identifierstringRequiredThe unique identifier for the task you want to retrieve details for in ClickUp.
filter_custom_fieldsarray<string>OptionalInclude tasks with specific values in one or more custom fields using the specified JSON format. Custom Relationships are supported.
include_markdown_descriptionbooleanOptionalSet to true to return task descriptions in Markdown format.
include_subtasksbooleanOptionalInclude subtasks in the task details if set to true. Defaults to false.
use_custom_task_idsbooleanOptionalSet to true to reference a task by its custom task ID.
workspace_id_for_custom_taskintegerOptionalProvide the Workspace ID when referencing a task by its custom task ID. Required if `custom_task_ids` is true.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetTask'.
#

ClickupApi.ViewTaskOrPageInfo

Retrieve details of a specific task or page view. Use this tool to get detailed information about a specific task or page view in ClickUp using the view ID.

Parameters

ParameterTypeReq.Description
view_identifierstringRequiredA unique identifier for the specific task or page view in ClickUp to be retrieved. This is required to obtain the relevant information.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetView'.
#

ClickupApi.ViewTaskTemplates

View available task templates in a workspace. Retrieve a list of task templates available for a specified workspace in ClickUp. Use this tool to explore task templates and plan tasks efficiently.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredSets the 'Content-Type' for the API request, typically 'application/json'.
page_numberintegerRequiredThe page number of results to retrieve. Used for pagination.
workspace_idintegerRequiredThe ID of the workspace for which to retrieve task templates. This is used to specify the target workspace in ClickUp.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetTaskTemplates'.
#

ClickupApi.ViewThreadedComments

Retrieve threaded replies to a comment. This tool allows for the retrieval of threaded comments in a ClickUp task, excluding the parent comment. Use this tool to view discussions or replies linked to a specific comment by providing the comment ID.

Parameters

ParameterTypeReq.Description
thread_comment_idintegerRequiredThe ID of the comment for which threaded replies are to be retrieved. This ID should be an integer and corresponds to the comment in a ClickUp task whose replies you want to view.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetThreadedComments'.
#

ClickupApi.ViewTimeEntry

Retrieve details of a specific time entry. Use this tool to view information about a single time entry, including its duration. If the duration is negative, it indicates an active timer for the user.

Parameters

ParameterTypeReq.Description
content_typestringRequiredSpecifies the format of the content being sent or received, such as 'application/json'.
time_entry_idstringRequiredThe ID of a specific time entry, which can be found using the Get Time Entries Within a Date Range endpoint.
workspace_idintegerRequiredThe ID of the workspace (team) to which the time entry belongs.
include_approval_detailsbooleanOptionalInclude the details of the approval for the time entry when true.
include_approval_historybooleanOptionalInclude the approval history of the time entry in the response. Set to true to include.
include_location_namesbooleanOptionalInclude names of the List, Folder, and Space in the response along with their respective IDs.
include_task_tagsbooleanOptionalSet to true to include task tags in the response.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Getsingulartimeentry'.
#

ClickupApi.ViewTimeEntryChanges

View a list of changes made to a time entry. Use this tool to access the history of modifications for a specific time entry within a team in ClickUp. It provides insights into various changes made on the entry, such as updates or edits.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredThe media type for the request, typically 'application/json'. Required for HTTP headers.
time_entry_idstringRequiredThe ID of a time entry. This ID can be obtained using the Get Time Entries Within a Date Range endpoint.
workspace_idintegerRequiredThe ID of the workspace (team) where the time entry resides.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'Gettimeentryhistory'.
#

ClickupApi.ViewWorkspaceCustomFields

Retrieve Workspace-level Custom Fields in ClickUp. Use this tool to view custom fields accessible at the workspace level in ClickUp. It doesn't include fields from Space, Folder, or List levels.

Parameters

ParameterTypeReq.Description
content_type_headerstringRequiredThe MIME type of the content. Typically set to 'application/json' for JSON data.
workspace_idintegerRequiredThe ID of the Workspace to retrieve custom fields for. This identifies which Workspace's fields you want to view.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'getTeamAvailableFields'.
#

ClickupApi.ViewWorkspaceGoals

View the Goals available in a Workspace. This tool retrieves the goals available in a specific workspace on ClickUp. It should be used when you need to access or display information about the goals associated with a given workspace.

Parameters

ParameterTypeReq.Description
workspace_idintegerRequiredThe unique identifier for the workspace to view its goals.
include_completed_goalsbooleanOptionalIndicate whether to include completed goals in the results. Set to true to include completed goals, or false to exclude them.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'GetGoals'.
Last updated on