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.

Share a List with a guest.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

Share a task with a guest.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

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 to be enabled.

Add a label to a time entry.

Rename an time entry label.

Create a time entry.

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

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.

This endpoint creates a top level message.

This endpoint creates a message reaction using lower case emoji names.

Add a new comment to a Chat view.

Add a new checklist to a task.

Add a line item to a task checklist.

This endpoint creates a new Direct Message between up to 10 users. If a Direct Message between those users already exists it returns it.

Create a new Doc.

Add a new Folder to a Space.

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. This request can be run asynchronously or synchronously via the return_immediately parameter.

Create a new list using a list template in a folder This request runs synchronously by default with return_immediately=true. The request returns the future List ID immediatly, but the List might not created at the time of the request returning. Small temmplates can be applied syncronously, which guarantees that all sub objects are created. In case of a timeout on syncronous requests, the of 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.

This endpoint creates a Channel and when a Channel already exists on the requested location, it returns it.

Create a page in a Doc.

This endpoint creates a reply message.

Add a new Space to a Workspace.

Create a new List using a List template within a Space. 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.

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.

Add a new comment to a task.

Create a new task using a task template.

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 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.
We do not have a dedicated IP address for webhooks. We use our domain name and dynamic addressing.

Create Workspace-level audit logs. Audit logs can only be created by the Workspace owner on Enterprise Plans.

This endpoint deletes a Channel. Applies to Channels tied to a Space, Folder, or List or not tied to locations.

This endpoint deletes a message.

This endpoint deletes a message reaction.

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

Use this tool to delete 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.

Rename and configure options for a guest.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

Update a Target.

Edit a page in a Doc.

Update a task Tag.

Update a user's name and role.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

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.

Applications utilizing a personal API token don't use this endpoint.

Note: OAuth tokens are not supported when using the Try It feature 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.

View the Workspaces available to the authenticated user.

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

This endpoint retrieves a specific Channel given its ID.

This endpoint retrieves followers of a specific Channel given its ID.

This endpoint retrieves members of a specific Channel given its ID.

This endpoint retrieves the Channels in a Workspace.

This endpoint retrieves reactions for a message

This endpoint retrieves replies to a message.

This endpoint retrieves tagged users for a message

This endpoint retrieves messages for a specified Channel.

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 information about a Doc.

View the PageListing for a Doc.

View pages belonging to a Doc.

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 to test our public API.

View the Lists within a Folder.

View the Custom Fields you have access to in a specific Folder. Get Folder Custom Fields only returns Custom Fields created at the Folder level. Custom Fields created at the List level are not included.

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.

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.

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 access to a List.

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

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.

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.

View task comments.

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 people who have access to a task. Responses do not include people with inherited Hierarchy permission to the task.

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.

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.

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

This endpoint is used to view 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.

View information about a user in a Workspace.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

View information about a specific task or page 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 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 endpoint.

You'll also need to grant the guest access to specific items using the following endpoints: Add Guest to Folder, Add Guest to List, or Add Guest to Task.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

Invite someone to join your Workspace as a member. To invite someone as a guest, use the Invite Guest endpoint.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

This endpoint updates a message.

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.

Revoke a guest's access to a List.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

Revoke a guest's access to a task.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

Revoke a guest's access to a Workspace.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

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 to be enabled.

Deactivate a user from a Workspace.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

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

View the Docs in your Workspace. You can only view information of Docs you can access.

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 or the Get Task endpoint to find the field_id.

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.

This endpoint updates a single Channel.

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.

Update the privacy and access settings of an object or location in the Workspace. Note that sharing an item may incur charges.

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