Clickup

Learn how to use Clickup with Composio

Overview

Enum

CLICKUP

Description

ClickUp unifies tasks, docs, goals, and chat in a single platform, allowing teams to plan, organize, and collaborate across projects with customizable workflows

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string
api_key
stringRequired

Actions

Adds a 'waiting on' or 'blocking' dependency to a task, requiring either `depends on` (task becomes waiting on) or `dependency of` (task becomes blocking), but not both; `team id` is required if `custom task ids` is true.

Action Parameters

custom_task_ids
boolean
depedency_of
string
depends_on
string
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Adds a guest to a folder with specified permissions; requires a clickup enterprise plan.

Action Parameters

folder_id
integerRequired
guest_id
integerRequired
include_shared
boolean
permission_level
stringRequired

Action Response

data
object
error
successful
boolean
Shares a clickup list with an existing guest user, granting them specified permissions; requires the workspace to be on the clickup enterprise plan.

Action Parameters

guest_id
integerRequired
include_shared
boolean
list_id
integerRequired
permission_level
stringRequired

Action Response

data
object
error
successful
boolean
Assigns a guest to a task with specified permissions; requires clickup enterprise plan, and `team id` if `custom task ids` is true.

Action Parameters

custom_task_ids
boolean
guest_id
integerRequired
include_shared
boolean
permission_level
stringRequired
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Associates a list of specified tags with one or more time entries within a given team (workspace).

Action Parameters

tags
arrayRequired
team_id
integerRequired
time_entry_ids
arrayRequired

Action Response

data
object
error
successful
boolean
Adds an existing tag to a specified task; team id is required if custom task ids is true.

Action Parameters

custom_task_ids
boolean
tag_name
stringRequired
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Adds an existing task to an additional clickup list; the "tasks in multiple lists" clickapp must be enabled in the workspace for this.

Action Parameters

list_id
integerRequired
task_id
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `create task attachment` to upload a file to a task; requires `multipart/form-data`.

Action Parameters

attachment
array
custom_task_ids
boolean
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Deprecated: use `get access token` instead. exchanges a clickup oauth 2.0 authorization code for an access token.

Action Parameters

client_id
stringRequired
client_secret
stringRequired
code
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `get authorized teams workspaces` instead to retrieve workspaces (teams) accessible to the authenticated user.

Action Parameters

Action Response

data
object
error
successful
boolean
Deprecated: use `get authorized user` instead. retrieves details of the authenticated user's clickup account.

Action Parameters

Action Response

data
object
error
successful
boolean
Updates the name, background color, and/or foreground color for an existing time entry tag, identified by its current `name` and `team id`.

Action Parameters

name
stringRequired
new_name
stringRequired
tag_bg
stringRequired
tag_fg
stringRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Creates a new time entry for a specified team.

Action Parameters

assignee
integer
billable
boolean
custom_task_ids
boolean
description
string
duration
integerRequired
end
integer
start
integerRequired
stop
integer
tags
array
team_Id
integerRequired
team_id
integer
tid
string

Action Response

data
object
error
successful
boolean
Posts a new comment to a specified clickup chat view; the 'view id' must correspond to an existing and accessible chat view.

Action Parameters

comment_text
stringRequired
notify_all
booleanRequired
view_id
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new checklist with a specified name within an existing task, which can be identified by its standard id or a custom task id (if `custom task ids` is true, `team id` is also required).

Action Parameters

custom_task_ids
boolean
name
stringRequired
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Creates a new checklist item within a specified, existing checklist, optionally setting the item's name and assigning it to a user.

Action Parameters

assignee
integer
checklist_id
stringRequired
name
string

Action Response

data
object
error
successful
boolean
Creates a new clickup folder within the specified space, which must exist and be accessible.

Action Parameters

name
stringRequired
space_id
integerRequired

Action Response

data
object
error
successful
boolean
Creates a new folderless list (a list not part of any folder) directly within a specified clickup space.

Action Parameters

assignee
integer
content
string
due_date
integer
due_date_time
boolean
name
stringRequired
priority
integer
space_id
integerRequired
status
string

Action Response

data
object
error
successful
boolean
Creates a new, highly customizable view within a specific clickup folder using its `folder id`.

Action Parameters

columns__fields
array
divide__collapsed
boolean
divide__dir
null
divide__field
null
filters__fields
array
filters__op
string
filters__search
string
filters__show__closed
boolean
folder_id
integerRequired
grouping__collapsed
array
grouping__dir
integer
grouping__field
string
grouping__ignore
boolean
name
stringRequired
settings__collapse__empty__columns
string
settings__me__checklists
boolean
settings__me__comments
boolean
settings__me__subtasks
boolean
settings__show__assignees
boolean
settings__show__closed__subtasks
boolean
settings__show__images
boolean
settings__show__subtask__parent__names
boolean
settings__show__subtasks
integer
settings__show__task__locations
boolean
sorting__fields
array
team__sidebar__assigned__comments
boolean
team__sidebar__assignees
array
team__sidebar__unassigned__tasks
boolean
type
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new goal in a clickup team (workspace).

Action Parameters

color
stringRequired
description
stringRequired
due_date
integerRequired
multiple_owners
booleanRequired
name
stringRequired
owners
arrayRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Creates a new key result (target) for a specified goal in clickup to define and track measurable objectives towards achieving that goal.

Action Parameters

goal_id
stringRequired
list_ids
arrayRequired
name
stringRequired
owners
arrayRequired
steps_end
integerRequired
steps_start
integerRequired
task_ids
arrayRequired
type
stringRequired
unit
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new list in clickup within a specified, existing folder.

Action Parameters

assignee
integer
content
string
due_date
integer
due_date_time
boolean
folder_id
integerRequired
name
stringRequired
priority
integer
status
string

Action Response

data
object
error
successful
boolean
Adds a new comment with specific text to an existing and accessible clickup list, assigns it to a user, and sets notification preferences for all list members.

Action Parameters

assignee
integerRequired
comment_text
stringRequired
list_id
integerRequired
notify_all
booleanRequired

Action Response

data
object
error
successful
boolean
Creates a new, customizable view (e.g., list, board, calendar) within a specified clickup list, requiring an existing list id accessible by the user.

Action Parameters

columns__fields
array
divide__collapsed
boolean
divide__dir
null
divide__field
null
filters__fields
array
filters__op
string
filters__search
string
filters__show__closed
boolean
grouping__collapsed
array
grouping__dir
integer
grouping__field
string
grouping__ignore
boolean
list_id
integerRequired
name
stringRequired
settings__collapse__empty__columns
string
settings__me__checklists
boolean
settings__me__comments
boolean
settings__me__subtasks
boolean
settings__show__assignees
boolean
settings__show__closed__subtasks
boolean
settings__show__images
boolean
settings__show__subtask__parent__names
boolean
settings__show__subtasks
integer
settings__show__task__locations
boolean
sorting__fields
array
team__sidebar__assigned__comments
boolean
team__sidebar__assignees
array
team__sidebar__unassigned__tasks
boolean
type
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new space in a clickup team, with customizable name, privacy, color, and feature settings.

Action Parameters

color
string
features
object
multiple_assignees
booleanDefaults to True
name
stringRequired
private
boolean
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new tag (name, foreground color, background color) in an existing clickup space.

Action Parameters

space_id
integerRequired
tag__name
string
tag__tag__bg
string
tag__tag__fg
string

Action Response

data
object
error
successful
boolean
Creates a customizable view (e.g., list, board, gantt) within a specified clickup space, allowing configuration of grouping, sorting, filtering, and display settings.

Action Parameters

columns__fields
array
divide__collapsed
boolean
divide__dir
null
divide__field
null
filters__fields
array
filters__op
string
filters__search
string
filters__show__closed
boolean
grouping__collapsed
array
grouping__dir
integer
grouping__field
string
grouping__ignore
boolean
name
stringRequired
settings__collapse__empty__columns
string
settings__me__checklists
boolean
settings__me__comments
boolean
settings__me__subtasks
boolean
settings__show__assignees
boolean
settings__show__closed__subtasks
boolean
settings__show__images
boolean
settings__show__subtask__parent__names
boolean
settings__show__subtasks
integer
settings__show__task__locations
boolean
sorting__fields
array
space_id
integerRequired
team__sidebar__assigned__comments
boolean
team__sidebar__assignees
array
team__sidebar__unassigned__tasks
boolean
type
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new clickup task in a specific list, optionally as a subtask if a `parent` task id (which cannot be a subtask itself and must be in the same list) is provided.

Action Parameters

assignees
array
check_required_custom_fields
boolean
custom_fields
array
custom_item_id
integer
custom_task_ids
boolean
description
string
due_date
integer
due_date_time
boolean
links_to
string
list_id
integerRequired
name
stringRequired
notify_all
boolean
parent
string
priority
integer
start_date
integer
start_date_time
boolean
status
string
tags
array
team_id
integer
time_estimate
integer

Action Response

data
object
error
successful
boolean
Uploads a file as an attachment to a specified clickup task, requiring `multipart/form-data` for file upload.

Action Parameters

attachment
array
custom_task_ids
boolean
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Adds a comment to a clickup task; `team id` is required if `custom task ids` is true.

Action Parameters

assignee
integerRequired
comment_text
stringRequired
custom_task_ids
boolean
notify_all
booleanRequired
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Creates a new task in a specified clickup list from a task template, using the provided name for the new task.

Action Parameters

list_id
integerRequired
name
stringRequired
template_id
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new team (user group) with specified members in a workspace; member ids must be for existing users, and be aware that adding view-only guests as paid members may incur extra charges.

Action Parameters

members
arrayRequired
name
stringRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Creates a clickup webhook for a team (workspace) to notify a public url on specified events (at least one, or '*' for all), optionally scoped to a space, folder, list, or task; the endpoint must accept requests from dynamic ips.

Action Parameters

endpoint
stringRequired
events
arrayRequired
folder_id
integer
list_id
integer
space_id
integer
task_id
string
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Creates a new, customizable view (e.g., list, board) at the 'everything' level for a specified team (workspace id), encompassing all tasks within that workspace.

Action Parameters

columns__fields
array
divide__collapsed
boolean
divide__dir
null
divide__field
null
filters__fields
array
filters__op
string
filters__search
string
filters__show__closed
boolean
grouping__collapsed
array
grouping__dir
integer
grouping__field
string
grouping__ignore
boolean
name
stringRequired
settings__collapse__empty__columns
string
settings__me__checklists
boolean
settings__me__comments
boolean
settings__me__subtasks
boolean
settings__show__assignees
boolean
settings__show__closed__subtasks
boolean
settings__show__images
boolean
settings__show__subtask__parent__names
boolean
settings__show__subtasks
integer
settings__show__task__locations
boolean
sorting__fields
array
team__sidebar__assigned__comments
boolean
team__sidebar__assignees
array
team__sidebar__unassigned__tasks
boolean
team_id
integerRequired
type
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an existing time entry, specified by `timer id`, from a workspace identified by `team id`.

Action Parameters

team_id
integerRequired
timer_id
integerRequired

Action Response

data
object
error
successful
boolean
Permanently deletes an existing checklist identified by its `checklist id`.

Action Parameters

checklist_id
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes an existing item, identified by `checklist item id`, from an existing checklist, identified by `checklist id`.

Action Parameters

checklist_id
stringRequired
checklist_item_id
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an existing comment from a task using its `comment id`.

Action Parameters

comment_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes two dependency links for `task id`: one where `task id` is blocked by `depends on`, and another where `dependency of` is blocked by `task id`; `team id` is required if `custom task ids` is true.

Action Parameters

custom_task_ids
boolean
dependency_of
stringRequired
depends_on
stringRequired
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Permanently and irreversibly deletes a specified folder and all its contents (lists, tasks) if the folder id exists.

Action Parameters

folder_id
integerRequired

Action Response

data
object
error
successful
boolean
Permanently removes an existing goal, identified by its `goal id`, from the workspace.

Action Parameters

goal_id
stringRequired

Action Response

data
object
error
successful
boolean
Deletes an existing key result, also referred to as a target within a goal, identified by its `key result id`.

Action Parameters

key_result_id
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes an existing list and all its contents; this action is destructive and irreversible via the api.

Action Parameters

list_id
integerRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specified space in clickup; this action is irreversible as the space cannot be recovered via the api.

Action Parameters

space_id
integerRequired

Action Response

data
object
error
successful
boolean
Deletes a tag from a space, identified by `tag name` in path; precise matching of tag details in the request body (`tag name 1`, `tag tag fg`, `tag tag bg`) is generally required for successful deletion.

Action Parameters

space_id
integerRequired
tag__name
string
tag__tag__bg
string
tag__tag__fg
string
tag_name
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a task, using its standard id or a custom task id (requires `custom task ids=true` and `team id`).

Action Parameters

custom_task_ids
boolean
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Permanently deletes an existing team (user group) from the workspace using its `group id`.

Action Parameters

group_id
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a time-tracked interval from a task; use this legacy endpoint for older time tracking systems.

Action Parameters

custom_task_ids
boolean
interval_id
stringRequired
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Permanently and irreversibly deletes an existing view in clickup, identified by its `view id`.

Action Parameters

view_id
stringRequired

Action Response

data
object
error
successful
boolean
Permanently removes an existing webhook, specified by its id, thereby ceasing all its event monitoring and notifications.

Action Parameters

webhook_id
stringRequired

Action Response

data
object
error
successful
boolean
Updates an existing checklist's name or position, identified by its `checklist id`.

Action Parameters

checklist_id
stringRequired
name
string
position
integer

Action Response

data
object
error
successful
boolean
Updates an existing checklist item, allowing modification of its name, assignee, resolution status, or parent item for nesting.

Action Parameters

assignee
string
checklist_id
stringRequired
checklist_item_id
stringRequired
name
string
parent
string
resolved
boolean

Action Response

data
object
error
successful
boolean
Modifies the details and permissions of an existing guest user within a specific workspace.

Action Parameters

can_create_views
booleanRequired
can_edit_tags
booleanRequired
can_see_time_estimated
booleanRequired
can_see_time_spent
booleanRequired
custom_role_id
integerRequired
guest_id
integerRequired
team_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Updates an existing key result's progress or note in clickup, where the key result measures progress towards a goal.

Action Parameters

key_result_id
stringRequired
note
stringRequired
steps_current
integerRequired

Action Response

data
object
error
successful
boolean
Updates an existing tag's name and colors in a clickup space; requires current tag name for identification, and new values for tag name, foreground color, and background color, all of which are mandatory for the update.

Action Parameters

space_id
integerRequired
tag__bg__color
string
tag__fg__color
string
tag__name
string
tag_name
stringRequired

Action Response

data
object
error
successful
boolean
Edits a legacy time-tracked interval for a task (identified by `task id` and `interval id`) to update its start/end times and duration; `team id` is required if `custom task ids` is true.

Action Parameters

custom_task_ids
boolean
end
integerRequired
interval_id
stringRequired
start
integerRequired
task_id
stringRequired
team_id
integer
time
integerRequired

Action Response

data
object
error
successful
boolean
Updates a user's username, admin status, or custom role in a workspace; requires the workspace to be on an enterprise plan.

Action Parameters

admin
booleanRequired
custom_role_id
integerRequired
team_id
integerRequired
user_id
integerRequired
username
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: creates a new folder in a clickup space; use `create folder` instead.

Action Parameters

name
stringRequired
space_id
integerRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `get folders`. retrieves folders within a specified clickup space, ensuring `space id` is valid, with an option to filter by archived status.

Action Parameters

archived
boolean
space_id
integerRequired

Action Response

data
object
error
successful
boolean
Deprecated: retrieves detailed information about a specific folder in clickup; use `get folder` instead.

Action Parameters

folder_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all accessible custom field definitions for a specified clickup list using its `list id`.

Action Parameters

list_id
integerRequired

Action Response

data
object
error
successful
boolean
Exchanges a clickup oauth 2.0 authorization code (obtained after user consent) for an access token.

Action Parameters

client_id
stringRequired
client_secret
stringRequired
code
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all unique tags applied to time entries within a specified clickup team (workspace).

Action Parameters

team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of workspaces (teams) the authenticated user can access.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves the details of the currently authenticated clickup user.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves the time spent in each status for multiple tasks; requires the 'total time in status' clickapp to be enabled in the workspace.

Action Parameters

custom_task_ids
boolean
task_ids
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Retrieves comments from a specified chat view in clickup, supporting pagination via `start` and `start id` to fetch comments older than the default 25 most recent.

Action Parameters

start
integer
start_id
string
view_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all custom roles, which allow granular permission configurations, for a specified workspace (team).

Action Parameters

include_members
boolean
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all custom task types available within a specified workspace (team id).

Action Parameters

team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a paginated list of tasks (up to 100 per page) from a specified team (workspace id in `team id`) based on various filter criteria, respecting user access permissions.

Action Parameters

assignees
array
custom_fields
array
custom_items
array
custom_task_ids
boolean
date_created_gt
integer
date_created_lt
integer
date_done_gt
integer
date_done_lt
integer
date_updated_gt
integer
date_updated_lt
integer
due_date_gt
integer
due_date_lt
integer
include_closed
boolean
include_markdown_description
boolean
list_ids
array
order_by
string
page
integer
parent
string
project_ids
array
reverse
boolean
space_ids
array
statuses
array
subtasks
boolean
tags
array
team_Id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Retrieves detailed information about a specific folder in clickup.

Action Parameters

folder_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all lists within a specified space that are not located in any folder.

Action Parameters

archived
boolean
space_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves folders within a specified clickup space, ensuring `space id` is valid, with an option to filter by archived status.

Action Parameters

archived
boolean
space_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all configured views (like list, board, calendar) for a specified, existing folder in clickup.

Action Parameters

folder_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for an existing clickup goal, specified by its unique `goal id`.

Action Parameters

goal_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves goals for a specified clickup workspace (team); the `team id` must be valid and accessible.

Action Parameters

include_completed
boolean
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Call this to retrieve detailed information for a specific guest within a team (workspace), ensuring the `guest id` is valid for the given `team id`; this action requires the clickup enterprise plan.

Action Parameters

guest_id
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for an existing list in clickup, identified by its unique `list id`.

Action Parameters

list_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all lists within a specified, existing clickup folder, optionally filtering by archived status.

Action Parameters

archived
boolean
folder_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves comments for a specific clickup list, supporting pagination using `start` (timestamp) and `start id` (comment id) to fetch earlier comments; omits them for the latest 25.

Action Parameters

list_id
integerRequired
start
integer
start_id
string

Action Response

data
object
error
successful
boolean
Retrieves all members of a specific, existing clickup list by its id.

Action Parameters

list_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all task and page views for a specified and accessible clickup list.

Action Parameters

list_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves the currently active time entry for a user in a workspace; a negative 'duration' in its data indicates it's running, and the response may be empty if no entry is active.

Action Parameters

assignee
integer
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Fetches a specific time entry by its id for a given team; a negative duration in the response indicates an active timer.

Action Parameters

include__task
boolean
include_location_names
boolean
team_id
integerRequired
timer_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for an existing space in a clickup workspace, identified by its unique space id.

Action Parameters

space_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves spaces for a team id; member information for private spaces is returned only if the authenticated user is a member.

Action Parameters

archived
boolean
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all tags for tasks within a specified clickup space, requiring a valid `space id`.

Action Parameters

space_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all task and page views for a specified space id in clickup.

Action Parameters

space_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves comprehensive details for a clickup task by its id, supporting standard or custom task ids (requires `team id` for custom ids).

Action Parameters

custom_task_ids
boolean
include_markdown_description
boolean
include_subtasks
boolean
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Retrieves tasks from a specified clickup list; only tasks whose home is the given list id are returned.

Action Parameters

archived
boolean
assignees
array
custom_fields
array
custom_items
array
date_created_gt
integer
date_created_lt
integer
date_done_gt
integer
date_done_lt
integer
date_updated_gt
integer
date_updated_lt
integer
due_date_gt
integer
due_date_lt
integer
include_closed
boolean
include_markdown_description
boolean
list_id
integerRequired
order_by
string
page
integer
reverse
boolean
statuses
array
subtasks
boolean
tags
array

Action Response

data
object
error
successful
boolean
Retrieves up to 25 comments for a specified task, supporting pagination using `start` and `start id` to fetch older comments.

Action Parameters

custom_task_ids
boolean
start
integer
start_id
string
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Retrieves users with explicit access (directly assigned or shared) to a specific existing task, excluding users with inherited permissions.

Action Parameters

task_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the duration a task has spent in each status, provided the 'total time in status' clickapp is enabled for the workspace.

Action Parameters

custom_task_ids
boolean
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Retrieves task templates for a specified workspace (team id), supporting pagination.

Action Parameters

page
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves user groups (teams) from a clickup workspace, typically requiring `team id` (workspace id), with an option to filter by `group ids`.

Action Parameters

group_ids
string
team_id
integer

Action Response

data
object
error
successful
boolean
Retrieves time entries for a specified team (workspace id) within a date range (defaults to the last 30 days for the authenticated user if dates are omitted); active timers are indicated by negative durations in the response.

Action Parameters

assignee
string
custom_task_ids
boolean
end_date
integer
folder_id
integer
include_location_names
boolean
include_task_tags
boolean
list_id
integer
space_id
integer
start_date
integer
task_id
string
team_Id
integerRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Retrieves the modification history for an existing time entry within a specific clickup team (workspace).

Action Parameters

team_id
integerRequired
timer_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves tracked time for a task using a legacy endpoint; prefer newer time tracking api endpoints for managing time entries.

Action Parameters

custom_task_ids
boolean
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Retrieves detailed information for a specific user within a clickup workspace (team), available only for workspaces on the clickup enterprise plan.

Action Parameters

team_id
integerRequired
user_id
integerRequired

Action Response

data
object
error
successful
boolean
Fetches details for a specific clickup view, identified by its `view id`, which must exist.

Action Parameters

view_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all tasks visible in a specified clickup view, respecting its applied filters, sorting, and grouping.

Action Parameters

page
integerRequired
view_id
stringRequired

Action Response

data
object
error
successful
boolean
Fetches webhooks for a team (workspace), returning only those created by the authenticated user via api, for a `team id` they can access.

Action Parameters

team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all task and page views at the 'everything level' (a comprehensive overview of all tasks across all spaces) for a specified clickup workspace.

Action Parameters

team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves the details of the current subscription plan for a specified clickup workspace.

Action Parameters

team_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves seat utilization (used, total, available for members/guests) for a clickup workspace (team) id, which must be for an existing workspace.

Action Parameters

team_id
stringRequired

Action Response

data
object
error
successful
boolean
Invites a guest by email to a clickup workspace (team) on an enterprise plan, setting initial permissions and optionally a custom role; further access configuration for specific items may require separate actions.

Action Parameters

can_create_views
booleanRequired
can_edit_tags
booleanRequired
can_see_time_estimated
booleanRequired
can_see_time_spent
booleanRequired
custom_role_id
integerRequired
email
stringRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Invites a user via email to a clickup workspace (team), optionally granting admin rights or a custom role; requires an enterprise plan for the workspace.

Action Parameters

admin
booleanRequired
custom_role_id
integer
email
stringRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `get lists` instead. retrieves lists from a specified, existing clickup folder.

Action Parameters

archived
boolean
folder_id
integerRequired

Action Response

data
object
error
successful
boolean
Deprecated: retrieves users with access to a specific list; use `get list members` instead.

Action Parameters

list_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes an existing value from a custom field on a specific task; this does not delete the custom field definition or its predefined options.

Action Parameters

custom_task_ids
boolean
field_id
stringRequired
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Revokes a guest's access to a specific clickup folder, optionally unsharing items explicitly shared with them within it; requires an enterprise plan.

Action Parameters

folder_id
integerRequired
guest_id
integerRequired
include_shared
booleanDefaults to True

Action Response

data
object
error
successful
boolean
Revokes a guest's access to a specific list, provided the guest currently has access to this list and the workspace is on the clickup enterprise plan.

Action Parameters

guest_id
integerRequired
include_shared
booleanDefaults to True
list_id
integerRequired

Action Response

data
object
error
successful
boolean
Revokes a guest's access to a specific task; only available for workspaces on the clickup enterprise plan.

Action Parameters

custom_task_ids
boolean
guest_id
integerRequired
include_shared
boolean
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Permanently removes a guest from a specified workspace, revoking all their access; this destructive operation requires the workspace to be on the clickup enterprise plan.

Action Parameters

guest_id
integerRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Removes tags from specified time entries in a team, without deleting the tags from the workspace.

Action Parameters

tags
arrayRequired
team_id
integerRequired
time_entry_ids
arrayRequired

Action Response

data
object
error
successful
boolean
Removes a tag from a specified task by disassociating it (does not delete the tag from workspace), succeeding even if the tag is not on the task.

Action Parameters

custom_task_ids
boolean
tag_name
stringRequired
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Removes a task from an extra list (not its home list); the 'tasks in multiple lists' clickapp must be enabled.

Action Parameters

list_id
integerRequired
task_id
stringRequired

Action Response

data
object
error
successful
boolean
Deactivates a user from a specified clickup workspace, revoking their access (user can be reactivated later); requires the workspace to be on an enterprise plan.

Action Parameters

team_id
integerRequired
user_id
integerRequired

Action Response

data
object
error
successful
boolean
Sets or updates a custom field's value for a task; the new value (with type-dependent structure, e.g., `{"value": "text"}` or `{"value": 123, "value options": {"currency type":"usd"}}`) is provided in the json request body.

Action Parameters

custom_task_ids
boolean
field_id
stringRequired
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Retrieves the hierarchy of tasks, lists, and folders shared with the authenticated user within an existing clickup team (workspace), identified by its `team id`.

Action Parameters

team_id
integerRequired

Action Response

data
object
error
successful
boolean
Deprecated: retrieves detailed information about a specific space; use the getspace action instead.

Action Parameters

space_id
integerRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `get spaces` instead; retrieves spaces, with member info for private spaces accessible only if the user is a member.

Action Parameters

archived
boolean
team_id
integerRequired

Action Response

data
object
error
successful
boolean
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).

Action Parameters

billable
boolean
custom_task_ids
boolean
description
string
tags
array
team_Id
integerRequired
team_id
integer
tid
string

Action Response

data
object
error
successful
boolean
Stops the authenticated user's currently active time entry in the specified team (workspace), which requires an existing time entry to be running.

Action Parameters

team_id
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves details for a task by its id, supporting standard or custom ids (requires `team id` for custom ids). <<deprecated: this action is deprecated. please use 'get task' instead.>>

Action Parameters

custom_task_ids
boolean
include_markdown_description
boolean
include_subtasks
boolean
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
(deprecated: use `create checklist` instead) creates a new checklist with a specified name within an existing task, identifiable by standard id or custom task id (if `custom task ids` is true, `team id` is also required).

Action Parameters

custom_task_ids
boolean
name
stringRequired
task_id
stringRequired
team_id
integer

Action Response

data
object
error
successful
boolean
Deprecated: use 'create team'. creates a team (user group) in a workspace; adding a view-only guest as a paid member may incur extra charges.

Action Parameters

members
arrayRequired
name
stringRequired
team_id
integerRequired

Action Response

data
object
error
successful
boolean
Deprecated: retrieves the current plan for the specified workspace; use `get workspace plan` instead.

Action Parameters

team_id
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use `get workspace seats` to retrieve seat utilization for a clickup workspace (team) id.

Action Parameters

team_id
stringRequired

Action Response

data
object
error
successful
boolean
Records a time entry for a task using clickup's legacy time tracking system; newer endpoints are generally recommended.

Action Parameters

custom_task_ids
boolean
end
integerRequired
start
integerRequired
task_id
stringRequired
team_id
integer
time
integerRequired

Action Response

data
object
error
successful
boolean
Updates an existing clickup time entry; provide `start` and `end` times together, and include `team id` as a query param (request field `team id 1`) if `custom task ids` is true.

Action Parameters

billable
boolean
custom_task_ids
boolean
description
string
duration
integer
end
integer
start
integer
tag_action
string
tags
arrayRequired
team_id
integerRequired
tid
string
timer_id
integerRequired

Action Response

data
object
error
successful
boolean
Updates an existing task comment's text, assignee (who must be a valid workspace member), or resolution status, requiring a valid existing comment id.

Action Parameters

assignee
integerRequired
comment_id
integerRequired
comment_text
stringRequired
resolved
booleanRequired

Action Response

data
object
error
successful
boolean
Updates the name of an existing folder in clickup.

Action Parameters

folder_id
integerRequired
name
stringRequired

Action Response

data
object
error
successful
boolean
Updates attributes of an existing clickup goal, identified by its `goal id`.

Action Parameters

add_owners
arrayRequired
color
stringRequired
description
stringRequired
due_date
integerRequired
goal_id
stringRequired
name
stringRequired
rem_owners
arrayRequired

Action Response

data
object
error
successful
boolean
Updates attributes of an existing clickup list, such as its name, content, due date, priority, assignee, or color status, identified by its `list id`.

Action Parameters

assignee
stringRequired
content
stringRequired
due_date
integerRequired
due_date_time
booleanRequired
list_id
stringRequired
name
stringRequired
priority
integerRequired
status
stringRequired
unset_status
booleanRequired

Action Response

data
object
error
successful
boolean
Updates an existing clickup space, allowing modification of its name, color, privacy, and feature settings (clickapps).

Action Parameters

admin_can_manage
booleanRequired
color
stringRequired
features__checklists__enabled
boolean
features__custom__fields__enabled
boolean
features__dependency__warning__enabled
boolean
features__due__dates__enabled
boolean
features__due__dates__remap__closed__due__date
boolean
features__due__dates__remap__due__dates
boolean
features__due__dates__start__date
boolean
features__portfolios__enabled
boolean
features__remap__dependencies__enabled
boolean
features__tags__enabled
boolean
features__time__estimates__enabled
boolean
features__time__tracking__enabled
boolean
multiple_assignees
booleanRequired
name
stringRequired
private
booleanRequired
space_id
integerRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

archived
boolean
assignees__add
array
assignees__rem
array
custom_item_id
integer
custom_task_ids
boolean
description
string
due_date
integer
due_date_time
boolean
name
string
parent
string
priority
integer
start_date
integer
start_date_time
boolean
status
string
task_id
stringRequired
team_id
integer
time_estimate
integer

Action Response

data
object
error
successful
boolean
Updates an existing clickup user group (team) using its `group id`; note that adding a view-only guest as a paid member may incur charges.

Action Parameters

group_id
stringRequired
handle
string
members__add
array
members__rem
array
name
string

Action Response

data
object
error
successful
boolean
Updates an existing clickup view's settings such as name, type, grouping, or filters; ensure `parent id` and `parent type` define a valid hierarchy, and that specified field names (e.g. for sorting, columns) are valid within the clickup workspace.

Action Parameters

columns__fields
array
divide__collapsed
boolean
divide__dir
null
divide__field
null
filters__fields
array
filters__op
string
filters__search
string
filters__show__closed
boolean
grouping__collapsed
array
grouping__dir
integer
grouping__field
string
grouping__ignore
boolean
name
stringRequired
parent__id
string
parent__type
integer
settings__collapse__empty__columns
string
settings__me__checklists
boolean
settings__me__comments
boolean
settings__me__subtasks
boolean
settings__show__assignees
boolean
settings__show__closed__subtasks
boolean
settings__show__images
boolean
settings__show__subtask__parent__names
boolean
settings__show__subtasks
integer
settings__show__task__locations
boolean
sorting__fields
array
team__sidebar__assigned__comments
boolean
team__sidebar__assignees
array
team__sidebar__unassigned__tasks
boolean
type
stringRequired
view_id
stringRequired

Action Response

data
object
error
successful
boolean
Updates the endpoint url, monitored events, and status of an existing webhook, identified by its `webhook id`.

Action Parameters

endpoint
stringRequired
events
stringRequired
status
stringRequired
webhook_id
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: retrieves task and page views at the everything level of a workspace; use `get workspace everything level views` instead.

Action Parameters

team_id
integerRequired

Action Response

data
object
error
successful
boolean
(deprecated: use get space views instead) retrieves all task and page views for a specified space id in clickup.

Action Parameters

space_id
integerRequired

Action Response

data
object
error
successful
boolean