ClickUp

Overview

ClickUp is an all-in-one productivity platform that unifies tasks, docs, goals, and chat in a single place, allowing teams to plan, organize, and collaborate across projects with customizable workflows. With the ClickUp integration in SquadOS, your agents can create tasks, update statuses, query lists, log time, and manipulate documents directly via API, without leaving the automated workflow.

Official website: https://clickup.com/
Composio documentation: docs.composio.dev/toolkits/clickup

Authentication

This tool supports OAuth 2.0 (OAUTH2) and API key (API_KEY) for connecting.

With OAuth 2.0, access is authorized directly from your ClickUp account — no manual key required.

For API key authentication, you will need the following fields:

Field	Required	Description
`api_key`	Yes	Personal API key generated in the ClickUp dashboard under Settings → Apps.

How to get credentials

The steps below apply to API key authentication. If you prefer OAuth 2.0, skip to the “How to connect in SquadOS” section.

Log in to app.clickup.com.
Click on the user avatar in the bottom-left corner and go to Settings.
In the sidebar, go to Apps.
Under the API Key section, click Generate (or copy the key already shown).
Copy the value — this is the api_key to enter when connecting in SquadOS.

How to connect in SquadOS

Go to Tools in the side menu (/admin/tools).
Open the Available tab and search for ClickUp.
Click the card to open the details modal and hit Connect.
You’re taken to the secure connection page hosted by Composio, where you authorize access via OAuth 2.0 or enter the API key obtained above.
Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)

Available actions

Create a task

CLICKUP_CREATE_TASK

Creates a new ClickUp task in a specific list, optionally as a subtask if a parent task ID is provided (the parent cannot be a subtask itself and must be in the same list).

Input parameters

Name	Type	Required	Description
`list_id`	string	Yes	The ID of the list where the task will be created.
`name`	string	Yes	The name of the new task.
`description`	string	No	Task’s detailed description.
`status`	string	No	Status name for the task. Each ClickUp list has its own unique status configuration — use the exact status name (case-sensitive) configured in the target list. If omitted, uses the list’s default status.
`priority`	integer	No	Priority level: 1 (Urgent), 2 (High), 3 (Normal), 4 (Low).
`due_date`	integer	No	Due date as a Unix timestamp in milliseconds.
`assignees`	array	No	User IDs to assign to the task.
`tags`	array	No	Tag names to apply.
`parent`	string	No	ID of an existing task to be the parent (creating a subtask). Parent must not be a subtask and must be in the same list.
`team_id`	string	No	Team ID, required only if `custom_task_ids` is true.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Get task

CLICKUP_GET_TASK

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

Input parameters

Name	Type	Required	Description
`task_id`	string	Yes	The unique identifier of the task to retrieve.
`include_subtasks`	boolean	No	Set to true to include subtasks in the task details response.
`include_markdown_description`	boolean	No	Set to true to return the task description in Markdown format.
`custom_task_ids`	boolean	No	Set to true if the task_id is a custom task ID — requires `team_id`.
`team_id`	integer	No	The ID of the team — required when `custom_task_ids` is true.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Get tasks

CLICKUP_GET_TASKS

Retrieves tasks from a specified ClickUp list; only tasks whose home is the given list_id are returned. Closed and archived tasks are excluded by default.

Input parameters

Name	Type	Required	Description
`list_id`	string	Yes	The ID of the list to retrieve tasks from. To find the list_id, copy the link to the list from the ClickUp UI; the list_id is the number following ‘/li’ in the URL.
`page`	integer	No	The page number of results to fetch, starting at 0. Each page can contain up to 100 tasks.
`statuses`	array	No	Filter tasks by their status. Values must match workspace configuration exactly (case-sensitive).
`assignees`	array	No	Filter tasks by assignee user IDs.
`tags`	array	No	Filter tasks by a list of tag names.
`order_by`	string	No	Field to order tasks by. Valid options: `id`, `created`, `updated`, `due_date`.
`include_closed`	boolean	No	Include tasks with a closed status. Closed tasks are excluded by default.
`subtasks`	boolean	No	Include subtasks in the results.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Update task

CLICKUP_UPDATE_TASK

Updates attributes of an existing task; team_id is required if custom_task_ids is true, use a single space (" ") for description to clear it, and provide at least one modifiable field.

Input parameters

Name	Type	Required	Description
`task_id`	string	Yes	Unique task identifier.
`name`	string	No	New task name.
`description`	string	No	New task description; use a single space to clear.
`status`	string	No	New task status (case-sensitive, must be valid in the workspace).
`priority`	integer	No	Priority: 1 (Urgent), 2 (High), 3 (Normal), 4 (Low).
`due_date`	integer	No	New due date (Unix timestamp in milliseconds).
`assignees__add`	array	No	List of user IDs to add as assignees.
`assignees__rem`	array	No	List of user IDs to remove as assignees.
`archived`	boolean	No	True to archive, false to unarchive.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Delete task

CLICKUP_DELETE_TASK

Permanently deletes a ClickUp task by its ID.

Input parameters

Name	Type	Required	Description
`task_id`	string	Yes	The unique identifier of the task to delete.
`custom_task_ids`	boolean	No	True if the task_id is a custom task ID — requires `team_id`.
`team_id`	string	No	Team ID, required when `custom_task_ids` is true.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Get filtered team tasks

CLICKUP_GET_FILTERED_TEAM_TASKS

Retrieves a paginated list of tasks (up to 100 per page) from a specified workspace based on various filter criteria, respecting user access permissions. Unexpectedly missing tasks may indicate permission restrictions rather than filter issues. No keyword/text search is supported; filter client-side on returned results.

Input parameters

Name	Type	Required	Description
`team_Id`	string	Yes	The Workspace ID (called ‘team_id’ in ClickUp API v2). This is a numeric string.
`page`	integer	No	Page to fetch (starts at 0). Increment until the response’s `last_page` field is true or the returned tasks list is empty.
`statuses`	array	No	Filter by task statuses. Values must exactly match workspace-configured status strings.
`assignees`	array	No	Filter by assignee User IDs. Must be numeric IDs.
`list_ids`	array	No	Filter by List IDs. Must be numeric IDs.
`space_ids`	array	No	Filter by Space IDs. Must be numeric IDs.
`project_ids`	array	No	Filter by Folder (Project) IDs. Must be numeric IDs.
`due_date_gt`	integer	No	Filter by due date greater than this Unix timestamp (milliseconds).
`due_date_lt`	integer	No	Filter by due date less than this Unix timestamp (milliseconds).
`include_closed`	boolean	No	If true, include closed tasks.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Create task comment

CLICKUP_CREATE_TASK_COMMENT

Adds a comment to a ClickUp task; team_id is required if custom_task_ids is true.

Input parameters

Name	Type	Required	Description
`task_id`	string	Yes	Unique task identifier for the comment.
`comment_text`	string	Yes	The text content for the comment. Supports ClickUp’s comment formatting (e.g., mentions, markdown).
`assignee`	integer	Yes	The user ID of the person to whom this specific comment should be assigned.
`notify_all`	boolean	Yes	If true, notifications for this comment will be sent to all users watching the task, including the creator.
`team_id`	string	No	Team ID, required if `custom_task_ids` is true.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Get task comments

CLICKUP_GET_TASK_COMMENTS

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

Input parameters

Name	Type	Required	Description
`task_id`	string	Yes	Unique identifier of the task.
`start`	integer	No	Unix timestamp (in milliseconds) of the oldest visible comment, used with `start_id` for pagination.
`start_id`	string	No	ID of the oldest visible comment, used with `start` for pagination.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Create list

CLICKUP_CREATE_LIST

Creates a new list within an existing ClickUp folder. To create a list directly in a Space (without a folder), use CLICKUP_CREATE_FOLDERLESS_LIST with space_id instead.

Input parameters

Name	Type	Required	Description
`folder_id`	string	Yes	The unique numerical identifier of the folder where the new list will be created.
`name`	string	Yes	The name to be assigned to the new list.
`content`	string	No	Optional descriptive content or notes for the list.
`assignee`	integer	No	Numerical user ID of the assignee.
`due_date`	integer	No	Due date for the list, as a POSIX timestamp in milliseconds.
`priority`	integer	No	Priority level: 1 (Urgent), 2 (High), 3 (Normal), 4 (Low).

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Create folderless list

CLICKUP_CREATE_FOLDERLESS_LIST

Creates a new folderless list (a list not part of any Folder) directly within a specified ClickUp Space.

Input parameters

Name	Type	Required	Description
`space_id`	string	Yes	Identifier of the Space for the new folderless list.
`name`	string	Yes	Name for the new folderless list.
`content`	string	No	Description for the list (plain text or markdown).
`due_date`	integer	No	Due date for the list (POSIX timestamp in milliseconds).
`priority`	integer	No	Priority level: 1 (Urgent), 2 (High), 3 (Normal), 4 (Low).

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Delete list

CLICKUP_DELETE_LIST

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

Input parameters

Name	Type	Required	Description
`list_id`	string	Yes	The unique numerical identifier of the List to be deleted.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Create folder

CLICKUP_CREATE_FOLDER

Creates a new ClickUp Folder within the specified Space, which must exist and be accessible.

Input parameters

Name	Type	Required	Description
`space_id`	string	Yes	Numerical ID of the Space in which to create the Folder.
`name`	string	Yes	The name of the Folder to be created.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Delete folder

CLICKUP_DELETE_FOLDER

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

Input parameters

Name	Type	Required	Description
`folder_id`	string	Yes	The unique numerical identifier of the folder to be deleted.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Create space

CLICKUP_CREATE_SPACE

Creates a new ClickUp Space within a specified Workspace, allowing feature configuration which defaults to Workspace settings if unspecified.

Input parameters

Name	Type	Required	Description
`team_id`	string	Yes	Numeric ID of the Workspace (Team) for the new Space.
`name`	string	Yes	Name for the new Space.
`multiple_assignees`	boolean	Yes	Enable/disable multiple assignees for tasks in this Space.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Get spaces

CLICKUP_GET_SPACES

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

Input parameters

Name	Type	Required	Description
`team_id`	string	Yes	Identifier for the Team (Workspace).
`archived`	boolean	No	Filter by archived status (`true` for archived, `false` for active).

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Create Doc

CLICKUP_CREATE_DOC

Tool to create a new ClickUp Doc in a Workspace (v3 Docs API) and return the new doc_id for follow-up page/content operations.

Input parameters

Name	Type	Required	Description
`workspace_id`	string	Yes	The workspace ID where the document will be created.
`name`	string	Yes	The name/title for the new document.
`parent_id`	string	No	Optional parent location ID (space, folder, or list ID) where the doc should be created. If omitted, the doc will be created at the workspace level.
`parent_type`	string	No	Type of parent location. Required if parent_id is provided. Must be `space`, `folder`, or `list`.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Get Doc Content

CLICKUP_GET_DOC_CONTENT

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

Input parameters

Name	Type	Required	Description
`workspace_id`	string	Yes	The numeric workspace ID containing the document.
`doc_id`	string	Yes	The unique ClickUp Doc ID in format `{alphanumeric_prefix}-{number}` (e.g., `2kz0k9bp-1376`). Numeric-only IDs are View IDs, not Doc IDs, and will fail.
`page_ids`	array	No	Optional list of specific page IDs to fetch. If omitted, all pages in the doc will be fetched.
`include_page_listing_only`	boolean	No	If true, only fetch the list of pages without their content.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Search Docs

CLICKUP_SEARCH_DOCS

Tool to search and list Docs metadata in a ClickUp workspace. Use after confirming the workspace ID to quickly locate relevant meeting notes before fetching pages.

Input parameters

Name	Type	Required	Description
`workspace_id`	string	Yes	ID of the ClickUp Workspace to list Docs from.
`limit`	integer	No	Maximum results per page. Default: 50, max: 100.
`cursor`	string	No	Cursor from previous response to fetch next page.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Create Doc Page

CLICKUP_CREATE_DOC_PAGE

Tool to create a page in a ClickUp Doc (v3 Docs API), either as a root page or as a sub-page under a parent page.

Input parameters

Name	Type	Required	Description
`doc_id`	string	Yes	The ID of the doc in format `{alphanumeric_prefix}-{number}`.
`workspace_id`	integer	Yes	The ID of the Workspace.
`name`	string	No	The name of the new page.
`content`	string	No	The content of the new page. Supports markdown or plain text.
`content_format`	string	No	The format the page content is in: `text/md` for markdown (default) or `text/plain`.
`parent_page_id`	string	No	The ID of the parent page. If provided, the new page will be created as a sub-page.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Update Doc Page

CLICKUP_CLICK_UP_UPDATE_DOC_PAGE

Tool to update/edit a ClickUp Doc page’s title and/or content via the v3 Docs API.

Input parameters

Name	Type	Required	Description
`workspace_id`	string	Yes	The workspace ID containing the document.
`doc_id`	string	Yes	The unique identifier for the document containing the page.
`page_id`	string	Yes	The unique identifier for the page to update.
`name`	string	No	The new title/name for the page. If not provided, the page name will not be changed.
`content`	string	No	The new content for the page in markdown format. If not provided, the page content will not be changed.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Set custom field value

CLICKUP_SET_CUSTOM_FIELD_VALUE

Sets or updates a Custom Field’s value for a task; the new value structure depends on field type.

Input parameters

Name	Type	Required	Description
`task_id`	string	Yes	Task ID to update. Standard ID, or Custom Task ID if `custom_task_ids` is true.
`field_id`	string	Yes	UUID of the Custom Field to update (must be in standard UUID format with hyphens).
`value`	string	Yes	The value to set for the Custom Field. Structure depends on field type: text as string, number as number, checkbox as boolean, dropdown as option UUID, date as Unix timestamp in milliseconds.
`value_options`	object	No	Optional settings for certain field types. For Date fields: `{'time': true}`. For Currency fields: `{'currency_type': 'USD'}`.
`team_id`	string	No	Team ID, required if `custom_task_ids` is true.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Start a time entry

CLICKUP_START_TIME_ENTRY

Starts a new time entry (timer) in the specified Team (Workspace), optionally associating it with a task, adding a description, setting billable status, or applying tags (tags feature requires Business Plan or higher).

Input parameters

Name	Type	Required	Description
`team_Id`	string	Yes	The Workspace ID (also called Team ID in ClickUp API) for this time entry. This goes in the URL path.
`tid`	string	No	The ID of the task to associate with this time entry.
`description`	string	No	Description for the time entry.
`billable`	boolean	No	Specifies if the time entry is billable.
`tags`	array	No	Array of tag objects (each with `name`, optionally `tag_bg`, `tag_fg` for colors). Requires Business Plan or higher.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Stop a time entry

CLICKUP_STOP_TIME_ENTRY

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

Input parameters

Name	Type	Required	Description
`team_id`	string	Yes	The unique numeric identifier of the Team (Workspace) where the time entry is being tracked.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Create a time entry

CLICKUP_CREATE_A_TIME_ENTRY

Creates a new time entry for a specified team.

Input parameters

Name	Type	Required	Description
`team_Id`	string	Yes	The Workspace ID (also called Team ID in ClickUp API) where the time entry will be added.
`start`	integer	Yes	The start time of the time entry, as a Unix timestamp in milliseconds.
`duration`	integer	Yes	The duration of the time entry in milliseconds. If `start` and `end`/`stop` are also provided, the API calculates duration from those values.
`tid`	string	No	The ID of the task to associate this time entry with.
`description`	string	No	An optional description for the time entry.
`billable`	boolean	No	Indicates whether the time entry is billable.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Create goal

CLICKUP_CREATE_GOAL

Creates a new goal in a ClickUp Team (Workspace).

Input parameters

Name	Type	Required	Description
`name`	string	Yes	Name for the new goal.
`team_id`	string	Yes	ID of the Workspace (Team) where the goal will be created.
`due_date`	integer	No	Due date as a Unix timestamp in milliseconds.
`description`	string	No	Description of the goal.
`multiple_owners`	boolean	No	If true, allows multiple owners for the goal.
`owners`	array	No	User IDs of the goal owners.
`color`	string	No	Goal color in hexadecimal.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Get authorized teams workspaces

CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES

Retrieves Workspaces (Teams) accessible to the authenticated user.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Get authorized user

CLICKUP_GET_AUTHORIZED_USER

Returns the information of the authenticated user in the ClickUp account.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Create task from template

CLICKUP_CREATE_TASK_FROM_TEMPLATE

Creates a new task in a specified ClickUp list from a task template, using the provided name for the new task.

Input parameters

Name	Type	Required	Description
`list_id`	string	Yes	Numeric ID of the ClickUp list for task creation.
`template_id`	string	Yes	Unique string ID of the task template to use.
`name`	string	Yes	Name for the new task created from the template.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Add tag to task

CLICKUP_ADD_TAG_TO_TASK

Adds an existing tag to a specified task; team_id is required if custom_task_ids is true.

Input parameters

Name	Type	Required	Description
`task_id`	string	Yes	The ID of the task to which the tag will be added.
`tag_name`	string	Yes	The name of the tag to add to the task. The tag must already exist in the workspace.
`team_id`	integer	No	The ID of the team — required only if `custom_task_ids` is true.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.

Invite user to workspace

CLICKUP_INVITE_USER_TO_WORKSPACE

Invites a user to a ClickUp Workspace by email address.

Input parameters

Name	Type	Required	Description
`team_id`	integer	Yes	ID of the Workspace to which the user will be invited.
`email`	string	Yes	Email address of the user to invite.
`admin`	boolean	No	If true, the user is invited as an administrator.

Output

Name	Type	Required	Description
`data`	string	Yes	Data from the action execution.
`error`	string	No	Error if any occurred during the execution of the action.
`successful`	boolean	Yes	Whether or not the action execution was successful.