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
stringDefaults to task:read,task:write,team:read,team:write,workspace:read,workspace:write,list:read,list:write,view:read,view:write,folder:read,folder:write,space:read,space:write,goal:read,goal:write,comment:read,comment:write,tag:read,tag:write,time:read,time:write,customfield:read,customfield:write
base_url
stringDefaults to https://api.clickup.com
api_key
stringRequired

Actions

View the folders in a space.(DEPRECATED use get_folders)

Action Parameters

space_id
integerRequired
archived
boolean

Action Response

data
object
successful
boolean
error

Invite someone to your workspace as a member through a specific endpoint. note: guest invitations and this feature are exclusive to workspaces on the enterprise plan.

Action Parameters

team_id
integerRequired
email
stringRequired
admin
booleanRequired
custom_role_id
integer

Action Response

data
object
successful
boolean
error

View the used, total, and available member and guest seats for a workspace.(DEPRECATED use get_workspace_seats)

Action Parameters

team_id
stringRequired

Action Response

data
object
successful
boolean
error

View the task templates available in a workspace.

Action Parameters

team_id
integerRequired
page
integerRequired

Action Response

data
object
successful
boolean
error

Add a new checklist to a task.(DEPRECATED use create_checklist)

Action Parameters

task_id
stringRequired
custom_task_ids
boolean
team_id
integer
name
stringRequired

Action Response

data
object
successful
boolean
error

View information about a specific task or page view.

Action Parameters

view_id
stringRequired

Action Response

data
object
successful
boolean
error

View the current plan for the specified workspace.(DEPRECATED use get_workspace_plan)

Action Parameters

team_id
stringRequired

Action Response

data
object
successful
boolean
error

View the tasks, lists, and folders that have been shared with the authenticated user.

Action Parameters

team_id
integerRequired

Action Response

data
object
successful
boolean
error

Share a list with a guest. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

list_id
integerRequired
guest_id
integerRequired
include_shared
boolean
permission_level
stringRequired

Action Response

data
object
successful
boolean
error

View task comments. if you do not include the start and start id parameters, this endpoint will return the most recent 25 comments. use the start and start id parameters of the oldest comment to retrieve the next 25 comments.

Action Parameters

task_id
stringRequired
custom_task_ids
boolean
team_id
integer
start
integer
start_id
string

Action Response

data
object
successful
boolean
error

Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view to a folder.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Delete a folder from your workspace.

Action Parameters

folder_id
integerRequired

Action Response

data
object
successful
boolean
error

Update a user’s name and role. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

team_id
integerRequired
user_id
integerRequired
username
stringRequired
admin
booleanRequired
custom_role_id
integerRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

team_id
integerRequired
assignee
integer

Action Response

data
object
successful
boolean
error

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

Action Parameters

comment_id
integerRequired
comment_text
stringRequired
assignee
integerRequired
resolved
booleanRequired

Action Response

data
object
successful
boolean
error

This api endpoint allows viewing up to 100 tasks per page, limited to tasks within the specified list id that have it as their home list. tasks from other home lists aren’t included.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Upload a file to a task as an attachment. note: this request uses multipart/form-data as the content type.(DEPRECATED use create_task_attachment)

Action Parameters

task_id
stringRequired
custom_task_ids
boolean
team_id
integer
attachment
array

Action Response

data
object
successful
boolean
error

View the task and page views available for a space.

Action Parameters

space_id
integerRequired

Action Response

data
object
successful
boolean
error

View the spaces avialable in a workspace. you can only get member info in private spaces.(DEPRECATED use get_spaces)

Action Parameters

team_id
integerRequired
archived
boolean

Action Response

data
object
successful
boolean
error

Add a new list to a folder.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Update a target.

Action Parameters

key_result_id
stringRequired
steps_current
integerRequired
note
stringRequired

Action Response

data
object
successful
boolean
error

View the webhooks created via the api for a workspace. this endpoint returns webhooks created by the authenticated user.

Action Parameters

team_id
integerRequired

Action Response

data
object
successful
boolean
error

Add a new space to a workspace.

Action Parameters

team_id
integerRequired
name
stringRequired
multiple_assignees
booleanRequired
features__tags__enabled
boolean
features__due__dates__enabled
boolean
features__due__dates__start__date
boolean
features__due__dates__remap__due__dates
boolean
features__due__dates__remap__closed__due__date
boolean
features__time__tracking__enabled
boolean
features__time__estimates__enabled
boolean
features__checklists__enabled
boolean
features__custom__fields__enabled
boolean
features__remap__dependencies__enabled
boolean
features__dependency__warning__enabled
boolean
features__portfolios__enabled
boolean

Action Response

data
object
successful
boolean
error

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

Action Parameters

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

Action Response

data
object
successful
boolean
error

note: this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.

Action Parameters

task_id
stringRequired
custom_task_ids
boolean
team_id
integer

Action Response

data
object
successful
boolean
error

View information about a task. you can only view task information of tasks you can access. tasks with attachments will return an “attachments” response.(DEPRECATED use get_task)

Action Parameters

task_id
stringRequired
custom_task_ids
boolean
team_id
integer
include_subtasks
boolean
include_markdown_description
boolean

Action Response

data
object
successful
boolean
error

View the people who have access to a list.

Action Parameters

list_id
integerRequired

Action Response

data
object
successful
boolean
error

Revoke a guest’s access to a folder. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

folder_id
integerRequired
guest_id
integerRequired
include_shared
boolean

Action Response

data
object
successful
boolean
error

Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view to a space.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view at the everything level of a workspace.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Upload a file to a task as an attachment. note: this request uses multipart/form-data as the content type.

Action Parameters

task_id
stringRequired
custom_task_ids
boolean
team_id
integer
attachment
array

Action Response

data
object
successful
boolean
error

This api endpoint allows for removing a task from an extra list, not its original list, requiring the tasks in multiple list clickapp to be enabled.

Action Parameters

list_id
integerRequired
task_id
stringRequired

Action Response

data
object
successful
boolean
error

View the lists within a folder.(DEPRECATED use get_lists)

Action Parameters

folder_id
integerRequired
archived
boolean

Action Response

data
object
successful
boolean
error

Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view to a list.

Action Parameters

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

Action Response

data
object
successful
boolean
error

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

Action Parameters

team_id
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint removes a user group from a workspace, per clickup documentation. team id is the workspace id, and group id is the user group id.

Action Parameters

group_id
stringRequired

Action Response

data
object
successful
boolean
error

Add a line item to a task checklist.

Action Parameters

checklist_id
stringRequired
name
string
assignee
integer

Action Response

data
object
successful
boolean
error

Set up a webhook to monitor for events. we do not have a dedicated ip address for webhooks. we use our domain name and dynamic addressing.

Action Parameters

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

Action Response

data
object
successful
boolean
error

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.

Action Parameters

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

Action Response

data
object
successful
boolean
error

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

Action Parameters

list_id
integerRequired

Action Response

data
object
successful
boolean
error

View the people who have access to a list.(DEPRECATED use get_list_members)

Action Parameters

list_id
integerRequired

Action Response

data
object
successful
boolean
error

Add a target to a goal.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Add a comment to a list.

Action Parameters

list_id
integerRequired
comment_text
stringRequired
assignee
integerRequired
notify_all
booleanRequired

Action Response

data
object
successful
boolean
error

The endpoint allows creating teams within workspaces, assigning tasks, and managing ids for both. adding a view-only guest as a paid member may result in extra charges due to automatic seat addition.

Action Parameters

team_id
integerRequired
name
stringRequired
members
arrayRequired

Action Response

data
object
successful
boolean
error

Delete a task from your workspace.

Action Parameters

task_id
stringRequired
custom_task_ids
boolean
team_id
integer

Action Response

data
object
successful
boolean
error

Delete a list from your workspace.

Action Parameters

list_id
integerRequired

Action Response

data
object
successful
boolean
error

Set a task as waiting on or blocking another task.

Action Parameters

task_id
stringRequired
custom_task_ids
boolean
team_id
integer
depends_on
string
depedency_of
string

Action Response

data
object
successful
boolean
error

View the lists within a folder.(DEPRECATED use get_folder)

Action Parameters

folder_id
integerRequired

Action Response

data
object
successful
boolean
error

View the current plan for the specified workspace.

Action Parameters

team_id
stringRequired

Action Response

data
object
successful
boolean
error

Share a folder with a guest. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

folder_id
integerRequired
guest_id
integerRequired
include_shared
boolean
permission_level
stringRequired

Action Response

data
object
successful
boolean
error

See all visible tasks in a view in clickup.

Action Parameters

view_id
stringRequired
page
integerRequired

Action Response

data
object
successful
boolean
error

Add a new goal to a workspace.

Action Parameters

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

Action Response

data
object
successful
boolean
error

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.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Remove labels from time entries. this does not remove the label from a workspace.

Action Parameters

team_id
integerRequired
tags
arrayRequired
time_entry_ids
arrayRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

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

Action Response

data
object
successful
boolean
error

View the spaces available in a workspace.

Action Parameters

space_id
integerRequired

Action Response

data
object
successful
boolean
error

Delete a line item from a task checklist.

Action Parameters

checklist_id
stringRequired
checklist_item_id
stringRequired

Action Response

data
object
successful
boolean
error

View how long two or more tasks have been in each status.

Action Parameters

task_ids
stringRequired
custom_task_ids
boolean
team_id
integer

Action Response

data
object
successful
boolean
error

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

Action Parameters

webhook_id
stringRequired

Action Response

data
object
successful
boolean
error

View the task and page views available for a space.(DEPRECATED use get_space_views)

Action Parameters

space_id
integerRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

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

Action Response

data
object
successful
boolean
error

Update a webhook to change the events to be monitored.

Action Parameters

webhook_id
stringRequired
endpoint
stringRequired
events
stringRequired
status
stringRequired

Action Response

data
object
successful
boolean
error

Remove the data from a custom field on a task. this does not delete the option from the custom field.

Action Parameters

task_id
stringRequired
field_id
stringRequired
custom_task_ids
boolean
team_id
integer

Action Response

data
object
successful
boolean
error

View the task and page views available for a folder.

Action Parameters

folder_id
integerRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

view_id
stringRequired
start
integer
start_id
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

team_id
integerRequired
timer_id
stringRequired
include__task
boolean
include_location_names
boolean

Action Response

data
object
successful
boolean
error

To invite a guest to your workspace, use the “invite user to workspace” endpoint. then, use specific endpoints to grant access to folders, lists, or tasks. note: available only for enterprise plan.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Add a new task tag to a space.

Action Parameters

space_id
integerRequired
tag__name
string
tag__tag__fg
string
tag__tag__bg
string

Action Response

data
object
successful
boolean
error

To view comments on a list, omitting start and start id shows the latest 25 comments. for earlier ones, use the start and start id of the oldest comment to get the next 25.

Action Parameters

list_id
integerRequired
start
integer
start_id
string

Action Response

data
object
successful
boolean
error

Delete a time entry from a workspace.

Action Parameters

team_id
integerRequired
timer_id
integerRequired

Action Response

data
object
successful
boolean
error

View the spaces available in a workspace.(DEPRECATED use get_space)

Action Parameters

space_id
integerRequired

Action Response

data
object
successful
boolean
error

The text outlines api authentication via personal tokens and oauth flow, stating oauth tokens can’t be used in “try it” feature or tested via web browsers.(DEPRECATED use get_access_token)

Action Parameters

client_id
stringRequired
client_secret
stringRequired
code
stringRequired

Action Response

data
object
successful
boolean
error

note: this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.

Action Parameters

task_id
stringRequired
interval_id
stringRequired
custom_task_ids
boolean
team_id
integer

Action Response

data
object
successful
boolean
error

Share a task with a guest. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

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

Action Response

data
object
successful
boolean
error

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.

Action Parameters

task_id
stringRequired
custom_task_ids
boolean
team_id
integer

Action Response

data
object
successful
boolean
error

Revoke a guest’s access to a list. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

list_id
integerRequired
guest_id
integerRequired
include_shared
boolean

Action Response

data
object
successful
boolean
error

View the spaces avialable in a workspace. you can only get member info in private spaces.

Action Parameters

team_id
integerRequired
archived
boolean

Action Response

data
object
successful
boolean
error

note: this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Deletes a specific view by its id. requires ‘view id’ as a string parameter in the path. successful deletion returns 200 with an empty json object.

Action Parameters

view_id
stringRequired

Action Response

data
object
successful
boolean
error

Create a new task using a task template.

Action Parameters

list_id
integerRequired
template_id
stringRequired
name
stringRequired

Action Response

data
object
successful
boolean
error

View information about a list.

Action Parameters

list_id
integerRequired

Action Response

data
object
successful
boolean
error

View the task and page views available at the everything level of a workspace.

Action Parameters

team_id
integerRequired

Action Response

data
object
successful
boolean
error

View the people who have access to a task.

Action Parameters

task_id
stringRequired

Action Response

data
object
successful
boolean
error

View the details of the authenticated user’s clickup account.(DEPRECATED use get_authorized_user)

Action Parameters

Action Response

data
object
successful
boolean
error

Start a timer for the authenticated user.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Update a task tag.

Action Parameters

space_id
integerRequired
tag_name
stringRequired
tag__name
string
tag__fg__color
string
tag__bg__color
string

Action Response

data
object
successful
boolean
error

The endpoint allows creating teams within workspaces, assigning tasks, and managing ids for both. adding a view-only guest as a paid member may result in extra charges due to automatic seat addition.(DEPRECATED use create_team)

Action Parameters

team_id
integerRequired
name
stringRequired
members
arrayRequired

Action Response

data
object
successful
boolean
error

Add a task to an additional list. note: this endpoint requires the tasks in multiple list clickapp to be enabled.

Action Parameters

list_id
integerRequired
task_id
stringRequired

Action Response

data
object
successful
boolean
error

View the folders in a space.

Action Parameters

space_id
integerRequired
archived
boolean

Action Response

data
object
successful
boolean
error

Deactivate a user from a workspace. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

team_id
integerRequired
user_id
integerRequired

Action Response

data
object
successful
boolean
error

Add a new comment to a chat view.

Action Parameters

view_id
stringRequired
comment_text
stringRequired
notify_all
booleanRequired

Action Response

data
object
successful
boolean
error

The endpoint controls user group assignments in a workspace, requiring ‘team id’ and ‘group id’. adding a view-only guest as a paid member incurs prorated charges for additional seats.

Action Parameters

group_id
stringRequired
name
string
handle
string
members__add
array
members__rem
array

Action Response

data
object
successful
boolean
error

This api endpoint retrieves time entries for the past 30 days for the user or others using the assignee parameter, and allows filtering by space id or task id. negative durations show active timers.

Action Parameters

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

Action Response

data
object
successful
boolean
error

View the workspaces available to the authenticated user.

Action Parameters

Action Response

data
object
successful
boolean
error

Add a label to a time entry.

Action Parameters

team_id
integerRequired
tags
arrayRequired
time_entry_ids
arrayRequired

Action Response

data
object
successful
boolean
error

View the lists in a space that aren’t located in a folder.

Action Parameters

space_id
integerRequired
archived
boolean

Action Response

data
object
successful
boolean
error

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

Action Parameters

checklist_id
stringRequired
name
string
position
integer

Action Response

data
object
successful
boolean
error

Add a new folder to a space.(DEPRECATED use create_folder)

Action Parameters

space_id
integerRequired
name
stringRequired

Action Response

data
object
successful
boolean
error

Add a new checklist to a task.

Action Parameters

task_id
stringRequired
custom_task_ids
boolean
team_id
integer
name
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

team_id
integerRequired

Action Response

data
object
successful
boolean
error

View the workspaces available to the authenticated user.(DEPRECATED use get_authorized_teams_workspaces)

Action Parameters

Action Response

data
object
successful
boolean
error

This api endpoint allows viewing up to 100 tasks per page, limited to tasks within the specified list id that have it as their home list. tasks from other home lists aren’t included.(DEPRECATED use get_tasks)

Action Parameters

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

Action Response

data
object
successful
boolean
error

note: this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Revoke a guest’s access to a workspace. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

team_id
integerRequired
guest_id
integerRequired

Action Response

data
object
successful
boolean
error

Remove a tag from a task. this does not delete the tag from the space.

Action Parameters

task_id
stringRequired
tag_name
stringRequired
custom_task_ids
boolean
team_id
integer

Action Response

data
object
successful
boolean
error

View the details of the authenticated user’s clickup account.

Action Parameters

Action Response

data
object
successful
boolean
error

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

Action Parameters

team_id
integerRequired

Action Response

data
object
successful
boolean
error

View the lists within a folder.

Action Parameters

folder_id
integerRequired
archived
boolean

Action Response

data
object
successful
boolean
error

Rename, set the space color, and enable clickapps for a space.

Action Parameters

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

Action Response

data
object
successful
boolean
error

View the goals available in a workspace.

Action Parameters

team_id
integerRequired
include_completed
boolean

Action Response

data
object
successful
boolean
error

Add a new folder to a space.

Action Parameters

space_id
integerRequired
name
stringRequired

Action Response

data
object
successful
boolean
error

Remove the dependency relationship between two or more tasks.

Action Parameters

task_id
stringRequired
depends_on
stringRequired
dependency_of
stringRequired
custom_task_ids
boolean
team_id
integer

Action Response

data
object
successful
boolean
error

View the task and page views available at the everything level of a workspace.(DEPRECATED use get_workspace_everything_level_views)

Action Parameters

team_id
integerRequired

Action Response

data
object
successful
boolean
error

Rename a folder.

Action Parameters

folder_id
integerRequired
name
stringRequired

Action Response

data
object
successful
boolean
error

Delete a target from a goal.

Action Parameters

key_result_id
stringRequired

Action Response

data
object
successful
boolean
error

View a list of changes made to a time entry.

Action Parameters

team_id
integerRequired
timer_id
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Add a tag to a task.

Action Parameters

task_id
stringRequired
tag_name
stringRequired
custom_task_ids
boolean
team_id
integer

Action Response

data
object
successful
boolean
error

View information about a guest. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

team_id
integerRequired
guest_id
integerRequired

Action Response

data
object
successful
boolean
error

View the custom roles available in a workspace.

Action Parameters

team_id
integerRequired
include_members
boolean

Action Response

data
object
successful
boolean
error

View information about a user in a workspace. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

team_id
integerRequired
user_id
integerRequired

Action Response

data
object
successful
boolean
error

Add a new comment to a task.

Action Parameters

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

Action Response

data
object
successful
boolean
error

The text outlines api authentication via personal tokens and oauth flow, stating oauth tokens can’t be used in “try it” feature or tested via web browsers.

Action Parameters

client_id
stringRequired
client_secret
stringRequired
code
stringRequired

Action Response

data
object
successful
boolean
error

Create a new task.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Delete a task tag from a space.

Action Parameters

space_id
integerRequired
tag_name
stringRequired
tag__name
string
tag__tag__fg
string
tag__tag__bg
string

Action Response

data
object
successful
boolean
error

This endpoint allows viewing user groups (teams) in a workspace, where team id is the workspace id, and group id is a user group id in api documentation.

Action Parameters

team_id
integer
group_ids
string

Action Response

data
object
successful
boolean
error

View the lists within a folder.

Action Parameters

folder_id
integerRequired

Action Response

data
object
successful
boolean
error

Rename an time entry label.

Action Parameters

team_id
integerRequired
name
stringRequired
new_name
stringRequired
tag_bg
stringRequired
tag_fg
stringRequired

Action Response

data
object
successful
boolean
error

View the task tags available in a space.

Action Parameters

space_id
integerRequired

Action Response

data
object
successful
boolean
error

Add a new list in a space.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Rename and configure options for a guest. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Delete a task comment.

Action Parameters

comment_id
integerRequired

Action Response

data
object
successful
boolean
error

View the details of a goal including its targets.

Action Parameters

goal_id
stringRequired

Action Response

data
object
successful
boolean
error

View the custom fields available on tasks in a specific list.

Action Parameters

list_id
integerRequired

Action Response

data
object
successful
boolean
error

View information about a task. you can only view task information of tasks you can access. tasks with attachments will return an “attachments” response.

Action Parameters

task_id
stringRequired
custom_task_ids
boolean
team_id
integer
include_subtasks
boolean
include_markdown_description
boolean

Action Response

data
object
successful
boolean
error

View the custom task types available in a workspace.

Action Parameters

team_id
integerRequired

Action Response

data
object
successful
boolean
error

Remove a goal from your workspace.

Action Parameters

goal_id
stringRequired

Action Response

data
object
successful
boolean
error

To add data to a task’s custom field, obtain the task id and the custom field’s field id (uuid). use the “get accessible custom fields” or “get task” api endpoints to find the field id.

Action Parameters

task_id
stringRequired
field_id
stringRequired
custom_task_ids
boolean
team_id
integer

Action Response

data
object
successful
boolean
error

Delete a checklist from a task.

Action Parameters

checklist_id
stringRequired

Action Response

data
object
successful
boolean
error

Revoke a guest’s access to a task. note: this endpoint is only available to workspaces on our enterprise plan.

Action Parameters

task_id
stringRequired
guest_id
integerRequired
include_shared
boolean
custom_task_ids
boolean
team_id
integer

Action Response

data
object
successful
boolean
error

Update the details of a time entry.

Action Parameters

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

Action Response

data
object
successful
boolean
error

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

Action Parameters

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

Action Response

data
object
successful
boolean
error

Delete a space from your workspace.

Action Parameters

space_id
integerRequired

Action Response

data
object
successful
boolean
error