ClickUp
API integration

list_all_clickup_teams

Use this endpoint to retrieve a list of Teams that the authenticated user is a member of.

list_all_clickup_groups

Use this endpoint to retrieve a list of all groups available in the system

list_all_clickup_spaces

Get Spaces for a workspace in ClickUp using team_id. Returns id, name, private, color, avatar, admin_can_manage, archived, members, statuses, multiple_assignees, and features for each space.

get_single_clickup_space_by_id

Get information about a specific space in ClickUp by id. Returns id, name, private status, statuses (status, type, orderindex, color), multiple_assignees, and features including due_dates, time_tracking, tags, time_estimates, checklists, custom_fields, remap_dependencies, and dependency_warning.

create_a_clickup_space

Create a new Space in ClickUp for the workspace identified by team_id. Returns id, name, private status, statuses array with id, status, type, orderindex, color, multiple_assignees flag, and features object detailing enabled features.

update_a_clickup_space_by_id

Update a Space by id in ClickUp. Requires name, color, private, admin_can_manage, multiple_assignees, and features object with due_dates, time_tracking, tags, time_estimates, checklists, custom_fields, remap_dependencies, dependency_warning, and portfolios enabled booleans. Returns id, name, private, statuses (status, type, orderindex, color), multiple_assignees, and features with detailed booleans.

delete_a_clickup_space_by_id

Delete a Space by id in ClickUp. Returns status 200 on successful deletion.

list_all_clickup_folders

Get folders in a space in ClickUp using space_id. Returns id, name, orderindex, override_statuses, hidden, space details, task_count, and lists for each folder.

get_single_clickup_folder_by_id

Get information about a specific folder in ClickUp by folder id. Returns id, name, orderindex, override_statuses, hidden, space details (id, name, access), task_count, and lists within the folder.

create_a_clickup_folder

Create a new folder in ClickUp within the space identified by space_id. Returns id, name, orderindex, override_statuses, hidden, space (id, name, access), and task_count of the created folder.

update_a_clickup_folder_by_id

Update a folder's name in ClickUp using folder id. Returns id, name, orderindex, override_statuses, hidden, space (id, name, access), and task_count.

delete_a_clickup_folder_by_id

Delete a folder by id in ClickUp. This operation removes the specified folder from your workspace.

list_all_clickup_lists

Get Lists within a Folder in ClickUp using folder_id. Returns list id, name, orderindex, content, status, priority, assignee, task_count, due_date, start_date, folder info, space info, archived status, override_statuses, and permission_level.

get_single_clickup_list_by_id

Get information about a specific list in ClickUp by id. Returns id, name, orderindex, content, status (status, color, hide_label), priority (priority, color), assignee, due_date, due_date_time, start_date, start_date_time, folder (id, name, hidden, access), space (id, name, access), inbound_address, archived, override_statuses, and statuses (status, orderindex, color, type).

create_a_clickup_list

Create a new List in ClickUp under the folder identified by folder_id. Returns id, name, orderindex, content, status (status, color, hide_label), priority (priority, color), assignee (id, color, username, initials, profilePicture), task_count, due_date, due_date_time, start_date, start_date_time, folder (id, name, hidden, access), space (id, name, access), and statuses (status, orderindex, color, type).

update_a_clickup_list_by_id

Update a List by id in ClickUp. Returns id, name, orderindex, content, status (status, color, hide_label), priority (priority, color), assignee, task_count, due_date, due_date_time, start_date, start_date_time, folder (id, name, hidden, access), space (id, name, access), statuses (status, orderindex, color, type), and inbound_address.

delete_a_clickup_list_by_id

Delete a List by id in ClickUp. Returns an empty response body upon successful deletion.

list_all_clickup_tasks

Get filtered tasks by list in ClickUp. Returns tasks array with fields id, custom_id, name, description, status, orderindex, date_created, date_updated, date_closed, date_done, creator, assignees, watchers, and checklists.

get_single_clickup_task_by_id

Get information about a specific task in ClickUp by id. Returns fields including id, custom_id, name, description, status (status, color, orderindex, type), creator (id, username, color, profilePicture), assignees, watchers, checklists, tags, parent, priority (color, id, orderindex, priority), due_date, start_date, points, time_estimate, and time_spent.

update_a_clickup_task_by_id

Update a task by task id in ClickUp. Returns updated task fields including id, name, description, status, priority, due_date, start_date, points, assignees, watchers, archived, and custom_fields.

create_a_clickup_task

Create a new task in ClickUp under list_id. Returns id, custom_id, name, description, status (status, color, orderindex, type), creator (id, username, color, profilePicture), assignees, archived, group_assignees, tags, parent, priority, due_date, start_date, points, time_estimate, and custom_fields.

delete_a_clickup_task_by_id

Delete a task in ClickUp. Requires id. Returns an empty object if deletion is successful.

list_all_clickup_comments

Get task comments for task id in ClickUp. Returns fields id, comment text, user info, resolved status, assignee, assigned_by, reactions, date, and reply_count.

create_a_clickup_comment

Create a new comment on a task in ClickUp using task_id. Returns id, hist_id, and date of the created comment. Requires comment_text and notify_all parameters.

update_a_clickup_comment_by_id

Update a comment by id in ClickUp. Requires comment_text, assignee, and resolved status. Returns updated comment details.

delete_a_clickup_comment_by_id

Delete a task comment in ClickUp using id. Returns status 200 on successful deletion.

list_all_clickup_tags

Get task tags for a specific space in ClickUp using space_id. Returns tags array with name, tag_fg (foreground color), and tag_bg (background color) fields.

create_a_clickup_tag

Create a new task tag in ClickUp for the space identified by space_id. Returns the created tag object with its details.

update_a_clickup_tag_by_id

Update a task tag in ClickUp with space_id and tag_name. Returns the updated tag's name, fg_color, and bg_color.

delete_a_clickup_tag_by_id

Delete a task tag from a space in ClickUp using space_id and tag_name. Returns an object confirming the deletion.

delete_a_clickup_user_by_id

Deactivate a user from a Workspace in ClickUp using team_id and id. Returns the updated team object including id, name, color, avatar, and members.

update_a_clickup_user_by_id

Update a user's name and role in ClickUp workspace using team_id and id. Returns member object including user details (id, username, email, role, custom_role), invited_by info, and shared resources.

clickup_users_me

Use this endpoint to retrieve information about the authenticated user.

list_all_clickup_custom_fields

Get list of custom fields for a specific list in ClickUp using list_id. Returns fields with id, name, type, type_config, date_created, and hide_from_guests.

list_all_clickup_team_seats

Get Workspace seats for team with id in ClickUp. Returns members and guests seat usage including filled_member_seats, total_member_seats, empty_member_seats, filled_guest_seats, total_guest_seats, and empty_guest_seats.

list_all_clickup_team_plan

Get Workspace Plan for the specified team_id in ClickUp. Returns plan_name and plan_id indicating the current plan details.

list_all_clickup_custom_roles

Get Custom Roles for a workspace in ClickUp using team_id. Returns id, team_id, name, inherited_role, date_created, and members fields for each custom role.

list_all_clickup_workspace_plan

Get the current workspace plan for the specified team in ClickUp. Requires team_id. Returns plan_name and plan_id indicating the workspace's subscription plan details.

create_a_clickup_attachment

Create a task attachment for task_id in ClickUp. Requires task_id as path parameter. Returns id, version, date, title, extension, thumbnail_small, thumbnail_large, and url of the uploaded attachment. Files must not be cloud-stored.

list_all_clickup_folderless_lists

Get folderless lists in a space in ClickUp using space_id. Returns list id, name, orderindex, content, status, priority, assignee, task_count, due_date, start_date, folder info, space info, archived status, override_statuses, and permission_level.

list_all_clickup_chat_view_comments

Get chat view comments for view_id in ClickUp. Returns fields id, comment_text, user info, resolved status, assignee, assigned_by, reactions, date, and reply_count.

create_a_clickup_chat_view_comment

Create a Chat view comment with view_id, comment_text, and notify_all in ClickUp. Returns id, hist_id, and date of the created comment.

list_all_clickup_list_comments

Get comments for a list in ClickUp using list_id. Returns comment id, text, user info, resolved status, assignee, assigned_by, reactions, date, and reply_count fields.

create_a_clickup_list_comment

Create a comment on a List in ClickUp with list_id, comment_text, assignee, and notify_all. Returns id, hist_id, and date of the created comment.

list_all_clickup_threaded_comments

Get threaded comments for a specific comment in ClickUp. Requires id. Returns comments array with fields id, comment (text and comment_text), user, resolved, assignee, assigned_by, reactions, date, and reply_count (always 0).

create_a_clickup_threaded_comment

Create a threaded comment with comment_text and notify_all parameters in ClickUp. Requires comment_id as id. Response returns the created comment object.

list_all_clickup_custom_task_types

Get custom task types for a workspace in ClickUp using team_id. Returns id, name, name_plural, and description of each custom task type.

list_all_clickup_folder_custom_fields

Get Folder Custom Fields for folder with id. Returns fields created at the Folder level including id, name, type, type_config, date_created, and hide_from_guests.

list_all_clickup_space_custom_fields

Get Space Custom Fields for space with id. Returns fields created at the Space level including id, name, type, type_config, date_created, and hide_from_guests.

list_all_clickup_workspace_custom_fields

Get Workspace Custom Fields for team_id in ClickUp. Returns fields created at the Workspace level with id, name, type, type_config, date_created, and hide_from_guests.

get_single_clickup_doc_by_id

Get information about a specific Doc in ClickUp using workspace_id and id. Returns fields including id, name, date_created, date_updated, parent type and id, public status, workspace_id, archived status, creator, and page_defaults settings.

create_a_clickup_doc

Create a new Doc in ClickUp workspace using workspace_id. Returns id, name, type, parent object with id and type, public status, workspace_id, creator, and timestamps for creation and update.

list_all_clickup_search_docs

Get Docs in a Workspace in ClickUp using workspace_id. Returns docs with fields id, name, date_created, date_updated, parent, public, workspace_id, creator, deleted, archived, and related metadata.

list_all_clickup_docs_pages

Get pages belonging to a Doc in ClickUp using workspace_id and doc_id. Returns fields including id, doc_id, workspace_id, name, content, date_created, date_updated, authors, and nested pages.

get_single_clickup_docs_page_by_id

Get information about a specific page in a Doc in ClickUp. Requires workspace_id, doc_id, and id. Returns fields including id, doc_id, workspace_id, name, date_created, date_updated, content, creator_id, authors, and contributors.

create_a_clickup_docs_page

Create a page in a Doc in ClickUp with workspace_id and doc_id. Returns id, doc_id, parent_page_id, workspace_id, name, pages, sub_title, date_created, date_updated, content, avatar, creator_id, deleted, deleted_by, date_deleted, date_edited, edited_by, archived, archived_by, date_archived, authors, contributors, and cover.

update_a_clickup_docs_page_by_id

Edit a page in a Doc in ClickUp using workspace_id, doc_id, and id. Returns the updated page details including name, sub_title, content, content_edit_mode, and content_format.

list_all_clickup_goals

Get Goals for team_id in ClickUp. Returns goals with fields id, pretty_id, name, team_id, creator, owner, color, date_created, start_date, due_date, description, private, archived, multiple_owners, editor_token, date_updated, last_update, folder_id, pinned, owners, key_result_count, members, group_members, and percent_completed.

get_single_clickup_goal_by_id

Get details of a specific goal in ClickUp by id. Returns fields including id, name, team_id, date_created, start_date, due_date, description, private, archived, creator, color, pretty_id, multiple_owners, folder_id, members, owners (with id, username, initials, email, color, profilePicture), key_results, percent_completed, history, and pretty_url.

create_a_clickup_goal

Create a new Goal in ClickUp for the workspace identified by team_id. Returns the created goal's id, name, team_id, date_created, start_date, due_date, description, private status, archived status, creator, color, pretty_id, multiple_owners flag, folder_id, members, owners, key_results, percent_completed, history, and pretty_url.

update_a_clickup_goal_by_id

Update a Goal by id in ClickUp. Requires name, due_date, description, rem_owners, add_owners, and color. Returns updated goal fields including id, name, team_id, dates, description, owners, color, and progress details.

delete_a_clickup_goal_by_id

Delete a goal by id in ClickUp. Removes the specified goal from your Workspace.

create_a_clickup_goals_key_result

Create a Key Result for a goal in ClickUp using goal_id. Returns key result fields including id, name, type, unit, creator, date_created, percent_completed, completed, task_ids, subcategory_ids, owners, and last_action.

update_a_clickup_goals_key_result_by_id

Update a Key Result by id in ClickUp. Returns key_result with fields id, goal_id, name, type, unit, creator, date_created, goal_pretty_id, percent_completed, completed, task_ids, subcategory_ids, owners, and last_action.

delete_a_clickup_goals_key_result_by_id

Delete a key result by id in ClickUp. Returns an empty response body upon successful deletion.

get_single_clickup_guest_by_id

Get information about a specific guest in ClickUp. Requires team_id and id. Note: This endpoint is only available to Workspaces on the Enterprise Plan.

create_a_clickup_guest

Invite a guest to a Workspace in ClickUp using team_id and email. Returns team details including members with user info, invited_by info, permissions, and roles.

update_a_clickup_guest_by_id

Edit guest on workspace in ClickUp using team_id and id. Returns guest user details including id, email, role, custom_role, invited_by info, permissions (can_see_time_spent, can_see_time_estimated, can_edit_tags, can_create_views, can_see_points_estimated), and shared resources.

delete_a_clickup_guest_by_id

Revoke a guest's access to a Workspace in ClickUp using team_id and id. Returns the team object with id, name, color, avatar, and members fields.

list_all_clickup_members

Get workspace members who have access to a List in ClickUp using list_id. Returns members array with id, username, email, color, initials, profilePicture, and profileInfo fields.

list_all_clickup_task_members

Get task members for task id in ClickUp. Returns members array with id, username, email, color, initials, profilePicture, and profileInfo fields. Does not include people with inherited Hierarchy permission.

update_a_clickup_privacy_access_by_id

Update privacy and access settings of an object or location in ClickUp Workspace using workspace_id, object_type, and id. Returns updated privacy status and permission levels for specified users or groups.

list_all_clickup_shared_hierarchy

Get shared tasks, lists, and folders for the authenticated user in ClickUp. Requires team_id. Returns tasks array, lists with id, name, orderindex, content, status, priority, assignee, task_count, due_date, start_date, archived, and folders with id, name, orderindex, content, task_count, due_date, archived.

create_a_clickup_checklist

Create a new checklist for a task in ClickUp using task_id. Returns checklist id, task_id, name, orderindex, resolved, unresolved, and items fields.

update_a_clickup_checklist_by_id

Update a checklist's name or reorder its position on a task in ClickUp. Requires checklist id. Returns updated checklist details.

delete_a_clickup_checklist_by_id

Delete a checklist by id in ClickUp. Returns an empty response body upon successful deletion.

create_a_clickup_checklist_item

Create a checklist item for checklist with checklist_id in ClickUp. Returns the checklist with fields id, task_id, name, date_created, orderindex, resolved, unresolved, and items including item id, name, orderindex, assignee details, resolved status, parent, date_created, and children.

update_a_clickup_checklist_item_by_id

Update an individual checklist item by checklist_id and id in ClickUp. Returns updated checklist with fields id, task_id, name, date_created, orderindex, resolved, unresolved, and items including id, name, orderindex, assignee, resolved, parent, date_created, and children.

delete_a_clickup_checklist_item_by_id

Delete a checklist item using checklist id and checklist_item_id in ClickUp. Returns status 200 on success.

create_a_clickup_dependency

Set a task as waiting on or blocking another task in ClickUp. Requires task id as path parameter and either depends_on or dependency_of in the body to specify the related task. Include team_id if using custom_task_ids=true.

delete_a_clickup_dependency_by_id

Delete dependency relationship between tasks using task_id, depends_on, and dependency_of in ClickUp. If custom_task_ids is true, team_id must be provided. No content returned in response.

create_a_clickup_task_link

Create a link from task id to links_to task in ClickUp. Returns the linked task object including id, name, status, creator, assignees, checklists, tags, parent, priority, due_date, start_date, time_estimate, time_spent, list, folder, space, and linked_tasks with task_id, link_id, date_created, userid, and url.

delete_a_clickup_task_link_by_id

Delete the link between two tasks in ClickUp using task_id and links_to. Returns the updated task object including id, name, status, creator, assignees, checklists, tags, parent, priority, due_date, start_date, time_estimate, time_spent, list, folder, space, linked_tasks, and url.

list_all_clickup_templates

Get task templates for a workspace in ClickUp using team_id. Returns an array of template names available in the workspace.

get_single_clickup_time_entry_by_id

Get a single time entry by team_id and id in ClickUp. Returns fields including id, wid (workspace ID), user details, billable status, start and end times, duration, description, source, task location, task tags, and task URL. Note: negative duration means timer is running.

create_a_clickup_time_entry

Create a time entry in ClickUp for team_id. Requires start, duration, assignee, tid, description, tags, and billable. A negative duration means the timer is running. Returns description, tags, start, billable, duration, assignee, and tid.

update_a_clickup_time_entry_by_id

Update a time entry with id in ClickUp using team_id. Returns updated time entry details including description, tags (name, tag_fg, tag_bg), tid, billable, start, end, and duration.

delete_a_clickup_time_entry_by_id

Delete a time entry by team_id and id in ClickUp. Returns the deleted time entry's id, task details (id, name, status), workspace id (wid), user info (id, username, email), billable status, start and end times, duration, description, tags, source, and timestamp (at).

list_all_clickup_time_entry_history

Get the history of changes for a specific time entry in ClickUp using team_id and id. The response includes details of each change such as time, status, and user agent.

list_all_clickup_space_views

Get task and page views for a space in ClickUp using space_id. Returns views with id, name, type, parent (id and type), grouping, divide, sorting, filters, columns, team_sidebar, and settings.

create_a_clickup_space_view

Create a Space View in ClickUp with space_id, name, type, grouping, divide, sorting, filters, columns, team_sidebar, and settings. Returns view id, name, type, parent, grouping, divide, sorting, filters, columns, team_sidebar, and settings.

list_all_clickup_folder_views

Get task and page views for a folder in ClickUp by folder id. Returns views with id, name, type, parent info, grouping, divide, sorting, filters, columns, team_sidebar, and settings.

create_a_clickup_folder_view

Create a Folder View in ClickUp with folder_id. Returns view id, name, type, parent (id and type), grouping (field, dir, collapsed, ignore), divide (field, dir, collapsed), sorting fields, filters, columns, team_sidebar, and settings.

list_all_clickup_list_views

Get task and page views for a specific list in ClickUp using list_id. Returns views with id, name, type, parent (id and type), grouping, divide, sorting, filters, and columns fields.

create_a_clickup_list_view

Create a new view for a list in ClickUp using list_id. Returns the view's id, name, type, parent location, grouping, divide, sorting, filters, columns, team_sidebar, and settings configurations.

get_single_clickup_view_by_id

Get information about a specific view in ClickUp by id. Returns view fields including id, name, type, parent (id and type), grouping, divide, sorting, filters, columns, team_sidebar, and settings.

update_a_clickup_view_by_id

Update a view by id in ClickUp. Requires name, type, parent (id and type), grouping (field, dir, collapsed, ignore), divide (field, dir, collapsed, ignore), sorting (fields), filters (op, fields, search, show_closed), columns (fields), team_sidebar (assignees, assigned_comments, unassigned_tasks), and settings (show_task_locations, show_subtasks, show_subtask_parent_names, show_closed_subtasks, show_assignees, show_images, collapse_empty_columns, me_comments, me_subtasks, me_checklists). Returns updated view with id, name, type, parent, grouping, divide, sorting, filters, columns, team_sidebar, and settings.

delete_a_clickup_view_by_id

Delete a view by id in ClickUp. Returns status 200 on successful deletion.

list_all_clickup_webhooks

Get webhooks for a workspace in ClickUp using team_id. Returns webhook id, userid, team_id, endpoint, client_id, events triggered, task_id, list_id, folder_id, space_id, health status, and secret.

create_a_clickup_webhook

Create a webhook for a team in ClickUp with team_id. Returns webhook id, userid, team_id, endpoint, client_id, subscribed events, task_id, list_id, folder_id, space_id, health status, and secret.

update_a_clickup_webhook_by_id

Update a webhook by id in ClickUp to change the events monitored. Returns webhook id, userid, team_id, endpoint, client_id, subscribed events, related task_id, list_id, folder_id, space_id, and health status.

delete_a_clickup_webhook_by_id

Delete a webhook by id in ClickUp to stop monitoring its events and locations. Returns an empty response body on success.

clickup_task_attachments_download

Downloads a specific attachment file using the file's direct path, which is typically provided in the response of the message listing endpoint. The actual path must be replaced with the URI or download link of the attachment.