# ClickUp Documentation ## Guides - [Chat](https://developer.clickup.com/docs/chat.md): Create and retrieve messages, Channels, direct messages, and more via API. - [Comment formatting](https://developer.clickup.com/docs/comment-formatting.md): Apply rich text formatting to comments. - [Comments](https://developer.clickup.com/docs/comments.md): Get and add comments via API. - [Task comments pagination](https://developer.clickup.com/docs/task-comments-pagination.md): Learn how to request additional pages of task comments. - [Docs API limitation](https://developer.clickup.com/docs/docsimportexportlimitations.md): Learn about the limitations of the Docs endpoints. - [Common Errors](https://developer.clickup.com/docs/common_errors.md): Common errors you may encounter while using the ClickUp API. - [Frequently asked questions](https://developer.clickup.com/docs/faq.md): FAQ about the ClickUp API. - [Date formatting](https://developer.clickup.com/docs/general-time.md): How to format time values in the ClickUp API. - [ClickUp API v2 and v3 Terminology](https://developer.clickup.com/docs/general-v2-v3-api.md): Learn the difference between v2 and v3 terminology in the ClickUp API. - [OpenAPI Specification](https://developer.clickup.com/docs/open-api-spec.md): Access and use the OpenAPI specification for the ClickUp API. - [Rate Limits](https://developer.clickup.com/docs/rate-limits.md): Understand the rate limits that apply to the ClickUp API. - [Authentication](https://developer.clickup.com/docs/authentication.md): Authenticate to the ClickUp API using a personal token or OAuth. - [Get Started with the ClickUp API](https://developer.clickup.com/docs/Getting Started.md): Use the ClickUp API to build powerful integrations and apps! - [Try the API in your web browser](https://developer.clickup.com/docs/trytheapi.md): Use the ClickUp API right from your web browser! - [MCP Server Setup Instructions](https://developer.clickup.com/docs/connect-an-ai-assistant-to-clickups-mcp-server-1.md): Learn how to setup your AI assistant with ClickUp's MCP server. - [ClickUp's MCP Server](https://developer.clickup.com/docs/connect-an-ai-assistant-to-clickups-mcp-server.md): Learn about ClickUp's MCP Server so you can use your AI assistant with ClickUp! - [Supported Tools](https://developer.clickup.com/docs/mcp-tools.md): Use these supported tools with ClickUp's MCP Server. - [Attachments](https://developer.clickup.com/docs/attachments.md): Add attachments to tasks using the ClickUp API. - [Custom Fields](https://developer.clickup.com/docs/customfields.md): View and set Custom Fields on tasks using the ClickUp API. - [Move a task to a new List](https://developer.clickup.com/docs/move-a-task-to-a-new-list.md) - [Range operator with Custom Fields](https://developer.clickup.com/docs/range.md): Use Custom Fields to filter tasks using the range operator. - [Filter tasks using Custom Fields](https://developer.clickup.com/docs/taskfilters.md): Use Custom Fields to filter tasks with the Get Tasks and Get Filtered Team Tasks endpoints. - [Tasks](https://developer.clickup.com/docs/tasks.md): Work with tasks using the ClickUp API. - [Filter Views](https://developer.clickup.com/docs/filter-views.md): Filter a view using the ClickUp API. - [Views](https://developer.clickup.com/docs/views.md): Work with views using the ClickUp API. - [Automation Call webhook Legacy payload](https://developer.clickup.com/docs/automationcallwebhooklegacypayload.md): Example Automation webhook payload. - [Automation Call webhook payload](https://developer.clickup.com/docs/automationwebhookpayload.md): Example Automation webhook payload. - [Folder webhook payloads](https://developer.clickup.com/docs/webhookfolderpayloads.md): Example Folder webhook payloads. - [Goal and Target webhook payloads](https://developer.clickup.com/docs/webhookgoaltargetpayloads.md): Example Goal and Target webhook payloads. - [Webhook health status](https://developer.clickup.com/docs/webhookhealth.md): Keep your webhooks healthy and understand what happens when they fail. - [List webhook payloads](https://developer.clickup.com/docs/webhooklistpayloads.md): Example List webhook payloads. - [Webhooks](https://developer.clickup.com/docs/webhooks.md): Create webhooks using the ClickUp API. - [Webhook signature](https://developer.clickup.com/docs/webhooksignature.md): Apply a secure signature to your ClickUp API webhooks. - [Space webhook payloads](https://developer.clickup.com/docs/webhookspacepayloads.md): Example Space webhook payloads. - [Task webhook payloads](https://developer.clickup.com/docs/webhooktaskpayloads.md): Example task webhook payloads. ## API Reference - [Create Task Attachment](https://developer.clickup.com/reference/createtaskattachment.md): Upload a file to a task as an attachment. Files stored in the cloud cannot be used in this API request.\ \ ***Note:** This request uses multipart/form-data as the content type.* - [Get Access Token](https://developer.clickup.com/reference/getaccesstoken.md): These are the routes for authing the API and going through the [OAuth flow](doc:authentication).\ \ Applications utilizing a personal API token don't use this endpoint.\ \ ***Note:** OAuth tokens are not supported when using the [**Try It** feature](doc:trytheapi) of our Reference docs. You can't try this endpoint from your web browser.* - [Get Authorized User](https://developer.clickup.com/reference/getauthorizeduser.md): View the details of the authenticated user's ClickUp account. - [Create Chat View Comment](https://developer.clickup.com/reference/createchatviewcomment.md): Add a new comment to a Chat view. - [Create List Comment](https://developer.clickup.com/reference/createlistcomment.md): Add a comment to a List. - [Create Task Comment](https://developer.clickup.com/reference/createtaskcomment.md): Add a new comment to a task. - [Create Threaded Comment](https://developer.clickup.com/reference/createthreadedcomment.md): Create a threaded comment. - [Delete Comment](https://developer.clickup.com/reference/deletecomment.md): Delete a task comment. - [Get Chat View Comments](https://developer.clickup.com/reference/getchatviewcomments.md): View comments from a Chat view. \ \ If you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\ \ Use the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments. - [Get List Comments](https://developer.clickup.com/reference/getlistcomments.md): View the comments added to a List. \ \ If you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\ \ Use the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments. - [Get Task Comments](https://developer.clickup.com/reference/gettaskcomments.md): View task comments. \ \ Retrieve comments from a task. Results are returned in reverse chronological order (newest to oldest). By default, the request returns the 25 most recent comments.\ \ [Pagination](https://developer.clickup.com/docs/task-comments-pagination): To fetch the next page of history (older comments), you must use the `start` and `start_id` parameters together, using the data from the last comment of the current response. - [Get Threaded Comments](https://developer.clickup.com/reference/getthreadedcomments.md): View threaded comments. The parent comment is not included in the response. - [Update Comment](https://developer.clickup.com/reference/updatecomment.md): Replace the content of a task commment, assign a comment, and mark a comment as resolved. - [Get List Custom Fields](https://developer.clickup.com/reference/getaccessiblecustomfields.md): View the Custom Fields you have access to in a specific List. - [Get Folder Custom Fields](https://developer.clickup.com/reference/getfolderavailablefields.md): View the Custom Fields you have access to in a Folder. Get Folder Custom Fields only returns Custom Fields created at the Folder level. Custom Fields created at the List level are not included. - [Get Space Custom Fields](https://developer.clickup.com/reference/getspaceavailablefields.md): View the Custom Fields you have access to in a specific Space. Get Space Custom Fields only returns Custom Fields created at the Space level. Custom Fields created at the Folder and List level are not included. - [Get Workspace Custom Fields](https://developer.clickup.com/reference/getteamavailablefields.md): View 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. - [Remove Custom Field Value](https://developer.clickup.com/reference/removecustomfieldvalue.md): Remove the data from a Custom Field on a task. This does not delete the option from the Custom Field. - [Set Custom Field Value](https://developer.clickup.com/reference/setcustomfieldvalue.md): Add data to a Custom field on a task. \ \ You'll need to know the `task_id` of the task you want to update, and the universal unique identifier (UUID) `field_id` of the Custom Field you want to set. \ \ You can use [Get Accessible Custom Fields](ref:getaccessiblecustomfields) or the [Get Task](ref:gettask) endpoint to find the `field_id`. - [Get Custom Task Types](https://developer.clickup.com/reference/getcustomitems.md): View the custom task types available in a Workspace. - [Create Folder](https://developer.clickup.com/reference/createfolder.md): Add a new Folder to a Space. - [Create Folder from template](https://developer.clickup.com/reference/createfolderfromtemplate.md): Create 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 Workspace](https://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. - [Delete Folder](https://developer.clickup.com/reference/deletefolder.md): Delete a Folder from your Workspace. - [Get Folder](https://developer.clickup.com/reference/getfolder.md): View the Lists within a Folder. - [Get Folders](https://developer.clickup.com/reference/getfolders.md): View the Folders in a Space. - [Update Folder](https://developer.clickup.com/reference/updatefolder.md): Rename a Folder. - [Create Goal](https://developer.clickup.com/reference/creategoal.md): Add a new Goal to a Workspace. - [Create Key Result](https://developer.clickup.com/reference/createkeyresult.md): Add a Target to a Goal. - [Delete Goal](https://developer.clickup.com/reference/deletegoal.md): Remove a Goal from your Workspace. - [Delete Key Result](https://developer.clickup.com/reference/deletekeyresult.md): Delete a target from a Goal. - [Edit Key Result](https://developer.clickup.com/reference/editkeyresult.md): Update a Target. - [Get Goal](https://developer.clickup.com/reference/getgoal.md): View the details of a Goal including its Targets. - [Get Goals](https://developer.clickup.com/reference/getgoals.md): View the Goals available in a Workspace. - [Update Goal](https://developer.clickup.com/reference/updategoal.md): Rename a Goal, set the due date, replace the description, add or remove owners, and set the Goal color. - [Add Guest To Folder](https://developer.clickup.com/reference/addguesttofolder.md): Share a Folder with a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Add Guest To List](https://developer.clickup.com/reference/addguesttolist.md): Share a List with a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Add Guest To Task](https://developer.clickup.com/reference/addguesttotask.md): Share a task with a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Edit Guest On Workspace](https://developer.clickup.com/reference/editguestonworkspace.md): Configure options for a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Get Guest](https://developer.clickup.com/reference/getguest.md): View information about a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Invite Guest To Workspace](https://developer.clickup.com/reference/inviteguesttoworkspace.md): Invite a guest to join a Workspace. To invite a member to your Workspace, use the [Invite User to Workspace](ref:inviteusertoworkspace) endpoint. \ \ You'll also need to grant the guest access to specific items using the following endpoints: [Add Guest to Folder](ref:addguesttofolder), [Add Guest to List](ref:addguesttolist), or [Add Guest to Task](ref:addguesttotask). \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Remove Guest From Folder](https://developer.clickup.com/reference/removeguestfromfolder.md): Revoke a guest's access to a Folder. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Remove Guest From List](https://developer.clickup.com/reference/removeguestfromlist.md): Revoke a guest's access to a List.\ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Remove Guest From Task](https://developer.clickup.com/reference/removeguestfromtask.md): Revoke a guest's access to a task. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Remove Guest From Workspace](https://developer.clickup.com/reference/removeguestfromworkspace.md): Revoke a guest's access to a Workspace. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Add Task To List](https://developer.clickup.com/reference/addtasktolist.md): Add a task to an additional List. \ \ ***Note:** This endpoint requires the [Tasks in Multiple List ClickApp](https://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists) to be enabled.* - [Create Folderless List](https://developer.clickup.com/reference/createfolderlesslist.md): Add a new List in a Space. - [Create List From Template in Folder](https://developer.clickup.com/reference/createfolderlistfromtemplate.md): Create a new list using a list template in a Folder. Publicly shared templates must be [added to your Workspace](https://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 sub objects are created. In case of a timeout on synchronous requests, the objects from the template will continue to be created past the timeout. - [Create List](https://developer.clickup.com/reference/createlist.md): Add a new List to a Folder. - [Create List From Template in Space.](https://developer.clickup.com/reference/createspacelistfromtemplate.md): Create a new List using a List template within a Space. Publicly shared templates must be [added to your Workspace](https://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. - [Delete List](https://developer.clickup.com/reference/deletelist.md): Delete a List from your Workspace. - [Get Folderless Lists](https://developer.clickup.com/reference/getfolderlesslists.md): View the Lists in a Space that aren't located in a Folder. - [Get List](https://developer.clickup.com/reference/getlist.md): View information about a List. - [Get Lists](https://developer.clickup.com/reference/getlists.md): View the Lists within a Folder. - [Remove Task From List](https://developer.clickup.com/reference/removetaskfromlist.md): Remove 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 ClickApp](https://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists) to be enabled.* - [Update List](https://developer.clickup.com/reference/updatelist.md): Rename 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. - [Get List Members](https://developer.clickup.com/reference/getlistmembers.md): Get Workspace members who have explicit access to a List. Responses do not include people with access through a Team, or people with access from the Folder or Space where the List exists. - [Get Task Members](https://developer.clickup.com/reference/gettaskmembers.md): Get Workspace members who have explicit access to a task. Responses do not include people with access through a Team, or people with access from the List, Folder, or Space where the task exists. - [Get Custom Roles](https://developer.clickup.com/reference/getcustomroles.md): View the Custom Roles available in a Workspace. - [Shared Hierarchy](https://developer.clickup.com/reference/sharedhierarchy.md): View the tasks, Lists, and Folders that have been shared with the authenticated user. - [Create Space](https://developer.clickup.com/reference/createspace.md): Add a new Space to a Workspace. - [Delete Space](https://developer.clickup.com/reference/deletespace.md): Delete a Space from your Workspace. - [Get Space](https://developer.clickup.com/reference/getspace.md): View the Spaces available in a Workspace. - [Get Spaces](https://developer.clickup.com/reference/getspaces.md): View the Spaces avialable in a Workspace. You can only get member info in private Spaces. - [Update Space](https://developer.clickup.com/reference/updatespace.md): Rename, set the Space color, and enable ClickApps for a Space. - [Add Tag To Task](https://developer.clickup.com/reference/addtagtotask.md): Add a Tag to a task. - [Create Space Tag](https://developer.clickup.com/reference/createspacetag.md): Add a new task Tag to a Space. - [Delete Space Tag](https://developer.clickup.com/reference/deletespacetag.md): Delete a task Tag from a Space. - [Edit Space Tag](https://developer.clickup.com/reference/editspacetag.md): Update a task Tag. - [Get Space Tags](https://developer.clickup.com/reference/getspacetags.md): View the task Tags available in a Space. - [Remove Tag From Task](https://developer.clickup.com/reference/removetagfromtask.md): Remove a Tag from a task. This does not delete the Tag from the Space. - [Create Checklist](https://developer.clickup.com/reference/createchecklist.md): Add a new checklist to a task. - [Create Checklist Item](https://developer.clickup.com/reference/createchecklistitem.md): Add a line item to a task checklist. - [Delete Checklist](https://developer.clickup.com/reference/deletechecklist.md): Delete a checklist from a task. - [Delete Checklist Item](https://developer.clickup.com/reference/deletechecklistitem.md): Delete a line item from a task checklist. - [Edit Checklist](https://developer.clickup.com/reference/editchecklist.md): Rename a task checklist, or reorder a checklist so it appears above or below other checklists on a task. - [Edit Checklist Item](https://developer.clickup.com/reference/editchecklistitem.md): Update an individual line item in a task checklist. \ \ You can rename it, set the assignee, mark it as resolved, or nest it under another checklist item. - [Add Dependency](https://developer.clickup.com/reference/adddependency.md): Set a task as waiting on or blocking another task. - [Add Task Link](https://developer.clickup.com/reference/addtasklink.md): This 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. - [Delete Dependency](https://developer.clickup.com/reference/deletedependency.md): Remove the dependency relationship between two or more tasks. - [Delete Task Link](https://developer.clickup.com/reference/deletetasklink.md): Remove the link between two tasks. - [Create Task](https://developer.clickup.com/reference/createtask.md): Create a new task. - [Create Task From Template](https://developer.clickup.com/reference/createtaskfromtemplate.md): Create a new task using a task template defined in your workspace. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API. - [Delete Task](https://developer.clickup.com/reference/deletetask.md): Delete a task from your Workspace. - [Get Bulk Tasks' Time in Status](https://developer.clickup.com/reference/getbulktaskstimeinstatus.md): View 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. - [Get Filtered Team Tasks](https://developer.clickup.com/reference/getfilteredteamtasks.md): View 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 [Postman](https://www.postman.com/) to test our public API. - [Get Task](https://developer.clickup.com/reference/gettask.md): View 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. - [Get Tasks](https://developer.clickup.com/reference/gettasks.md): View 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 tasks with time entries. - [Get Task's Time in Status](https://developer.clickup.com/reference/gettaskstimeinstatus.md): View 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. - [Merge Tasks](https://developer.clickup.com/reference/mergetasks.md): Merge 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. - [Update Task](https://developer.clickup.com/reference/updatetask.md): Update a task by including one or more fields in the request body. - [Get Task Templates](https://developer.clickup.com/reference/gettasktemplates.md): View the task templates available in a Workspace. - [Delete time tracked](https://developer.clickup.com/reference/deletetimetracked.md): ***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.* - [Edit time tracked](https://developer.clickup.com/reference/edittimetracked.md): ***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.* - [Get tracked time](https://developer.clickup.com/reference/gettrackedtime.md): ***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.* - [Track time](https://developer.clickup.com/reference/tracktime.md): ***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.* - [Add tags from time entries](https://developer.clickup.com/reference/addtagsfromtimeentries.md): Add a label to a time entry. - [Change tag names from time entries](https://developer.clickup.com/reference/changetagnamesfromtimeentries.md): Rename an time entry label. - [Create a time entry](https://developer.clickup.com/reference/createatimeentry.md): Create a time entry. \ \ ***Note:** A time entry that has a negative duration means that timer is currently running for that user.* - [Delete a time Entry](https://developer.clickup.com/reference/deleteatimeentry.md): Delete a time entry from a Workspace. - [Get all tags from time entries](https://developer.clickup.com/reference/getalltagsfromtimeentries.md): View all the labels that have been applied to time entries in a Workspace. - [Get running time entry](https://developer.clickup.com/reference/getrunningtimeentry.md): View 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.* - [Get singular time entry](https://developer.clickup.com/reference/getsingulartimeentry.md): View a single time entry. \ \ ***Note:** A time entry that has a negative duration means that timer is currently running for that user.* - [Get time entries within a date range](https://developer.clickup.com/reference/gettimeentrieswithinadaterange.md): View 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.* - [Get time entry history](https://developer.clickup.com/reference/gettimeentryhistory.md): View a list of changes made to a time entry. - [Remove tags from time entries](https://developer.clickup.com/reference/removetagsfromtimeentries.md): Remove labels from time entries. This does not remove the label from a Workspace. - [Start a time Entry](https://developer.clickup.com/reference/startatimeentry.md): Start a timer for the authenticated user. - [Stop a time Entry](https://developer.clickup.com/reference/stopatimeentry.md): Stop a timer that's currently running for the authenticated user. - [Update a time Entry](https://developer.clickup.com/reference/updateatimeentry.md): Update the details of a time entry. - [Create Group](https://developer.clickup.com/reference/createusergroup.md): This endpoint creates a [User Group](https://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, increasing the number of paid guest seats.\ \ This change incurs a prorated charge based on the billing cycle. - [Delete Group](https://developer.clickup.com/reference/deleteteam.md): This endpoint is used to remove a [User Group](https://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. - [Get Groups](https://developer.clickup.com/reference/getteams1.md): This endpoint is used to view [User Groups](https://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. - [Update Group](https://developer.clickup.com/reference/updateteam.md): This endpoint is used to manage [User Groups](https://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 number of paid guest seats.\ \ This incurs a prorated charge based on your billing cycle. - [Edit User On Workspace](https://developer.clickup.com/reference/edituseronworkspace.md): Update a user's name and role. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Get User](https://developer.clickup.com/reference/getuser.md): View information about a user in a Workspace. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Invite User To Workspace](https://developer.clickup.com/reference/inviteusertoworkspace.md): Invite someone to join your Workspace as a member. To invite someone as a guest, use the [Invite Guest](ref:inviteguesttoworkspace) endpoint.\ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Remove User From Workspace](https://developer.clickup.com/reference/removeuserfromworkspace.md): Deactivate a user from a Workspace. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).* - [Create Folder View](https://developer.clickup.com/reference/createfolderview.md): Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Folder. - [Create List View](https://developer.clickup.com/reference/createlistview.md): Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a List. - [Create Space View](https://developer.clickup.com/reference/createspaceview.md): Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Space. - [Create Workspace (Everything level) View](https://developer.clickup.com/reference/createteamview.md): Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view at the Everything Level of a Workspace. - [Delete View](https://developer.clickup.com/reference/deleteview.md) - [Get Folder Views](https://developer.clickup.com/reference/getfolderviews.md): View the task and page views available for a Folder. - [Get List Views](https://developer.clickup.com/reference/getlistviews.md): View the task and page views available for a List.\ \ Views and required views are separate responses. - [Get Space Views](https://developer.clickup.com/reference/getspaceviews.md): View the task and page views available for a Space. - [Get Workspace (Everything level) Views](https://developer.clickup.com/reference/getteamviews.md): View the task and page views available at the Everything Level of a Workspace. - [Get View](https://developer.clickup.com/reference/getview.md): View information about a specific task or page view. The information returned about a view varies by the type of view. - [Get View Tasks](https://developer.clickup.com/reference/getviewtasks.md): See all visible tasks in a view in ClickUp. - [Update View](https://developer.clickup.com/reference/updateview.md): Rename a view, update the grouping, sorting, filters, columns, and settings of a view. - [Create Webhook](https://developer.clickup.com/reference/createwebhook.md): Set up a webhook to monitor for events.
We do not have a dedicated IP address for webhooks. We use our domain name and dynamic addressing. - [Delete Webhook](https://developer.clickup.com/reference/deletewebhook.md): Delete a webhook to stop monitoring the events and locations of the webhook. - [Get Webhooks](https://developer.clickup.com/reference/getwebhooks.md): View the webhooks created via the API for a Workspace. This endpoint returns webhooks created by the authenticated user. - [Update Webhook](https://developer.clickup.com/reference/updatewebhook.md): Update a webhook to change the events to be monitored. - [Get Authorized Workspaces](https://developer.clickup.com/reference/getauthorizedteams.md): View the Workspaces available to the authenticated user. - [Get Workspace Plan](https://developer.clickup.com/reference/getworkspaceplan.md): View the current [Plan](https://clickup.com/pricing) for the specified Workspace. - [Get Workspace seats](https://developer.clickup.com/reference/getworkspaceseats.md): View the used, total, and available member and guest seats for a Workspace. - [Update privacy and access of an object or location](https://developer.clickup.com/reference/publicpatchacl.md): Update the privacy and access settings of an object or location in the Workspace. Note that sharing an item may incur charges. - [Create Workspace-level audit logs](https://developer.clickup.com/reference/queryauditlog.md): Create Workspace-level audit logs. Audit logs can only be created by the Workspace owner on Enterprise Plans. - [Create a Channel](https://developer.clickup.com/reference/createchatchannel.md): This 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. - [Send a message](https://developer.clickup.com/reference/createchatmessage.md): This endpoint creates a top level message. - [Create a message reaction](https://developer.clickup.com/reference/createchatreaction.md): This endpoint creates a message reaction using lower case emoji names. - [Create a Direct Message](https://developer.clickup.com/reference/createdirectmessagechatchannel.md): This endpoint creates a new Direct Message between up to 15 users. If a Direct Message between those users already exists it returns it. - [Create a Channel on a Space, Folder, or List](https://developer.clickup.com/reference/createlocationchatchannel.md): This endpoint creates a Channel on a Space, Folder, or List. When a Channel already exists on the requested location, it returns it. - [Create a reply message](https://developer.clickup.com/reference/createreplymessage.md): This endpoint creates a reply message. - [Delete a Channel](https://developer.clickup.com/reference/deletechatchannel.md): This endpoint deletes a Channel. Applies to Channels tied to a Space, Folder, or List or not tied to locations. - [Delete a message](https://developer.clickup.com/reference/deletechatmessage.md): This endpoint deletes a message. - [Delete a message reaction](https://developer.clickup.com/reference/deletechatreaction.md): This endpoint deletes a message reaction. - [Retrieve a Channel](https://developer.clickup.com/reference/getchatchannel.md): This endpoint retrieves a specific Channel given its ID. - [Retrieve Channel followers](https://developer.clickup.com/reference/getchatchannelfollowers.md): This endpoint retrieves followers of a specific Channel given its ID. - [Retrieve Channel members](https://developer.clickup.com/reference/getchatchannelmembers.md): This endpoint retrieves members of a specific Channel given its ID. - [Retrieve Channels](https://developer.clickup.com/reference/getchatchannels.md): This endpoint retrieves the Channels in a Workspace. - [Retrieve message reactions](https://developer.clickup.com/reference/getchatmessagereactions.md): This endpoint retrieves the reactions to a message. - [Retrieve message replies](https://developer.clickup.com/reference/getchatmessagereplies.md): This endpoint retrieves the replies to a message. - [Retrieve Channel messages](https://developer.clickup.com/reference/getchatmessages.md): This endpoint retrieves messages for a specified Channel. - [Retrieve message tagged users](https://developer.clickup.com/reference/getchatmessagetaggedusers.md): This endpoint retrieves tagged users for a message. - [Get Post Subtype IDs](https://developer.clickup.com/reference/getsubtypes.md): Get the ID of each post subtype (Announcement, Discussion, Idea, and Update) for your Workspace, to use when [sending a message](https://developer.clickup.com/reference/createchatmessage) with `type: post`. \ \ Subtype IDs are unique to each Workspace. - [Update a message](https://developer.clickup.com/reference/patchchatmessage.md): This endpoint updates a message. - [Update a Channel](https://developer.clickup.com/reference/updatechatchannel.md): This endpoint updates a single Channel. - [Create a Doc](https://developer.clickup.com/reference/createdocpublic.md): Create a new Doc. - [Create a Page](https://developer.clickup.com/reference/createpagepublic.md): Create a page in a Doc. - [Edit a Page](https://developer.clickup.com/reference/editpagepublic.md): Edit a page in a Doc. - [Fetch PageListing for a Doc](https://developer.clickup.com/reference/getdocpagelistingpublic.md): View the PageListing for a Doc. - [Fetch Pages belonging to a Doc](https://developer.clickup.com/reference/getdocpagespublic.md): View the pages belonging to a Doc. - [Fetch a Doc](https://developer.clickup.com/reference/getdocpublic.md): View information about a Doc. - [Get page](https://developer.clickup.com/reference/getpagepublic.md): View 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/). - [Search for Docs](https://developer.clickup.com/reference/searchdocspublic.md): View the Docs in your Workspace. You can only view information of Docs you can access. - [Move a task to a new List](https://developer.clickup.com/reference/movetask.md): Move a task to a new List. For Tasks in Multiple Lists, this endpoint only moves the task to a new home List. [Learn more](doc:move-a-task-to-a-new-list) about the options available when moving a task to a new List. ## Pages - [Case Study: ZenPilot's Success in Leveraging the ClickUp API for Professional Services Efficiency and Profitability](https://developer.clickup.com/case-study-zenpilot.md)