Reference

Create chat channel

Set up a new communication channel in your ClickUp workspace to organize team discussions and collaboration around specific topics, projects, or teams.

Create chat message

Send messages directly to ClickUp chat channels to keep your team updated and coordinated on tasks and projects. Use this to automate notifications, share updates, or post status reports without manually opening ClickUp.

Create chat reaction

Add an emoji reaction to a ClickUp chat message to acknowledge, celebrate, or show quick feedback without typing a response.

Create chat view comment

Add a comment to a ClickUp Chat view to share feedback, updates, or context with your team directly within a specific view. This enables real-time collaboration and keeps relevant discussions organized in one place.

Create direct message channel

Creates a direct message channel in ClickUp to start private conversations with team members or clients, supporting up to 15 participants in a single channel.

Create Location Chat Channel

Creates a dedicated chat channel within a specific ClickUp space, folder, or list to enable team communication and collaboration tied to that location. This helps organize discussions around specific projects, tasks, or organizational units.

Create reply message

Reply to messages in ClickUp chat to keep conversations organized and maintain context around tasks and projects. This helps you communicate directly within your workspace without switching between tools.

Create threaded comment

Reply to a specific comment in ClickUp to keep discussions organized and maintain conversation context within tasks. This helps team members follow threaded conversations without cluttering the main task comments.

Delete chat channel

Permanently removes a chat channel from your ClickUp workspace to clean up communication spaces and reduce clutter.

Delete chat message

Remove unwanted or outdated messages from ClickUp team chats to keep conversations clean and organized. Useful for deleting accidental messages, spam, or confidential information that was shared in error.

Delete chat reaction

Remove an emoji reaction from a chat message in ClickUp, allowing you to clean up feedback or correct mistaken reactions on team communications.

Create list comment

Add a comment to a ClickUp list to share updates, ask questions, or provide feedback directly within your project workspace. This enables team collaboration by keeping all discussion in context with your list.

Delete comment

Remove a comment from a task when it's no longer needed or was posted in error. This helps keep your task discussions clean and organized.

Create Doc

Creates a new document in your ClickUp workspace and returns the document ID for adding content or making updates. Use this to programmatically generate new documents as part of your workflow automation.

Create Doc Page

Create new pages within ClickUp Docs to organize and structure your documentation and project information. Add pages as standalone sections or nested under existing pages to build comprehensive knowledge bases and project guides.

Update Doc Page

Modify a ClickUp Doc page's title and content programmatically, allowing you to keep your documentation and notes synchronized with external data or workflows.

Add guest to folder

Grant external collaborators access to a specific folder in ClickUp with controlled permissions, allowing you to share project information securely without giving full account access.

Create folder

Organize your ClickUp workspace by creating new folders within a space to group related projects and tasks. This helps you structure your work hierarchically and improve team navigation through your task management system.

Create goal

Set up a new strategic goal or objective within your ClickUp workspace that your team can track and work toward together. This helps you organize high-level initiatives and measure progress across projects.

Create key result

Create measurable targets within your ClickUp goals to define specific objectives you want to achieve, helping you track progress toward larger strategic outcomes.

Add guest to list

Share a ClickUp List with a guest user and assign them specific access permissions so they can view and collaborate on tasks within that list.

Create folderless list

Add a new list directly to a ClickUp Space without organizing it into a folder, useful for quick project setup or standalone task tracking.

Create list

Creates a new task list within a ClickUp folder to organize and manage your team's work. Use this to structure projects into categorized lists for better task management and collaboration.

Create list from template in folder

Quickly set up a new project list in ClickUp by using a pre-built template, saving time on manual configuration and ensuring consistent list structure across your workspace.

Create space

Creates a new organizational space in ClickUp where you can organize projects, teams, and workflows within your workspace. Use this to establish separate areas for different departments, clients, or project types.

Create space tag

Create custom tags within your ClickUp workspace to organize and categorize tasks, projects, and items with branded colors for visual distinction.

Add tag to task

Attach an existing tag to a task to organize, categorize, or mark it with relevant labels for better task management and filtering.

Create a task

Quickly add new tasks to your ClickUp lists to organize work and track progress, with the option to create subtasks under parent tasks for better structure.

Create checklist

Add a checklist to a task in ClickUp to break down work into smaller, trackable sub-items that can be checked off as you complete them.

Create task comment

Add comments to ClickUp tasks to provide updates, feedback, or collaborate with team members on specific work items.

Add dependency

Link tasks together by marking one as dependent on another, creating clear workflow relationships that show which work must be completed before other tasks can proceed.

Add guest to task

Invite external collaborators or clients to view and work on specific tasks without giving them full team access. This allows you to securely share task visibility and collaboration permissions with people outside your workspace.

Add task link

Create a relationship between two ClickUp tasks to show how they depend on or relate to each other, helping you organize complex projects with interconnected work items.

Add task to list

Assigns an existing task to an additional ClickUp list, allowing you to organize and track the same task across multiple project contexts simultaneously.

Create checklist item

Add individual items to a checklist within a ClickUp task to break down work into smaller, trackable steps. This helps you organize sub-tasks and assign responsibility for specific items within a larger task.

Create task attachment

Attach files directly to ClickUp tasks to keep project documents, receipts, and resources organized in one place. This helps teams quickly access relevant materials without searching through email or storage systems.

Create task attachment

Upload files directly to a ClickUp task to keep all project-related documents, designs, and resources organized in one place alongside your task details.

Create task from template

Quickly create a new task in ClickUp by applying a template with predefined fields, settings, and structure, saving time on repetitive task setup.

Delete checklist

Remove a checklist from a task when it's no longer needed or relevant, keeping your task details clean and organized.

Delete checklist item

Remove completed or irrelevant items from checklists in ClickUp to keep your task lists clean and organized. This helps you maintain accurate progress tracking and reduce clutter in your project management.

Delete dependency

Remove task dependencies to unblock workflows and free up tasks that were waiting on others to complete.

Create team

Set up a new team in your ClickUp workspace and assign specific members to collaborate together. This helps you organize your workforce and control who has access to certain projects and tasks.

Add tags from time entries

Attach custom tags to your time entries to organize and categorize tracked work by project, client, or task type for better reporting and analysis.

Create a time entry

Log time spent on tasks and projects to track productivity and build accurate records for client billing or project analysis. This helps you understand where your time goes and generate insights for better project planning.

Create folder view

Organize your ClickUp folder by creating a customized view that displays tasks in your preferred format, helping you focus on what matters most.

Create list view

Creates a new customizable view (such as list, board, or calendar) within a ClickUp List to help you organize and visualize your tasks in different formats.

Create space view

Creates a customizable view in your ClickUp Space (such as List, Board, or Gantt) with your preferred layout, grouping, and filtering settings to organize work the way your team operates.

Create workspace Everything level view

Set up a custom view (such as List or Board format) that displays all tasks across your entire workspace, giving you a unified dashboard to monitor everything happening in your ClickUp team.

Create webhook

Set up automated notifications to your application whenever specific events occur in ClickUp, such as task updates or completions. This allows you to trigger workflows and keep external systems synchronized with your ClickUp workspace in real-time.

Get authorized teams workspaces

Retrieves all workspaces that your authenticated account has access to, allowing you to see which teams and projects you can work with in ClickUp.

Change tag names from time entries

Updates the name, background color, and/or foreground color for an existing time entry tag, identified by its current name and teamid.

Delete a time entry

Deletes an existing time entry, specified by timerid, from a Workspace identified by teamid.

Delete folder

Permanently and irreversibly deletes a specified folder and all its contents (Lists, Tasks) if the folderid exists.

Delete goal

Permanently removes an existing Goal, identified by its goalid, from the Workspace.

Delete key result

Deletes an existing Key Result, also referred to as a Target within a Goal, identified by its keyresultid.

Delete list

Permanently deletes an existing List and all its contents; this action is destructive and irreversible via the API.

Delete space

Permanently deletes a specified Space in ClickUp; this action is irreversible as the Space cannot be recovered via the API.

Delete space tag

Deletes a Tag from a Space, identified by tagname in path; precise matching of Tag details in the request body (tagname1, tagtagfg, tagtagbg) is generally…

Delete task

Permanently deletes a task, using its standard ID or a custom task ID (requires customtaskids=true and teamid).

Delete task link

Deletes an existing link, effectively a dependency or relationship, between two ClickUp tasks; set customtaskids=true and provide teamid if using custom task…

Delete team

Permanently deletes an existing Team (user group) from the Workspace using its groupid.

Delete time tracked

Deletes a time-tracked interval from a task; use this legacy endpoint for older time tracking systems.

Delete view

Permanently and irreversibly deletes an existing View in ClickUp, identified by its viewid.

Delete webhook

Permanently removes an existing webhook, specified by its ID, thereby ceasing all its event monitoring and notifications.

Edit checklist

Updates an existing checklist's name or position, identified by its checklistid.

Edit checklist item

Updates an existing checklist item, allowing modification of its name, assignee, resolution status, or parent item for nesting.

Edit guest on workspace

Modifies the details and permissions of an existing guest user within a specific Workspace.

Edit key result

Updates an existing key result's progress or note in ClickUp, where the key result measures progress towards a goal.

Edit space tag

Updates an existing tag's name and colors in a ClickUp Space; requires current tag name for identification, and new values for tag name, foreground color, and…

Edit time tracked

Edits a legacy time-tracked interval for a task (identified by taskid and intervalid) to update its start/end times and duration; teamid is required if…

Edit user on workspace

Updates a user's username, admin status, or custom role in a Workspace; requires the Workspace to be on an Enterprise Plan.

Get access token

Exchanges a ClickUp OAuth 2.0 authorization code (obtained after user consent) for an access token.

Get accessible custom fields

Retrieves all accessible Custom Field definitions for a specified ClickUp List using its listid.

Get all tags from time entries

Retrieves all unique tags applied to time entries within a specified ClickUp Team (Workspace).

Get authorized teams workspaces

Retrieves a list of Workspaces (Teams) the authenticated user can access.

Get authorized user

Retrieves the details of the currently authenticated ClickUp user.

Get bulk tasks time in status

Retrieves the time spent in each status for multiple tasks; requires the 'Total time in Status' ClickApp to be enabled in the Workspace.

Get chat channel

Retrieves details for a specific chat channel in a ClickUp Workspace.

Get chat channel followers

Tool to retrieve followers of a ClickUp chat channel.

Get chat channel members

Tool to get members of a chat channel.

Get chat channels

Tool to retrieve chat channels in a ClickUp workspace.

Get chat message reactions

Tool to retrieve reactions on a ClickUp chat message.

Get chat message replies

Retrieves replies to a chat message in ClickUp.

Get chat message tagged users

Tool to retrieve users tagged in a ClickUp chat message.

Get chat messages

Tool to retrieve messages from a ClickUp chat channel.

Get chat view comments

Retrieves comments from a specified Chat view in ClickUp, supporting pagination via start and startid to fetch comments older than the default 25 most recent.

Get custom roles

Retrieves all Custom Roles, which allow granular permission configurations, for a specified Workspace (Team).

Get custom task types

Retrieves all custom task types available within a specified Workspace (teamid).

Get Doc Content

Tool to fetch the full content of a ClickUp Doc including metadata and all page contents in markdown format.

Get Doc Page Content

Tool to fetch a single ClickUp Doc page's content and metadata by workspaceid + docid + pageid (v3 Docs API).

Get Doc Page Listing

Tool to fetch the page listing structure of a ClickUp Doc by workspaceid and docid.

Get Doc Pages

Tool to fetch pages belonging to a ClickUp Doc.

Get filtered team tasks

Retrieves a paginated list of tasks (up to 100 per page) from a specified workspace based on various filter criteria, respecting user access permissions.

Get folder

Retrieves detailed information about a specific folder in ClickUp.

Get Folder Available Fields

Tool to view custom fields available in a ClickUp folder.

Get folder views

Retrieves all configured views (like List, Board, Calendar) for a specified, existing Folder in ClickUp.

Get folderless lists

Retrieves all Lists within a specified Space that are not located in any Folder.

Get folders

Retrieves Folders within a specified ClickUp Space, ensuring spaceid is valid, with an option to filter by archived status.

Get goal

Retrieves detailed information for an existing ClickUp Goal, specified by its unique goalid.

Get goals

Retrieves goals for a specified ClickUp Workspace (Team); the teamid must be valid and accessible.

Get guest

Call this to retrieve detailed information for a specific guest within a Team (Workspace), ensuring the guestid is valid for the given teamid; this action…

Get list

Retrieves detailed information for an existing List in ClickUp, identified by its unique listid.

Get list comments

Retrieves comments for a specific ClickUp List, supporting pagination using start (timestamp) and startid (comment ID) to fetch earlier comments; omits them…

Get list members

Retrieves all members of a specific, existing ClickUp List by its ID.

Get list views

Retrieves all task and page views for a specified and accessible ClickUp List.

Get lists

Retrieves all lists within a specified, existing ClickUp folder, optionally filtering by archived status.

Get post subtype IDs

Tool to retrieve post subtype IDs (Announcement, Discussion, Idea, Update) for a ClickUp Workspace.

Get running time entry

Retrieves the currently active time entry for a user in a Workspace; a negative 'duration' in its data indicates it's running, and the response may be empty if…

Get singular time entry

Fetches a specific time entry by its ID for a given team; a negative duration in the response indicates an active timer.

Get space

Retrieves detailed information for an existing Space in a ClickUp Workspace, identified by its unique spaceid.

Get space available fields

Retrieves all custom fields available in a ClickUp Space, identified by spaceid.

Get space tags

Retrieves all tags for tasks within a specified ClickUp Space, requiring a valid spaceid.

Get space views

Retrieves all task and page views for a specified Space ID in ClickUp.

Get spaces

Retrieves Spaces for a Team ID; member information for private Spaces is returned only if the authenticated user is a member.

Get task

Retrieves comprehensive details for a ClickUp task by its ID, supporting standard or custom task IDs (requires teamid for custom IDs).

Get task comments

Retrieves up to 25 comments for a specified task, supporting pagination using start and startid to fetch older comments.

Get task members

Retrieves users with explicit access (directly assigned or shared) to a specific existing task, excluding users with inherited permissions.

Get task s time in status

Retrieves the duration a task has spent in each status, provided the 'Total time in Status' ClickApp is enabled for the Workspace.

Get task templates

Retrieves task templates for a specified Workspace (Team ID), supporting pagination.

Get tasks

Retrieves tasks from a specified ClickUp list; only tasks whose home is the given listid are returned.

Get team available fields

Retrieves all custom fields available in a ClickUp Workspace (Team), identified by teamid.

Get teams

Retrieves user groups (Teams) from a ClickUp Workspace, typically requiring teamid (Workspace ID), with an option to filter by groupids.

Get threaded comments

Retrieves threaded replies to a parent comment.

Get time entries within a date range

Retrieves time entries for a specified Team (Workspace ID) within a date range (defaults to the last 30 days for the authenticated user if dates are omitted);…

Get time entry history

Retrieves the modification history for an existing time entry within a specific ClickUp Team (Workspace).

Get tracked time

Retrieves tracked time for a task using a legacy endpoint; prefer newer Time Tracking API endpoints for managing time entries.

Get user

Retrieves detailed information for a specific user within a ClickUp Workspace (Team), available only for Workspaces on the ClickUp Enterprise Plan.

Get view

Fetches details for a specific ClickUp view, identified by its viewid, which must exist.

Get view tasks

Retrieves all tasks visible in a specified ClickUp view, respecting its applied filters, sorting, and grouping.

Get webhooks

Fetches webhooks for a Team (Workspace), returning only those created by the authenticated user via API, for a teamid they can access.

Get workspace everything level views

Retrieves all task and page views at the 'Everything Level' (a comprehensive overview of all tasks across all Spaces) for a specified ClickUp Workspace.

Get workspace plan

Retrieves the details of the current subscription plan for a specified ClickUp Workspace.

Get workspace seats

Retrieves seat utilization (used, total, available for members/guests) for a ClickUp Workspace (Team) ID, which must be for an existing Workspace.

Invite guest to workspace

Invites a guest by email to a ClickUp Workspace (Team) on an Enterprise Plan, setting initial permissions and optionally a custom role; further access…

Invite user to workspace

Invites a user via email to a ClickUp Workspace (Team), optionally granting admin rights or a custom role; requires an Enterprise Plan for the Workspace.

Move task to new home list

Tool to move a task to a new home List using ClickUp Public API v3.

Remove custom field value

Removes an existing value from a Custom Field on a specific task; this does not delete the Custom Field definition or its predefined options.

Remove guest from folder

Revokes a guest's access to a specific ClickUp Folder, optionally unsharing items explicitly shared with them within it; requires an Enterprise Plan.

Remove guest from list

Revokes a guest's access to a specific List, provided the guest currently has access to this List and the Workspace is on the ClickUp Enterprise Plan.

Remove guest from task

Revokes a guest's access to a specific task; only available for Workspaces on the ClickUp Enterprise Plan.

Remove guest from workspace

Permanently removes a guest from a specified Workspace, revoking all their access; this destructive operation requires the Workspace to be on the ClickUp…

Remove tag from task

Removes a tag from a specified task by disassociating it (does not delete the tag from Workspace), succeeding even if the tag is not on the task.

Remove tags from time entries

Removes tags from specified time entries in a team, without deleting the tags from the workspace.

Remove task from list

Removes a task from an extra list (not its home list); the 'Tasks in Multiple Lists' ClickApp must be enabled.

Remove user from workspace

Deactivates a user from a specified ClickUp Workspace, revoking their access (user can be reactivated later); requires the Workspace to be on an Enterprise…

Search Docs

Tool to search and list Docs metadata in a ClickUp workspace.

Set custom field value

Sets or updates a Custom Field's value for a task; the new value (with type-dependent structure, e.g., {"value": "text"} or {"value": 123, "valueoptions":…

Shared hierarchy

Retrieves the hierarchy of tasks, Lists, and Folders shared with the authenticated user within an existing ClickUp Team (Workspace), identified by its teamid.

Start a time entry

Starts a new time entry (timer) in the specified Team (Workspace), optionally associating it with a task, adding a description, setting billable status, or…

Stop a time entry

Stops the authenticated user's currently active time entry in the specified Team (Workspace), which requires an existing time entry to be running.

Track time

Records a time entry for a task using ClickUp's legacy time tracking system; newer endpoints are generally recommended.

Update a time entry

Updates an existing ClickUp time entry.

Update chat channel

Tool to update a ClickUp chat channel's properties including name, topic, description, visibility, and location.

Update chat message

Tool to update a ClickUp chat message's content, assignee, or resolved status via the v3 API.

Update comment

Updates an existing task comment's text, assignee (who must be a valid workspace member), or resolution status, requiring a valid existing commentid.

Update folder

Updates the name of an existing folder in ClickUp.

Update goal

Updates attributes of an existing ClickUp goal, identified by its goalid.

Update list

Updates attributes of an existing ClickUp list, such as its name, content, due date, priority, assignee, or color status, identified by its listid.

Update space

Updates an existing ClickUp Space, allowing modification of its name, color, privacy, and feature settings (ClickApps).

Update task

Updates attributes of an existing task; teamid is required if customtaskids is true, use a single space (" ") for description to clear it, and provide at least…

Update team

Updates an existing ClickUp User Group (Team) using its groupid; note that adding a view-only guest as a paid member may incur charges.

Update view

Updates an existing ClickUp view's settings such as name, type, grouping, or filters; ensure parentid and parenttype define a valid hierarchy, and that…

Update webhook

Updates the endpoint URL, monitored events, and status of an existing webhook, identified by its webhookid.

Update workspace ACL

Updates privacy and access control list (ACL) permissions for a workspace object or location.