Skip to content
Changelog

Report a bug

ClickUp integration: operations for AI agents

ClickUp connects to Type.com as an integration. This page lists the 173 operations documented for Claude and Codex in Type.com: 66 read, 76 write, 31 destructive.

About ClickUp

ClickUp v2/v3 reference with explicit Type connection limits. The direct v2 Bearer preset accepts OAuth access tokens, not raw personal tokens; v3 requires a separate root-target managed connection. Multipart attachments are unsupported by current raw API requests.

Categories: Productivity & Project Management

How to connect ClickUp to Type.com

Connect
Managed Pipedream OAuth when enabled; direct OAuth access token with Bearer header at fixed /api/v2 base (personal pk_ tokens incompatible)
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

173 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

173 operations listed.

Attachments

  • Read

    Get Attachments

    Return a list of attachments for the specified entity, including a task or File type Custom Field.

    GET /api/v3/workspaces/{workspace_id}/{entity_type}/{entity_id}/attachments

  • Write

    Create Task Attachment

    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.* ***Tip:** Try our new V3 Attachments API, which supports both tasks and File type Custom Fields!*

    POST /api/v2/task/{task_id}/attachment

  • Write

    Create an Attachment

    Upload an attachment to a task or to a file type Custom Field. Once a file has been uploaded to a `custom_fields` entity, use Set Custom Field Value to associate the uploaded file with a task. To retrieve the ID of a Custom Field, you can use Get List Custom Fields or Get task.

    POST /api/v3/workspaces/{workspace_id}/{entity_type}/{entity_id}/attachments

Authorization

  • Read

    Get Authorized User

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

    GET /api/v2/user

  • Write

    Get Access Token

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

    POST /api/v2/oauth/token

Workspaces

  • Read

    Get Authorized Workspaces

    View the Workspaces available to the authenticated user.

    GET /api/v2/team

  • Read

    Get Workspace seats

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

    GET /api/v2/team/{team_id}/seats

  • Read

    Get Workspace Plan

    View the current Plan for the specified Workspace.

    GET /api/v2/team/{team_id}/plan

Task Checklists

  • Write

    Create Checklist

    Add a new checklist to a task.

    POST /api/v2/task/{task_id}/checklist

  • Write

    Edit Checklist

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

    PUT /api/v2/checklist/{checklist_id}

  • Write

    Create Checklist Item

    Add a line item to a task checklist.

    POST /api/v2/checklist/{checklist_id}/checklist_item

  • Write

    Edit Checklist Item

    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.

    PUT /api/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}

  • Destructive

    Delete Checklist

    Delete a checklist from a task.

    DELETE /api/v2/checklist/{checklist_id}

  • Destructive

    Delete Checklist Item

    Delete a line item from a task checklist.

    DELETE /api/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}

Comments

  • Read

    Get Task Comments

    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: 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 /api/v2/task/{task_id}/comment

  • Read

    Get Chat View Comments

    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 /api/v2/view/{view_id}/comment

  • Read

    Get List Comments

    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 /api/v2/list/{list_id}/comment

  • Read

    Get Threaded Comments

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

    GET /api/v2/comment/{comment_id}/reply

  • Read

    Get Post Subtype IDs

    Get the ID of each post subtype (Announcement, Discussion, Idea, and Update) for your Workspace, to use when sending a message with `type: post`. Subtype IDs are unique to each Workspace.

    GET /api/v3/workspaces/{workspace_id}/comments/types/{comment_type}/subtypes

  • Write

    Create Task Comment

    Add a new comment to a task.

    POST /api/v2/task/{task_id}/comment

  • Write

    Create Chat View Comment

    Add a new comment to a Chat view.

    POST /api/v2/view/{view_id}/comment

  • Write

    Create List Comment

    Add a comment to a List.

    POST /api/v2/list/{list_id}/comment

  • Write

    Update Comment

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

    PUT /api/v2/comment/{comment_id}

  • Write

    Create Threaded Comment

    Create a threaded comment.

    POST /api/v2/comment/{comment_id}/reply

  • Destructive

    Delete Comment

    Delete a task comment.

    DELETE /api/v2/comment/{comment_id}

Custom Fields

  • Read

    Get List Custom Fields

    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 to resolve IDs to names. Fields without task-type scoping omit `applied_objects`. Workspace-scoped Custom Fields are included when querying a List.

    GET /api/v2/list/{list_id}/field

  • Read

    Get Folder Custom Fields

    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 to resolve IDs to names. Fields without task-type scoping omit `applied_objects`. Workspace-scoped Custom Fields are included when querying a Folder.

    GET /api/v2/folder/{folder_id}/field

  • Read

    Get Space Custom Fields

    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 to resolve IDs to names. Fields without task-type scoping omit `applied_objects`. Workspace-scoped Custom Fields are included when querying a Space.

    GET /api/v2/space/{space_id}/field

  • Read

    Get Workspace Custom Fields

    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 to resolve IDs to names. Fields without task-type scoping omit `applied_objects`.

    GET /api/v2/team/{team_id}/field

  • Write

    Set Custom Field Value

    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 (check each field's `applied_objects`) or Get Task to find applicable `field_id` values. Returns `400` if the field is not enabled for the task's custom task type.

    POST /api/v2/task/{task_id}/field/{field_id}

  • Destructive

    Remove Custom Field Value

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

    DELETE /api/v2/task/{task_id}/field/{field_id}

Task Relationships

  • Write

    Add Dependency

    Set a task as waiting on or blocking another task.

    POST /api/v2/task/{task_id}/dependency

  • Destructive

    Delete Dependency

    Remove the dependency relationship between two or more tasks.

    DELETE /api/v2/task/{task_id}/dependency

Folders

  • Read

    Get Folders

    View the Folders in a Space. Subfolders are returned in the same flat list as top-level Folders, each with a `parent_folder` field holding the ID of the Folder it is nested inside of. This endpoint does not nest them; to get a Folder's subfolder tree, use Get Folder with `include_subfolders=true`.

    GET /api/v2/space/{space_id}/folder

  • Read

    Get Folder

    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 in the response. Each entry is a complete Folder object with the same fields as the Folder you requested, including its own `folders` array, so the response contains the whole subfolder tree down to the Workspace's subfolder nesting limit. Subfolders the requesting user cannot access are excluded.

    GET /api/v2/folder/{folder_id}

  • Write

    Create Folder

    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.

    POST /api/v2/space/{space_id}/folder

  • Write

    Update Folder

    Rename a Folder. Renaming a subfolder leaves it nested inside its parent Folder, and the response includes the `parent_folder` field. This endpoint only renames a Folder. To nest a Folder inside another Folder or move it to another Space, use the Move Folder endpoint; a `parent_folder_id` sent to this endpoint is ignored.

    PUT /api/v2/folder/{folder_id}

  • Write

    Move Folder

    Move a Folder, either by nesting it inside another Folder as a subfolder or by moving it to another Space as a top-level Folder. Provide `parent_folder_id` to nest the Folder inside another Folder, or `space_id` to move it to another Space as a top-level Folder. If both are provided, `parent_folder_id` takes precedence and `space_id` is ignored, so the Folder inherits the Space of its new parent Folder. Use `position` to control placement among siblings in the destination; the Folder is placed at the top when `position` is omitted. Nesting a Folder requires subfolder support to be enabled for the Workspace. Lists and tasks in the Folder move with it. To rename a Folder instead, use the Update Folder endpoint.

    PUT /api/v2/folder/{folder_id}/position

  • Write

    Create Folder from template

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

    POST /api/v2/space/{space_id}/folder_template/{template_id}

  • Destructive

    Delete Folder

    Delete a Folder from your Workspace.

    DELETE /api/v2/folder/{folder_id}

Goals

  • Read

    Get Goals

    View the Goals available in a Workspace.

    GET /api/v2/team/{team_id}/goal

  • Read

    Get Goal

    View the details of a Goal including its Targets.

    GET /api/v2/goal/{goal_id}

  • Write

    Create Goal

    Add a new Goal to a Workspace.

    POST /api/v2/team/{team_id}/goal

  • Write

    Update Goal

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

    PUT /api/v2/goal/{goal_id}

  • Write

    Create Key Result

    Add a Target to a Goal.

    POST /api/v2/goal/{goal_id}/key_result

  • Write

    Edit Key Result

    Update a Target.

    PUT /api/v2/key_result/{key_result_id}

  • Destructive

    Delete Goal

    Remove a Goal from your Workspace.

    DELETE /api/v2/goal/{goal_id}

  • Destructive

    Delete Key Result

    Delete a target from a Goal.

    DELETE /api/v2/key_result/{key_result_id}

Guests

  • Read

    Get Guest

    View information about a guest. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    GET /api/v2/team/{team_id}/guest/{guest_id}

  • Write

    Invite Guest To Workspace

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

    POST /api/v2/team/{team_id}/guest

  • Write

    Edit Guest On Workspace

    Configure options for a guest. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    PUT /api/v2/team/{team_id}/guest/{guest_id}

  • Write

    Add Guest To Task

    Share a task with a guest. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    POST /api/v2/task/{task_id}/guest/{guest_id}

  • Write

    Add Guest To List

    Share a List with a guest. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    POST /api/v2/list/{list_id}/guest/{guest_id}

  • Write

    Add Guest To Folder

    Share a Folder with a guest. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    POST /api/v2/folder/{folder_id}/guest/{guest_id}

  • Destructive

    Remove Guest From Workspace

    Revoke a guest's access to a Workspace. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    DELETE /api/v2/team/{team_id}/guest/{guest_id}

  • Destructive

    Remove Guest From Task

    Revoke a guest's access to a task. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    DELETE /api/v2/task/{task_id}/guest/{guest_id}

  • Destructive

    Remove Guest From List

    Revoke a guest's access to a List. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    DELETE /api/v2/list/{list_id}/guest/{guest_id}

  • Destructive

    Remove Guest From Folder

    Revoke a guest's access to a Folder. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    DELETE /api/v2/folder/{folder_id}/guest/{guest_id}

Lists

  • Read

    Get Lists

    View the Lists within a Folder.

    GET /api/v2/folder/{folder_id}/list

  • Read

    Get Folderless Lists

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

    GET /api/v2/space/{space_id}/list

  • Read

    Get List

    View information about a List.

    GET /api/v2/list/{list_id}

  • Write

    Create List

    Add a new List to a Folder.

    POST /api/v2/folder/{folder_id}/list

  • Write

    Create Folderless List

    Add a new List in a Space.

    POST /api/v2/space/{space_id}/list

  • Write

    Update List

    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.

    PUT /api/v2/list/{list_id}

  • Write

    Add Task To List

    Add a task to an additional List. ***Note:** This endpoint requires the Tasks in Multiple List ClickApp to be enabled.*

    POST /api/v2/list/{list_id}/task/{task_id}

  • Write

    Create List From Template in Folder

    Create a new list using a list template in a Folder. Publicly shared templates must be added to your Workspace 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.

    POST /api/v2/folder/{folder_id}/list_template/{template_id}

  • Write

    Create List From Template in Space

    Create a new List using a List template within a Space. Publicly shared templates must be added to your Workspace before you can use them with the public API. This request can be run asynchronously or synchronously via the `return_immediately` parameter.

    POST /api/v2/space/{space_id}/list_template/{template_id}

  • Destructive

    Delete List

    Delete a List from your Workspace.

    DELETE /api/v2/list/{list_id}

  • Destructive

    Remove Task From List

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

    DELETE /api/v2/list/{list_id}/task/{task_id}

Members

  • Read

    Get Task Members

    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 /api/v2/task/{task_id}/member

  • Read

    Get List Members

    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 /api/v2/list/{list_id}/member

Roles

  • Read

    Get Custom Roles

    View the Custom Roles available in a Workspace.

    GET /api/v2/team/{team_id}/customroles

Shared Hierarchy

  • Read

    Shared Hierarchy

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

    GET /api/v2/team/{team_id}/shared

Spaces

  • Read

    Get Spaces

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

    GET /api/v2/team/{team_id}/space

  • Read

    Get Space

    View the Spaces available in a Workspace.

    GET /api/v2/space/{space_id}

  • Write

    Create Space

    Add a new Space to a Workspace.

    POST /api/v2/team/{team_id}/space

  • Write

    Update Space

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

    PUT /api/v2/space/{space_id}

  • Destructive

    Delete Space

    Delete a Space from your Workspace.

    DELETE /api/v2/space/{space_id}

Tags

  • Read

    Get Space Tags

    View the task Tags available in a Space.

    GET /api/v2/space/{space_id}/tag

  • Write

    Create Space Tag

    Add a new task Tag to a Space.

    POST /api/v2/space/{space_id}/tag

  • Write

    Edit Space Tag

    Update a task Tag.

    PUT /api/v2/space/{space_id}/tag/{tag_name}

  • Write

    Add Tag To Task

    Add a Tag to a task.

    POST /api/v2/task/{task_id}/tag/{tag_name}

  • Destructive

    Delete Space Tag

    Delete a task Tag from a Space.

    DELETE /api/v2/space/{space_id}/tag/{tag_name}

  • Destructive

    Remove Tag From Task

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

    DELETE /api/v2/task/{task_id}/tag/{tag_name}

Tasks

  • Read

    Get Tasks

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

    GET /api/v2/list/{list_id}/task

  • Read

    Get Task

    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 and each field's `applied_objects` to discover which fields apply to which task types.

    GET /api/v2/task/{task_id}

  • Read

    Get Filtered Team Tasks

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

    GET /api/v2/team/{team_Id}/task

  • Read

    Get Task's Time in Status

    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.

    GET /api/v2/task/{task_id}/time_in_status

  • Read

    Get Bulk Tasks' Time in Status

    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 /api/v2/task/bulk_time_in_status/task_ids

  • Write

    Create Task

    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 and each field's `applied_objects` to determine applicability before creating the task.

    POST /api/v2/list/{list_id}/task

  • Write

    Update Task

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

    PUT /api/v2/task/{task_id}

  • Write

    Create Task From Template

    Create a new task using a task template defined in your workspace. Publicly shared templates must be added to your Workspace before you can use them with the public API.

    POST /api/v2/list/{list_id}/taskTemplate/{template_id}

  • Write

    Move a task to a new List

    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 about the options available when moving a task to a new List.

    PUT /api/v3/workspaces/{workspace_id}/tasks/{task_id}/home_list/{list_id}

  • Write

    Update task time estimates by user

    Replace the time estimates on a task for specified assignees. Assignees must be currently assigned to the task, or use `assignee: unassigned` to set a time estimates for unassigned work. You can set up to 10 estimates per request. ***Note:** This endpoint is only available on our Business Plan or above.*

    PATCH /api/v3/workspaces/{workspace_id}/tasks/{task_id}/time_estimates_by_user

  • Destructive

    Delete Task

    Delete a task from your Workspace.

    DELETE /api/v2/task/{task_id}

  • Destructive

    Merge Tasks

    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.

    POST /api/v2/task/{task_id}/merge

  • Destructive

    Replace task time estimates

    Replaces all time estimates for a task with the provided time estimates. Any existing time estimates not included in the request will be removed. Assignees must be currently assigned to the task, or use `assignee: unassigned` to set a time estimates for unassigned work. You can set up to 10 estimates per request. ***Note:** This endpoint is only available on our Business Plan or above.*

    PUT /api/v3/workspaces/{workspace_id}/tasks/{task_id}/time_estimates_by_user

Templates

  • Read

    Get Task Templates

    View the task templates available in a Workspace.

    GET /api/v2/team/{team_id}/taskTemplate

  • Read

    Get List Templates

    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 and Create List From Template in Space 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.

    GET /api/v2/team/{team_id}/list_template

  • Read

    Get Folder Templates

    View the Folder templates available in a Workspace. Use this endpoint to retrieve Folder template IDs for use with the Create Folder From Template 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.

    GET /api/v2/team/{team_id}/folder_template

User Groups

  • Read

    Get Groups

    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.

    GET /api/v2/group

  • Write

    Create Group

    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.

    POST /api/v2/team/{team_id}/group

  • Write

    Update Group

    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.

    PUT /api/v2/group/{group_id}

  • Destructive

    Delete Group

    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.

    DELETE /api/v2/group/{group_id}

Custom Task Types

  • Read

    Get Custom Task Types

    View the custom task types available in a Workspace.

    GET /api/v2/team/{team_id}/custom_item

Time Tracking (Legacy)

  • Read

    Get tracked time

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

    GET /api/v2/task/{task_id}/time

  • Write

    Track time

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

    POST /api/v2/task/{task_id}/time

  • Write

    Edit time tracked

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

    PUT /api/v2/task/{task_id}/time/{interval_id}

  • Destructive

    Delete time tracked

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

    DELETE /api/v2/task/{task_id}/time/{interval_id}

Time Tracking

  • Read

    Get time entries within a date range

    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 /api/v2/team/{team_Id}/time_entries

  • Read

    Get singular time entry

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

    GET /api/v2/team/{team_id}/time_entries/{timer_id}

  • Read

    Get time entry history

    View a list of changes made to a time entry.

    GET /api/v2/team/{team_id}/time_entries/{timer_id}/history

  • Read

    Get running time entry

    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 /api/v2/team/{team_id}/time_entries/current

  • Read

    Get all tags from time entries

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

    GET /api/v2/team/{team_id}/time_entries/tags

  • Write

    Create a time entry

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

    POST /api/v2/team/{team_Id}/time_entries

  • Write

    Update a time Entry

    Update the details of a time entry.

    PUT /api/v2/team/{team_id}/time_entries/{timer_id}

  • Write

    Add tags from time entries

    Add a label to a time entry.

    POST /api/v2/team/{team_id}/time_entries/tags

  • Write

    Change tag names from time entries

    Rename an time entry label.

    PUT /api/v2/team/{team_id}/time_entries/tags

  • Write

    Start a time Entry

    Start a timer for the authenticated user.

    POST /api/v2/team/{team_Id}/time_entries/start

  • Write

    Stop a time Entry

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

    POST /api/v2/team/{team_id}/time_entries/stop

  • Destructive

    Delete a time Entry

    Delete a time entry from a Workspace.

    DELETE /api/v2/team/{team_id}/time_entries/{timer_id}

  • Destructive

    Remove tags from time entries

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

    DELETE /api/v2/team/{team_id}/time_entries/tags

Users

  • Read

    Get User

    View information about a user in a Workspace. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    GET /api/v2/team/{team_id}/user/{user_id}

  • Write

    Invite User To Workspace

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

    POST /api/v2/team/{team_id}/user

  • Write

    Edit User On Workspace

    Update a user's name and role. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    PUT /api/v2/team/{team_id}/user/{user_id}

  • Destructive

    Remove User From Workspace

    Deactivate a user from a Workspace. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    DELETE /api/v2/team/{team_id}/user/{user_id}

Views

  • Read

    Get Workspace (Everything level) Views

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

    GET /api/v2/team/{team_id}/view

  • Read

    Get Space Views

    View the task and page views available for a Space.

    GET /api/v2/space/{space_id}/view

  • Read

    Get Folder Views

    View the task and page views available for a Folder.

    GET /api/v2/folder/{folder_id}/view

  • Read

    Get List Views

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

    GET /api/v2/list/{list_id}/view

  • Read

    Get View

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

    GET /api/v2/view/{view_id}

  • Read

    Get View Tasks

    See all visible tasks in a view in ClickUp.

    GET /api/v2/view/{view_id}/task

  • Write

    Create Workspace (Everything level) View

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

    POST /api/v2/team/{team_id}/view

  • Write

    Create Space View

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

    POST /api/v2/space/{space_id}/view

  • Write

    Create Folder View

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

    POST /api/v2/folder/{folder_id}/view

  • Write

    Create List View

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

    POST /api/v2/list/{list_id}/view

  • Write

    Update View

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

    PUT /api/v2/view/{view_id}

  • Destructive

    Delete View

    Delete View.

    DELETE /api/v2/view/{view_id}

Webhooks

  • Read

    Get Webhooks

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

    GET /api/v2/team/{team_id}/webhook

  • Write

    Create Webhook

    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.

    POST /api/v2/team/{team_id}/webhook

  • Write

    Update Webhook

    Update a webhook to change the events to be monitored.

    PUT /api/v2/webhook/{webhook_id}

  • Destructive

    Delete Webhook

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

    DELETE /api/v2/webhook/{webhook_id}

Chat

  • Read

    Retrieve Channels

    This endpoint retrieves the Channels in a Workspace.

    GET /api/v3/workspaces/{workspace_id}/chat/channels

  • Read

    Retrieve a Channel

    This endpoint retrieves a specific Channel given its ID.

    GET /api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}

  • Read

    Retrieve Channel followers

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

    GET /api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/followers

  • Read

    Retrieve Channel members

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

    GET /api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/members

  • Read

    Retrieve Channel messages

    This endpoint retrieves messages for a specified Channel.

    GET /api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/messages

  • Read

    Retrieve message reactions

    This endpoint retrieves the reactions to a message.

    GET /api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions

  • Read

    Retrieve message replies

    This endpoint retrieves the replies to a message.

    GET /api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/replies

  • Read

    Retrieve message tagged users

    This endpoint retrieves tagged users for a message.

    GET /api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/tagged_users

  • Write

    Create a Channel

    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.

    POST /api/v3/workspaces/{workspace_id}/chat/channels

  • Write

    Create a Channel on a Space, Folder, or List

    This endpoint creates a Channel on a Space, Folder, or List. When a Channel already exists on the requested location, it returns it.

    POST /api/v3/workspaces/{workspace_id}/chat/channels/location

  • Write

    Create a Direct Message

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

    POST /api/v3/workspaces/{workspace_id}/chat/channels/direct_message

  • Write

    Update a Channel

    This endpoint updates a single Channel.

    PATCH /api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}

  • Write

    Send a message

    This endpoint creates a top level message.

    POST /api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/messages

  • Write

    Update a message

    This endpoint updates a message.

    PATCH /api/v3/workspaces/{workspace_id}/chat/messages/{message_id}

  • Write

    Create a message reaction

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

    POST /api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions

  • Write

    Create a reply message

    This endpoint creates a reply message.

    POST /api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/replies

  • Destructive

    Delete a Channel

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

    DELETE /api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}

  • Destructive

    Delete a message

    This endpoint deletes a message.

    DELETE /api/v3/workspaces/{workspace_id}/chat/messages/{message_id}

  • Destructive

    Delete a message reaction

    This endpoint deletes a message reaction.

    DELETE /api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions/{reaction}

Acls

  • Write

    Update privacy and access of an object or location

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

    PATCH /api/v3/workspaces/{workspace_id}/{object_type}/{object_id}/acls

Auditlogs

  • Write

    Create Workspace-level audit logs

    Create Workspace-level audit logs. Only the Workspace owner can create audit logs. ***Note:** This endpoint is only available to Workspaces on our Enterprise Plan.*

    POST /api/v3/workspaces/{workspace_id}/auditlogs

Docs

  • Read

    Search for Docs

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

    GET /api/v3/workspaces/{workspace_id}/docs

  • Read

    Fetch a Doc

    View information about a Doc.

    GET /api/v3/workspaces/{workspace_id}/docs/{doc_id}

  • Read

    Fetch PageListing for a Doc

    View the PageListing for a Doc.

    GET /api/v3/workspaces/{workspace_id}/docs/{doc_id}/page_listing

  • Read

    Fetch Pages belonging to a Doc

    View the pages belonging to a Doc.

    GET /api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages

  • Read

    Get page

    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.

    GET /api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages/{page_id}

  • Write

    Create a Doc

    Create a new Doc.

    POST /api/v3/workspaces/{workspace_id}/docs

  • Write

    Create a Page

    Create a page in a Doc.

    POST /api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages

  • Write

    Edit a Page

    Edit a page in a Doc.

    PUT /api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages/{page_id}

Get started

  1. Open Space settings → Connections and search for ClickUp.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.