Skip to main content

ClickUp

Manage your projects and tasks with ClickUp.

ClickUp Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 164 actions:

ActionPurposeParameters
post_v2_task_by_task_id_attachmentUpload a file to a task as an attachment.task_id (string)
custom_task_ids (boolean)
team_id (number)
post_v2_oauth_tokenOAuth token endpoint for API authentication.data: {
. client_id (string)
. client_secret (string)
. code (string)
} (object) required
get_v2_userGet authenticated user details.No parameters
get_v2_teamGet available workspaces for authenticated user.No parameters
post_v2_task_by_task_id_checklistCreate a new checklist for a task.task_id (string)
custom_task_ids (boolean)
team_id (number)
data: {
. name (string)
} (object) required
put_v2_checklist_by_checklist_idEdit or reorder a task checklist.checklist_id (string)
data: {
. name (string)
. position (integer)
} (object) required
delete_v2_checklist_by_checklist_idDelete a checklist from a task.checklist_id (string)
post_v2_checklist_by_checklist_id_checklist_itemAdd a line item to a task checklist.checklist_id (string)
data: {
. name (string)
. assignee (integer)
} (object) required
put_v2_checklist_by_checklist_id_checklist_item_by_checklist_item_idUpdate a checklist item.checklist_id (string)
checklist_item_id (string)
data: {
. name (string)
. assignee (string,null)
. resolved (boolean)
. parent (string,null)
} (object) required
delete_v2_checklist_by_checklist_id_checklist_item_by_checklist_item_idDelete a line item from a task checklist.checklist_id (string)
checklist_item_id (string)
get_v2_task_by_task_id_commentGet comments from a task.task_id (string)
custom_task_ids (boolean)
team_id (number)
start (integer)
start_id (string)
post_v2_task_by_task_id_commentAdd a new comment to a task.task_id (string)
custom_task_ids (boolean)
team_id (number)
data: {
. comment_text (string)
. assignee (integer)
. group_assignee (string)
. notify_all (boolean)
} (object) required
get_v2_view_by_view_id_commentGet comments from a chat view.view_id (string)
start (integer)
start_id (string)
post_v2_view_by_view_id_commentAdd a new comment to a Chat view.view_id (string)
data: {
. comment_text (string)
. notify_all (boolean)
} (object) required
get_v2_list_by_list_id_commentGet comments from a list.list_id (number)
start (integer)
start_id (string)
post_v2_list_by_list_id_commentAdd a comment to a List.list_id (number)
data: {
. comment_text (string)
. assignee (integer)
. notify_all (boolean)
} (object) required
put_v2_comment_by_comment_idUpdate comment content and properties.comment_id (number)
data: {
. comment_text (string)
. assignee (integer)
. group_assignee (integer)
. resolved (boolean)
} (object) required
delete_v2_comment_by_comment_idDelete a task comment.comment_id (number)
get_v2_comment_by_comment_id_replyGet threaded comments.comment_id (number)
post_v2_comment_by_comment_id_replyCreate a threaded comment.comment_id (number)
data: {
. comment_text (string)
. assignee (integer)
. group_assignee (string)
. notify_all (boolean)
} (object) required
get_v2_list_by_list_id_fieldGet custom fields for a list.list_id (number)
Content-Type (string) required
get_v2_folder_by_folder_id_fieldGet custom fields for a folder.folder_id (number)
Content-Type (string) required
get_v2_space_by_space_id_fieldGet custom fields for a space.space_id (number)
Content-Type (string) required
get_v2_team_by_team_id_fieldView the Custom Fields you have access to in a specific Workspace. Get Workspace Custom Fields only returns Custom Fields created at the Workspace level. Custom Fields created at the Space, Folder, and List level are not included.team_id (number)
Content-Type (string) required
post_v2_task_by_task_id_field_by_field_idSet a custom field value on a task.task_id (string)
field_id (string)
custom_task_ids (boolean)
team_id (number)
data (undefined) required
delete_v2_task_by_task_id_field_by_field_idRemove the data from a Custom Field on a task. This does not delete the option from the Custom Field.task_id (string)
field_id (string)
custom_task_ids (boolean)
team_id (number)
post_v2_task_by_task_id_dependencySet a task as waiting on or blocking another task.task_id (string)
custom_task_ids (boolean)
team_id (number)
data: {
. depends_on (string)
. depedency_of (string)
} (object) required
delete_v2_task_by_task_id_dependencyRemove the dependency relationship between two or more tasks.task_id (string)
depends_on (string) required
dependency_of (string) required
custom_task_ids (boolean)
team_id (number)
post_v2_task_by_task_id_link_by_links_toThis is the equivalent of the feature Task Links in the right-hand sidebar of a Task. It allows you to link two tasks together. General links or links to other objects than tasks are not supported.task_id (string)
links_to (string)
custom_task_ids (boolean)
team_id (number)
delete_v2_task_by_task_id_link_by_links_toRemove the link between two tasks.task_id (string)
links_to (string)
custom_task_ids (boolean)
team_id (number)
get_v2_space_by_space_id_folderView the Folders in a Space.space_id (number)
archived (boolean)
post_v2_space_by_space_id_folderAdd a new Folder to a Space.space_id (number)
data: {
. name (string)
} (object) required
get_v2_folder_by_folder_idView the Lists within a Folder.folder_id (number)
put_v2_folder_by_folder_idRename a Folder.folder_id (number)
data: {
. name (string)
} (object) required
delete_v2_folder_by_folder_idDelete a Folder from your Workspace.folder_id (number)
get_v2_team_by_team_id_goalView the Goals available in a Workspace.team_id (number)
include_completed (boolean)
post_v2_team_by_team_id_goalAdd a new Goal to a Workspace.team_id (number)
data: {
. name (string)
. due_date (integer)
. description (string)
. multiple_owners (boolean)
. owners (array)
. color (string)
} (object) required
get_v2_goal_by_goal_idView the details of a Goal including its Targets.goal_id (string)
put_v2_goal_by_goal_idRename a Goal, set the due date, replace the description, add or remove owners, and set the Goal color.goal_id (string)
data: {
. name (string)
. due_date (integer)
. description (string)
. rem_owners (array)
. add_owners (array)
. color (string)
} (object) required
delete_v2_goal_by_goal_idRemove a Goal from your Workspace.goal_id (string)
Content-Type (string) required
post_v2_goal_by_goal_id_key_resultAdd a Target to a Goal.goal_id (string)
data: {
. name (string)
. owners (array)
. type (string)
. steps_start (integer)
. steps_end (integer)
. unit (string)
. task_ids (array)
. list_ids (array)
} (object) required
put_v2_key_result_by_key_result_idUpdate a Target.key_result_id (string)
data: {
. steps_current (integer)
. note (string)
} (object) required
delete_v2_key_result_by_key_result_idDelete a target from a Goal.key_result_id (string)
post_v2_team_by_team_id_guestInvite a guest to join a workspace Enterprise plan only.team_id (number)
data: {
. email (string)
. can_edit_tags (boolean)
. can_see_time_spent (boolean)
. can_see_time_estimated (boolean)
. can_create_views (boolean)
. can_see_points_estimated (boolean)
. custom_role_id (integer)
} (object) required
get_v2_team_by_team_id_guest_by_guest_idGet guest information Enterprise plan only.team_id (number)
guest_id (number)
put_v2_team_by_team_id_guest_by_guest_idConfigure guest options Enterprise plan only.team_id (number)
guest_id (number)
data: {
. can_see_points_estimated (boolean)
. can_edit_tags (boolean)
. can_see_time_spent (boolean)
. can_see_time_estimated (boolean)
. can_create_views (boolean)
. custom_role_id (integer)
} (object) required
delete_v2_team_by_team_id_guest_by_guest_idRevoke a guest's access to a Workspace. Note: This endpoint is only available to Workspaces on our Enterprise Planhttps://clickup.com/pricing.team_id (number)
guest_id (number)
post_v2_task_by_task_id_guest_by_guest_idShare a task with a guest. Note: This endpoint is only available to Workspaces on our Enterprise Planhttps://clickup.com/pricing.task_id (string)
guest_id (number)
include_shared (boolean)
custom_task_ids (boolean)
team_id (number)
data: {
. permission_level (string)
} (object) required
delete_v2_task_by_task_id_guest_by_guest_idRevoke a guest's access to a task. Note: This endpoint is only available to Workspaces on our Enterprise Planhttps://clickup.com/pricing.task_id (string)
guest_id (number)
include_shared (boolean)
custom_task_ids (boolean)
team_id (number)
post_v2_list_by_list_id_guest_by_guest_idShare a List with a guest. Note: This endpoint is only available to Workspaces on our Enterprise Planhttps://clickup.com/pricing.list_id (number)
guest_id (number)
include_shared (boolean)
data: {
. permission_level (string)
} (object) required
delete_v2_list_by_list_id_guest_by_guest_idRevoke a guest's access to a List. Note: This endpoint is only available to Workspaces on our Enterprise Planhttps://clickup.com/pricing.list_id (number)
guest_id (number)
include_shared (boolean)
post_v2_folder_by_folder_id_guest_by_guest_idShare a Folder with a guest. Note: This endpoint is only available to Workspaces on our Enterprise Planhttps://clickup.com/pricing.folder_id (number)
guest_id (number)
include_shared (boolean)
data: {
. permission_level (string)
} (object) required
delete_v2_folder_by_folder_id_guest_by_guest_idRevoke a guest's access to a Folder. Note: This endpoint is only available to Workspaces on our Enterprise Planhttps://clickup.com/pricing.folder_id (number)
guest_id (number)
include_shared (boolean)
get_v2_folder_by_folder_id_listView the Lists within a Folder.folder_id (number)
archived (boolean)
post_v2_folder_by_folder_id_listAdd a new List to a Folder.folder_id (number)
data: {
. name (string)
. content (string)
. markdown_content (string)
. due_date (integer)
. due_date_time (boolean)
. priority (integer)
. assignee (integer)
. status (string)
} (object) required
post_v2_space_by_space_id_folder_template_by_template_idCreate a new Folder using a Folder template within a Space. This endpoint allows you to create a folder with all its nested assets lists, tasks, etc. from a predefined template available in your Workspace. Publicly shared templates must be added to your Workspacehttps://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library before you can use them with the public API. This request can be run asynchronously or synchronously via the return_immediately parameter.space_id (string)
template_id (string)
data: {
. name (string)
. options (object)
} (object) required
get_v2_space_by_space_id_listView the Lists in a Space that aren't located in a Folder.space_id (number)
archived (boolean)
post_v2_space_by_space_id_listAdd a new List in a Space.space_id (number)
data: {
. name (string)
. content (string)
. markdown_content (string)
. due_date (integer)
. due_date_time (boolean)
. priority (integer)
. assignee (integer)
. status (string)
} (object) required
get_v2_list_by_list_idView information about a List.list_id (number)
put_v2_list_by_list_idRename a List, update the List Info description, set a due date/time, set the List's priority, set an assignee, set or remove the List color.list_id (string)
data: {
. name (string)
. content (string)
. markdown_content (string)
. due_date (integer)
. due_date_time (boolean)
. priority (integer)
. assignee (string)
. status (string)
. unset_status (boolean)
} (object) required
delete_v2_list_by_list_idDelete a List from your Workspace.list_id (number)
Content-Type (string) required
post_v2_list_by_list_id_task_by_task_idAdd a task to an additional List. Note: This endpoint requires the Tasks in Multiple List ClickApphttps://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists to be enabled.list_id (number)
task_id (string)
delete_v2_list_by_list_id_task_by_task_idRemove a task from an additional List. You can't remove a task from its home List. Note: This endpoint requires the Tasks in Multiple List ClickApphttps://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists to be enabled.list_id (number)
task_id (string)
get_v2_task_by_task_id_memberView the people who have access to a task. Responses do not include people with inherited Hierarchy permission to the task.task_id (string)
get_v2_list_by_list_id_memberGet Workspace members who have access to a List.list_id (number)
get_v2_team_by_team_id_customrolesView the Custom Roles available in a Workspace.team_id (number)
include_members (boolean)
get_v2_team_by_team_id_sharedView the tasks, Lists, and Folders that have been shared with the authenticated user.team_id (number)
get_v2_team_by_team_id_spaceView the Spaces avialable in a Workspace. You can only get member info in private Spaces.team_id (number)
archived (boolean)
post_v2_team_by_team_id_spaceAdd a new Space to a Workspace.team_id (number)
data: {
. name (string)
. multiple_assignees (boolean)
. features (object)
} (object) required
get_v2_space_by_space_idView the Spaces available in a Workspace.space_id (number)
put_v2_space_by_space_idRename, set the Space color, and enable ClickApps for a Space.space_id (number)
data: {
. name (string)
. color (string)
. private (boolean)
. admin_can_manage (boolean)
. multiple_assignees (boolean)
. features (object)
} (object) required
delete_v2_space_by_space_idDelete a Space from your Workspace.space_id (number)
get_v2_space_by_space_id_tagView the task Tags available in a Space.space_id (number)
Content-Type (string) required
post_v2_space_by_space_id_tagAdd a new task Tag to a Space.space_id (number)
data: {
. tag (object)
} (object) required
put_v2_space_by_space_id_tag_by_tag_nameUpdate a task Tag.space_id (number)
tag_name (string)
data: {
. tag (object)
} (object) required
delete_v2_space_by_space_id_tag_by_tag_nameDelete a task Tag from a Space.space_id (number)
tag_name (string)
data: {
. tag (object)
} (object) required
post_v2_task_by_task_id_tag_by_tag_nameAdd a Tag to a task.task_id (string)
tag_name (string)
custom_task_ids (boolean)
team_id (number)
Content-Type (string) required
delete_v2_task_by_task_id_tag_by_tag_nameRemove a Tag from a task. This does not delete the Tag from the Space.task_id (string)
tag_name (string)
custom_task_ids (boolean)
team_id (number)
Content-Type (string) required
get_v2_list_by_list_id_taskView the tasks in a List. Responses are limited to 100 tasks per page. You can only view task information of tasks you can access. This endpoint only includes tasks where the specified list_id is their home List. Tasks added to the list_id with a different home List are not included in the response by default. To include tasks that exist in multiple lists, use the include_timl parameter. The time_spent field displays time tracked in milliseconds, and is only included in the response for talist_id (number)
archived (boolean)
include_markdown_description (boolean)
page (integer)
order_by (string)
reverse (boolean)
subtasks (boolean)
statuses (array)
include_closed (boolean)
include_timl (boolean)
assignees (array)
watchers (array)
tags (array)
due_date_gt (integer)
due_date_lt (integer)
date_created_gt (integer)
date_created_lt (integer)
date_updated_gt (integer)
date_updated_lt (integer)
date_done_gt (integer)
date_done_lt (integer)
custom_fields (array)
custom_field (array)
custom_items (array)
post_v2_list_by_list_id_taskCreate a new task.list_id (number)
data: {
. name (string)
. description (string)
. assignees (array)
. archived (boolean)
. group_assignees (array)
. tags (array)
. status (string)
. priority (integer,null)
. due_date (integer)
. due_date_time (boolean)
. time_estimate (integer)
. start_date (integer)
. start_date_time (boolean)
. points (number)
. notify_all (boolean)
. parent (string,null)
. markdown_content (string)
. links_to (string,null)
. check_required_custom_fields (boolean)
. custom_fields (array)
. custom_item_id (number)
} (object) required
get_v2_task_by_task_idView information about a task. You can only view task information of tasks you can access. Tasks with attachments will return an 'attachments' response. Docs attached to a task are not returned.task_id (string)
custom_task_ids (boolean)
team_id (number)
include_subtasks (boolean)
include_markdown_description (boolean)
custom_fields (array)
put_v2_task_by_task_idUpdate a task by including one or more fields in the request body.task_id (string)
custom_task_ids (boolean)
team_id (number)
data: {
. custom_item_id (number,null)
. name (string)
. description (string)
. markdown_content (string)
. status (string)
. priority (integer)
. due_date (integer)
. due_date_time (boolean)
. parent (string)
. time_estimate (integer)
. start_date (integer)
. start_date_time (boolean)
. points (number)
. assignees (object)
. group_assignees (object)
. watchers (object)
. archived (boolean)
} (object) required
delete_v2_task_by_task_idDelete a task from your Workspace.task_id (string)
custom_task_ids (boolean)
team_id (number)
Content-Type (string) required
get_v2_team_by_team_id_taskView the tasks that meet specific criteria from a Workspace. Responses are limited to 100 tasks per page. You can only view task information of tasks you can access. Our Try It modal currently supports filtering by two or more Lists, Folders, or Spaces. To filter by a single List, Folder, or Space, we recommend using a free app like Postmanhttps://www.postman.com/ to test our public API.team_Id (number)
page (integer)
order_by (string)
reverse (boolean)
subtasks (boolean)
space_ids (array)
project_ids (array)
list_ids (array)
statuses (array)
include_closed (boolean)
assignees (array)
tags (array)
due_date_gt (integer)
due_date_lt (integer)
date_created_gt (integer)
date_created_lt (integer)
date_updated_gt (integer)
date_updated_lt (integer)
date_done_gt (integer)
date_done_lt (integer)
custom_fields (array)
custom_task_ids (boolean)
team_id (number)
parent (string)
include_markdown_description (boolean)
custom_items (array)
post_v2_task_by_task_id_mergeMerge multiple tasks into a target task. The target task is specified by the task_id parameter, while the source tasks to be merged are provided in the request body. Custom Task IDs are not supported.task_id (string)
data: {
. source_task_ids (array)
} (object) required
get_v2_task_by_task_id_time_in_statusView how long a task has been in each status. The Total time in Status ClickApp must first be enabled by the Workspace owner or an admin.task_id (string)
custom_task_ids (boolean)
team_id (number)
Content-Type (string) required
get_v2_task_bulk_time_in_status_task_idsView how long two or more tasks have been in each status. The Total time in Status ClickApp must first be enabled by the Workspace owner or an admin.task_ids (string) required
custom_task_ids (boolean)
team_id (number)
Content-Type (string) required
get_v2_team_by_team_id_task_templateView the task templates available in a Workspace.team_id (number)
page (integer) required
Content-Type (string) required
post_v2_list_by_list_id_task_template_by_template_idCreate a new task using a task template defined in your workspace. Publicly shared templates must be added to your Workspacehttps://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library before you can use them with the public API.list_id (number)
template_id (string)
data: {
. name (string)
} (object) required
post_v2_folder_by_folder_id_list_template_by_template_idCreate a new list using a list template in a Folder. Publicly shared templates must be added to your Workspacehttps://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library before you can use them with the public API. This request runs synchronously by default with return_immediately=true. The request returns the future List ID immediatly, but the List may not be created when the response is sent. Small templates can be applied synchronously, which guarantees that all sufolder_id (string)
template_id (string)
data: {
. name (string)
. options (object)
} (object) required
post_v2_space_by_space_id_list_template_by_template_idCreate a new List using a List template within a Space. Publicly shared templates must be added to your Workspacehttps://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library before you can use them with the public API. This request can be run asynchronously or synchronously via the return_immediately parameter.space_id (string)
template_id (string)
data: {
. name (string)
. options (object)
} (object) required
get_v2_team_by_team_id_seatsView the used, total, and available member and guest seats for a Workspace.team_id (string)
get_v2_team_by_team_id_planView the current Planhttps://clickup.com/pricing for the specified Workspace.team_id (string)
post_v2_team_by_team_id_groupThis endpoint creates a User Grouphttps://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups within a Workspace. User Groups are used to organize and manage users within a Workspace. In the API documentation, team_id refers to the Workspace ID, and group_id refers to the User Group ID. Note: Adding a guest with view-only permissions to a Team automatically converts them to a paid guest. If no paid guest seats are available, an additional member seat will be added, increteam_id (number)
data: {
. name (string)
. handle (string)
. members (array)
} (object) required
get_v2_team_by_team_id_custom_itemView the custom task types available in a Workspace.team_id (number)
put_v2_group_by_group_idThis endpoint is used to manage User Groupshttps://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups, which are groups of users within your Workspace. In our API, team_id in the path refers to the Workspace ID, and group_id refers to the ID of a User Group. Note: Adding a guest with view-only permissions to a User Group automatically converts them to a paid guest. If you don't have any paid guest seats available, a new member seat is automatically added to increase the ngroup_id (string)
data: {
. name (string)
. handle (string)
. members (object)
} (object) required
delete_v2_group_by_group_idThis endpoint is used to remove a User Grouphttps://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups from your Workspace. In our API documentation, team_id refers to the id of a Workspace, and group_id refers to the id of a user group.group_id (string)
get_v2_groupThis endpoint is used to view User Groupshttps://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups in your Workspace. In our API documentation, team_id refers to the ID of a Workspace, and group_id refers to the ID of a User Group.team_id (number) required
group_ids (string)
get_v2_task_by_task_id_timeNote: This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.task_id (string)
custom_task_ids (boolean)
team_id (number)
Content-Type (string) required
post_v2_task_by_task_id_timeNote: This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.task_id (string)
custom_task_ids (boolean)
team_id (number)
data: {
. start (integer)
. end (integer)
. time (integer)
} (object) required
put_v2_task_by_task_id_time_by_interval_idNote: This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.task_id (string)
interval_id (string)
custom_task_ids (boolean)
team_id (number)
data: {
. start (integer)
. end (integer)
. time (integer)
} (object) required
delete_v2_task_by_task_id_time_by_interval_idNote: This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.task_id (string)
interval_id (string)
custom_task_ids (boolean)
team_id (number)
Content-Type (string) required
get_v2_team_by_team_id_time_entriesView time entries filtered by start and end date. By default, this endpoint returns time entries from the last 30 days created by the authenticated user. To retrieve time entries for other users, you must include the assignee query parameter. Only one of the following location filters can be included at a time: space_id, folder_id, list_id, or task_id. Note: A time entry that has a negative duration means that timer is currently running for that user.team_Id (number)
start_date (number)
end_date (number)
assignee (number)
include_task_tags (boolean)
include_location_names (boolean)
include_approval_history (boolean)
include_approval_details (boolean)
space_id (number)
folder_id (number)
list_id (number)
task_id (string)
custom_task_ids (boolean)
team_id (number)
is_billable (boolean)
Content-Type (string) required
post_v2_team_by_team_id_time_entriesCreate a time entry. Note: A time entry that has a negative duration means that timer is currently running for that user.team_Id (number)
custom_task_ids (boolean)
team_id (number)
data: {
. description (string)
. tags (array)
. start (integer)
. stop (integer)
. end (integer)
. billable (boolean)
. duration (integer)
. assignee (integer)
. tid (string)
} (object) required
get_v2_team_by_team_id_time_entries_by_timer_idView a single time entry. Note: A time entry that has a negative duration means that timer is currently running for that user.team_id (number)
timer_id (string)
include_task_tags (boolean)
include_location_names (boolean)
include_approval_history (boolean)
include_approval_details (boolean)
Content-Type (string) required
delete_v2_team_by_team_id_time_entries_by_timer_idDelete a time entry from a Workspace.team_id (number)
timer_id (number)
Content-Type (string) required
put_v2_team_by_team_id_time_entries_by_timer_idUpdate the details of a time entry.team_id (number)
timer_id (number)
custom_task_ids (boolean)
data: {
. description (string)
. tags (array)
. tag_action (string)
. start (integer)
. end (integer)
. tid (string)
. billable (boolean)
. duration (integer)
} (object) required
get_v2_team_by_team_id_time_entries_by_timer_id_historyView a list of changes made to a time entry.team_id (number)
timer_id (string)
Content-Type (string) required
get_v2_team_by_team_id_time_entries_currentView a time entry that's currently tracking time for the authenticated user. Note: A time entry that has a negative duration means that timer is currently running for that user.team_id (number)
assignee (number)
Content-Type (string) required
delete_v2_team_by_team_id_time_entries_tagsRemove labels from time entries. This does not remove the label from a Workspace.team_id (number)
data: {
. time_entry_ids (array)
. tags (array)
} (object) required
get_v2_team_by_team_id_time_entries_tagsView all the labels that have been applied to time entries in a Workspace.team_id (number)
Content-Type (string) required
post_v2_team_by_team_id_time_entries_tagsAdd a label to a time entry.team_id (number)
data: {
. time_entry_ids (array)
. tags (array)
} (object) required
put_v2_team_by_team_id_time_entries_tagsRename an time entry label.team_id (number)
data: {
. name (string)
. new_name (string)
. tag_bg (string)
. tag_fg (string)
} (object) required
post_v2_team_by_team_id_time_entries_startStart a timer for the authenticated user.team_Id (number)
custom_task_ids (boolean)
team_id (number)
data: {
. description (string)
. tags (array)
. tid (string)
. billable (boolean)
} (object) required
post_v2_team_by_team_id_time_entries_stopStop a timer that's currently running for the authenticated user.team_id (number)
Content-Type (string) required
post_v2_team_by_team_id_userInvite someone to join your Workspace as a member. To invite someone as a guest, use the Invite Guestref:inviteguesttoworkspace endpoint. Note: This endpoint is only available to Workspaces on our Enterprise Planhttps://clickup.com/pricing.team_id (number)
data: {
. email (string)
. admin (boolean)
. custom_role_id (integer)
} (object) required
get_v2_team_by_team_id_user_by_user_idView information about a user in a Workspace. Note: This endpoint is only available to Workspaces on our Enterprise Planhttps://clickup.com/pricing.team_id (number)
user_id (number)
include_shared (boolean)
put_v2_team_by_team_id_user_by_user_idUpdate a user's name and role. Note: This endpoint is only available to Workspaces on our Enterprise Planhttps://clickup.com/pricing.team_id (number)
user_id (number)
data: {
. username (string)
. admin (boolean)
. custom_role_id (integer)
} (object) required
delete_v2_team_by_team_id_user_by_user_idDeactivate a user from a Workspace. Note: This endpoint is only available to Workspaces on our Enterprise Planhttps://clickup.com/pricing.team_id (number)
user_id (number)
get_v2_team_by_team_id_viewView the task and page views available at the Everything Level of a Workspace.team_id (number)
post_v2_team_by_team_id_viewAdd a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view at the Everything Level of a Workspace.team_id (number)
data: {
. name (string)
. type (string)
. grouping (object)
. divide (object)
. sorting (object)
. filters (object)
. columns (object)
. team_sidebar (object)
. settings (object)
} (object) required
get_v2_space_by_space_id_viewView the task and page views available for a Space.space_id (number)
post_v2_space_by_space_id_viewAdd a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Space.space_id (number)
data: {
. name (string)
. type (string)
. grouping (object)
. divide (object)
. sorting (object)
. filters (object)
. columns (object)
. team_sidebar (object)
. settings (object)
} (object) required
get_v2_folder_by_folder_id_viewView the task and page views available for a Folder.folder_id (number)
post_v2_folder_by_folder_id_viewAdd a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Folder.folder_id (number)
data: {
. name (string)
. type (string)
. grouping (object)
. divide (object)
. sorting (object)
. filters (object)
. columns (object)
. team_sidebar (object)
. settings (object)
} (object) required
get_v2_list_by_list_id_viewView the task and page views available for a List.br Views and required views are separate responses.list_id (number)
post_v2_list_by_list_id_viewAdd a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a List.list_id (number)
data: {
. name (string)
. type (string)
. grouping (object)
. divide (object)
. sorting (object)
. filters (object)
. columns (object)
. team_sidebar (object)
. settings (object)
} (object) required
get_v2_view_by_view_idView information about a specific task or page view.view_id (string)
put_v2_view_by_view_idRename a view, update the grouping, sorting, filters, columns, and settings of a view.view_id (string)
data: {
. name (string)
. type (string)
. parent (object)
. grouping (object)
. divide (object)
. sorting (object)
. filters (object)
. columns (object)
. team_sidebar (object)
. settings (object)
} (object) required
delete_v2_view_by_view_idDelete Viewview_id (string)
get_v2_view_by_view_id_taskSee all visible tasks in a view in ClickUp.view_id (string)
page (integer) required
get_v2_team_by_team_id_webhookView the webhooks created via the API for a Workspace. This endpoint returns webhooks created by the authenticated user.team_id (number)
post_v2_team_by_team_id_webhookSet up a webhook to monitor for events.br We do not have a dedicated IP address for webhooks. We use our domain name and dynamic addressing.team_id (number)
data: {
. endpoint (string)
. events (array)
. space_id (integer)
. folder_id (integer)
. list_id (integer)
. task_id (string)
} (object) required
put_v2_webhook_by_webhook_idUpdate a webhook to change the events to be monitored.webhook_id (string)
data: {
. endpoint (string)
. events (string)
. status (string)
} (object) required
delete_v2_webhook_by_webhook_idDelete a webhook to stop monitoring the events and locations of the webhook.webhook_id (string)
get_v3_workspaces_by_workspace_id_docsView the Docs in your Workspace. You can only view information of Docs you can access.workspaceId (number)
id (string)
creator (number)
deleted (boolean)
archived (boolean)
parent_id (string)
parent_type (string)
limit (number)
next_cursor (string)
post_v3_workspaces_by_workspace_id_docsCreate a new Doc.workspaceId (number)
data: {
. name (string)
. parent
. visibility (string)
. create_page (boolean)
} (object) required
get_v3_workspaces_by_workspace_id_docs_by_doc_idView information about a Doc.workspaceId (number)
docId (string)
get_v3_workspaces_by_workspace_id_docs_by_doc_id_page_listingView the PageListing for a Doc.workspaceId (number)
docId (string)
max_page_depth (number)
get_v3_workspaces_by_workspace_id_docs_by_doc_id_pagesView pages belonging to a Doc.workspaceId (number)
docId (string)
max_page_depth (number)
content_format (string)
post_v3_workspaces_by_workspace_id_docs_by_doc_id_pagesCreate a page in a Doc.workspaceId (number)
docId (string)
data: {
. parent_page_id (string)
. name (string)
. sub_title (string)
. content (string)
. content_format (string)
} (object) required
get_v3_workspaces_by_workspace_id_docs_by_doc_id_pages_by_page_idView the information about a page in a Doc. Due to markdown format limitations, some content elements will not be displayed exactly as they appear in ClickUp.doc:docsimportexportlimitations/workspaceId (number)
docId (string)
pageId (string)
content_format (string)
put_v3_workspaces_by_workspace_id_docs_by_doc_id_pages_by_page_idEdit a page in a Doc.workspaceId (number)
docId (string)
pageId (string)
data: {
. name (string)
. sub_title (string)
. content (string)
. content_edit_mode (string)
. content_format (string)
} (object) required
post_v3_workspaces_by_workspace_id_auditlogsCreate Workspace-level audit logs. Audit logs can only be created by the Workspace owner on Enterprise Plans.workspace_id (string)
data: {
. filter
. applicability (string)
. pagination
} (object) required
patch_v3_workspaces_by_workspace_id_by_object_type_by_object_id_aclsUpdate the privacy and access settings of an object or location in the Workspace. Note that sharing an item may incur charges.workspace_id (string)
object_type (string)
object_id (string)
data: {
. entries (array)
. private (boolean)
} (object) required
get_v3_workspaces_by_workspace_id_chat_channelsThis endpoint retrieves the Channels in a Workspace.workspace_id (integer)
description_format (string)
cursor (string)
limit (integer)
is_follower (boolean)
include_hidden (boolean)
with_comment_since (number)
room_types (array)
post_v3_workspaces_by_workspace_id_chat_channelsThis endpoint creates a new Channel not tied to a Space, Folder, or List. If a Channel with the specified name already exists it returns it.workspace_id (integer)
data: {
. description (string)
. name (string)
. topic (string)
. user_ids (array)
. visibility (string)
} (object) required
post_v3_workspaces_by_workspace_id_chat_channels_locationThis endpoint creates a Channel and when a Channel already exists on the requested location, it returns it.workspace_id (integer)
data: {
. description (string)
. topic (string)
. user_ids (array)
. visibility (string)
. location
} (object) required
post_v3_workspaces_by_workspace_id_chat_channels_direct_messageThis endpoint creates a new Direct Message between up to 10 users. If a Direct Message between those users already exists it returns it.workspace_id (integer)
data: {
. user_ids (array)
} (object) required
get_v3_workspaces_by_workspace_id_chat_channels_by_channel_idThis endpoint retrieves a specific Channel given its ID.workspace_id (integer)
channel_id (string)
description_format (string)
patch_v3_workspaces_by_workspace_id_chat_channels_by_channel_idThis endpoint updates a single Channel.workspace_id (integer)
channel_id (string)
data: {
. content_format (string)
. description (string)
. location
. name (string)
. topic (string)
. visibility (string)
} (object) required
delete_v3_workspaces_by_workspace_id_chat_channels_by_channel_idThis endpoint deletes a Channel. Applies to Channels tied to a Space, Folder, or List or not tied to locations.workspace_id (integer)
channel_id (string)
get_v3_workspaces_by_workspace_id_chat_channels_by_channel_id_followersThis endpoint retrieves followers of a specific Channel given its ID.workspace_id (integer)
channel_id (string)
cursor (string)
limit (integer)
get_v3_workspaces_by_workspace_id_chat_channels_by_channel_id_membersThis endpoint retrieves members of a specific Channel given its ID.workspace_id (integer)
channel_id (string)
cursor (string)
limit (integer)
get_v3_workspaces_by_workspace_id_chat_channels_by_channel_id_messagesThis endpoint retrieves messages for a specified Channel.workspace_id (integer)
channel_id (string)
cursor (string)
limit (integer)
content_format (string)
post_v3_workspaces_by_workspace_id_chat_channels_by_channel_id_messagesThis endpoint creates a top level message.workspace_id (integer)
channel_id (string)
data: {
. assignee (string)
. group_assignee (string)
. triaged_action (number)
. triaged_object_id (string)
. triaged_object_type (number)
. type (string)
. content (string)
. reactions (array)
. followers (array)
. content_format (string)
. post_data
} (object) required
patch_v3_workspaces_by_workspace_id_chat_messages_by_message_idThis endpoint updates a message.workspace_id (integer)
message_id (string)
data: {
. assignee (string)
. group_assignee (string)
. content (string)
. content_format (string)
. post_data
. resolved (boolean)
} (object) required
delete_v3_workspaces_by_workspace_id_chat_messages_by_message_idThis endpoint deletes a message.workspace_id (integer)
message_id (string)
get_v3_workspaces_by_workspace_id_chat_messages_by_message_id_reactionsThis endpoint retrieves reactions for a messageworkspace_id (integer)
message_id (string)
cursor (string)
limit (integer)
post_v3_workspaces_by_workspace_id_chat_messages_by_message_id_reactionsThis endpoint creates a message reaction using lower case emoji names.workspace_id (integer)
message_id (string)
data: {
. reaction (string)
} (object) required
delete_v3_workspaces_by_workspace_id_chat_messages_by_message_id_reactions_by_reactionThis endpoint deletes a message reaction.workspace_id (integer)
message_id (string)
reaction (string)
get_v3_workspaces_by_workspace_id_chat_messages_by_message_id_repliesThis endpoint retrieves replies to a message.workspace_id (integer)
message_id (string)
cursor (string)
limit (integer)
content_format (string)
post_v3_workspaces_by_workspace_id_chat_messages_by_message_id_repliesThis endpoint creates a reply message.workspace_id (integer)
message_id (string)
data: {
. assignee (string)
. group_assignee (string)
. triaged_action (number)
. triaged_object_id (string)
. triaged_object_type (number)
. type (string)
. content (string)
. reactions (array)
. followers (array)
. content_format (string)
. post_data
} (object) required
get_v3_workspaces_by_workspace_id_chat_messages_by_message_id_tagged_usersThis endpoint retrieves tagged users for a messageworkspace_id (integer)
message_id (string)
cursor (string)
limit (integer)