ClickUp

Set a task as waiting on or blocking another task.

Share a Folder with a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

Share a List with a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

Share a task with a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

Add a Tag to a task.

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.

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.*

Add a label to a time entry.

Rename an time entry label.

Add a new comment to a Chat view.

Add a new checklist to a task.

Add a line item to a task checklist.

Add a new Folder to a Space. You can optionally create the Folder as a subfolder within an existing Folder by providing `parent_folder_id` in the request body. Subfolder support must be enabled for the Workspace.

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. You can optionally create the Folder as a subfolder within an existing Folder by providing `parent_folder_id` in the request body. Subfolder support must be enabled for the Workspace. This request can be run asynchronously or synchronously via the `return_immediately` parameter.

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.

Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Folder.

Add a new List in a Space.

Add a new Goal to a Workspace.

Add a Target to a Goal.

Add a new List to a Folder.

Add a comment to a List.

Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a List.

Add a new Space to a Workspace.

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.

Add a new task Tag to a Space.

Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Space.

Create a new task.\ \ Custom Field values in the request body are only saved when the field is applicable to the task's `custom_item_id`. Use [Get Custom Fields](ref:getaccessiblecustomfields) and each field's `applied_objects` to determine applicability before creating the task.

Add a new comment to a task.

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.

Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view at the Everything Level of a Workspace.

Create a threaded comment.

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.

Set 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.

Create a time entry. \ \ ***Note:** A time entry that has a negative duration means that timer is currently running for that user.*

Delete a checklist from a task.

Delete a line item from a task checklist.

Delete a task comment.

Remove the dependency relationship between two or more tasks.

Delete a Folder from your Workspace.

Remove a Goal from your Workspace.

Delete a target from a Goal.

Delete a List from your Workspace.

Delete a Space from your Workspace.

Delete a task Tag from a Space.

Delete a task from your Workspace.

Remove the link between two tasks.

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.

Delete View

Delete a webhook to stop monitoring the events and locations of the webhook.

Delete a time entry from a Workspace.

***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*

Rename a task checklist, or reorder a checklist so it appears above or below other checklists on a task.

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.

Configure options for a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

Update a Target.

Update a task Tag.

Update a user's name and role. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*

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.*

View the Custom Fields you have access to in a specific List.\ \ Custom Fields scoped to specific custom task types include an `applied_objects` array on each field object. Each entry has `object_type` (`19` for custom task type) and `object_id` (the custom task type ID, matching `custom_item_id` on tasks). Use [Get Custom Task Types](ref:getcustomitems) to resolve IDs to names. Fields without task-type scoping omit `applied_objects`. Workspace-scoped Custom Fields are included when querying a List.

View the Workspaces available to the authenticated user.

View the details of the authenticated user's ClickUp account.

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.

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.

View the custom task types available in a Workspace.

View the Custom Roles available in a Workspace.

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. \ \ Each task's `custom_fields` array only includes Custom Fields applicable to that task's `custom_item_id`.\ \ 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.

View the Lists within a Folder. If the Folder is a subfolder, the response includes a `parent_folder` field with the parent Folder ID. Use the `include_subfolders` query parameter to include a `folders` array with child subfolder IDs in the response.

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.\ \ Custom Fields scoped to specific custom task types include an `applied_objects` array on each field object. Each entry has `object_type` (`19` for custom task type) and `object_id` (the custom task type ID, matching `custom_item_id` on tasks). Use [Get Custom Task Types](ref:getcustomitems) to resolve IDs to names. Fields without task-type scoping omit `applied_objects`. Workspace-scoped Custom Fields are included when querying a Folder.

View the Folder templates available in a Workspace. Use this endpoint to retrieve Folder template IDs for use with the [Create Folder From Template](#tag/Folders/operation/CreateFolderFromTemplate) endpoint. Template IDs are returned with a `t-` prefix (e.g., `t-7162342`). Pass the full ID including the prefix as the `template_id` path parameter when creating a Folder from a template.

View the task and page views available for a Folder.

View the Lists in a Space that aren't located in a Folder.

View the Folders in a Space. Folders that are subfolders include a `parent_folder` field with the parent Folder ID.

View the details of a Goal including its Targets.

View the Goals available in a Workspace.

View information about a guest. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

View information about a List.

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 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.

View the List templates available in a Workspace. Use this endpoint to retrieve List template IDs for use with the [Create List From Template in Folder](#tag/Lists/operation/CreateFolderListFromTemplate) and [Create List From Template in Space](#tag/Lists/operation/CreateSpaceListFromTemplate) endpoints. Template IDs are returned with a `t-` prefix (e.g., `t-15363293`). Pass the full ID including the prefix as the `template_id` path parameter when creating a List from a template.

View the task and page views available for a List.\ \ Views and required views are separate responses.

View the Lists within a Folder.

View the Spaces available in a Workspace.

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.\ \ Custom Fields scoped to specific custom task types include an `applied_objects` array on each field object. Each entry has `object_type` (`19` for custom task type) and `object_id` (the custom task type ID, matching `custom_item_id` on tasks). Use [Get Custom Task Types](ref:getcustomitems) to resolve IDs to names. Fields without task-type scoping omit `applied_objects`. Workspace-scoped Custom Fields are included when querying a Space.

View the task Tags available in a Space.

View the task and page views available for a Space.

View the Spaces avialable in a Workspace. You can only get member info in private Spaces.

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.\ \ The `custom_fields` array only includes Custom Fields applicable to the task's `custom_item_id`. Use [Get Custom Fields](ref:getaccessiblecustomfields) and each field's `applied_objects` to discover which fields apply to which task types.

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 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.

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.

View the task templates available in a Workspace.

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.\ \ Each task's `custom_fields` array only includes Custom Fields applicable to that task's `custom_item_id`.

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.\ \ Custom Fields scoped to specific custom task types include an `applied_objects` array on each field object. Each entry has `object_type` (`19` for custom task type) and `object_id` (the custom task type ID, matching `custom_item_id` on tasks). Use [Get Custom Task Types](ref:getcustomitems) to resolve IDs to names. Fields without task-type scoping omit `applied_objects`.

View the task and page views available at the Everything Level of a Workspace.

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.

View threaded comments. The parent comment is not included in the response.

View information about a user in a Workspace. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

View information about a specific task or page view. The information returned about a view varies by the type of view.

See all visible tasks in a view in ClickUp.

View the webhooks created via the API for a Workspace. This endpoint returns webhooks created by the authenticated user.

View the current [Plan](https://clickup.com/pricing) for the specified Workspace.

View the used, total, and available member and guest seats for a Workspace.

View all the labels that have been applied to time entries in a Workspace.

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.*

View a single time entry. \ \ ***Note:** A time entry that has a negative duration means that timer is currently running for that user.*

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.*

View a list of changes made to a time entry.

***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*

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).*

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).*

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.

Remove the data from a Custom Field on a task. This does not delete the option from the Custom Field.

Revoke a guest's access to a Folder. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

Revoke a guest's access to a List.\ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

Revoke a guest's access to a task. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

Revoke a guest's access to a Workspace. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

Remove a Tag from a task. This does not delete the Tag from the Space.

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.*

Deactivate a user from a Workspace. \ \ ***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*

Remove labels from time entries. This does not remove the label from a Workspace.

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. \ \ The Custom Field must be applicable to the task's current `custom_item_id`. Use [Get Custom Fields](ref:getaccessiblecustomfields) (check each field's `applied_objects`) or [Get Task](ref:gettask) to find applicable `field_id` values.\ \ Returns `400` if the field is not enabled for the task's custom task type.

View the tasks, Lists, and Folders that have been shared with the authenticated user.

Start a timer for the authenticated user.

Stop a timer that's currently running for the authenticated user.

***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*

Replace the content of a task commment, assign a comment, and mark a comment as resolved.

Rename a Folder.

Rename a Goal, set the due date, replace the description, add or remove owners, and set the Goal color.

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.

Rename, set the Space color, and enable ClickApps for a Space.

Update a task by including one or more fields in the request body.

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.

Rename a view, update the grouping, sorting, filters, columns, and settings of a view.

Update a webhook to change the events to be monitored.

Update the details of a time entry.