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
OAUTH2
API_KEY
Actions
CLICKUP_ADD_DEPENDENCY
Set a task as waiting on or blocking another task.
Action Parameters
Action Response
CLICKUP_ADD_GUEST_TO_FOLDER
Share a folder with a guest. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_ADD_GUEST_TO_LIST
Share a list with a guest. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_ADD_GUEST_TO_TASK
Share a task with a guest. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_ADD_TAGS_FROM_TIME_ENTRIES
Add a label to a time entry.
Action Parameters
Action Response
CLICKUP_ADD_TAG_TO_TASK
Add a tag to a task.
Action Parameters
Action Response
CLICKUP_ADD_TASK_LINK
Link two tasks together.
Action Parameters
Action Response
CLICKUP_ADD_TASK_TO_LIST
Add a task to an additional list. note: this endpoint requires the tasks in multiple list clickapp to be enabled.
Action Parameters
Action Response
CLICKUP_ATTACHMENTS_UPLOAD_FILE_TO_TASK_AS_ATTACHMENT
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
Action Response
CLICKUP_AUTHORIZATION_GET_ACCESS_TOKEN
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
Action Response
CLICKUP_AUTHORIZATION_GET_WORK_SPACE_LIST
View the workspaces available to the authenticated user.(DEPRECATED use get_authorized_teams_workspaces)
Action Parameters
Action Response
CLICKUP_AUTHORIZATION_VIEW_ACCOUNT_DETAILS
View the details of the authenticated user’s clickup account.(DEPRECATED use get_authorized_user)
Action Parameters
Action Response
CLICKUP_CHANGE_TAG_NAMES_FROM_TIME_ENTRIES
Rename an time entry label.
Action Parameters
Action Response
CLICKUP_CREATE_A_TIME_ENTRY
Create a time entry. note: a time entry that has a negative duration means that timer is currently running for that user.
Action Parameters
Action Response
CLICKUP_CREATE_CHAT_VIEW_COMMENT
Add a new comment to a chat view.
Action Parameters
Action Response
CLICKUP_CREATE_CHECKLIST
Add a new checklist to a task.
Action Parameters
Action Response
CLICKUP_CREATE_CHECKLIST_ITEM
Add a line item to a task checklist.
Action Parameters
Action Response
CLICKUP_CREATE_FOLDER
Add a new folder to a space.
Action Parameters
Action Response
CLICKUP_CREATE_FOLDERLESS_LIST
Add a new list in a space.
Action Parameters
Action Response
CLICKUP_CREATE_FOLDER_VIEW
Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view to a folder.
Action Parameters
Action Response
CLICKUP_CREATE_GOAL
Add a new goal to a workspace.
Action Parameters
Action Response
CLICKUP_CREATE_KEY_RESULT
Add a target to a goal.
Action Parameters
Action Response
CLICKUP_CREATE_LIST
Add a new list to a folder.
Action Parameters
Action Response
CLICKUP_CREATE_LIST_COMMENT
Add a comment to a list.
Action Parameters
Action Response
CLICKUP_CREATE_LIST_VIEW
Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view to a list.
Action Parameters
Action Response
CLICKUP_CREATE_SPACE
Add a new space to a workspace.
Action Parameters
Action Response
CLICKUP_CREATE_SPACE_TAG
Add a new task tag to a space.
Action Parameters
Action Response
CLICKUP_CREATE_SPACE_VIEW
Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view to a space.
Action Parameters
Action Response
CLICKUP_CREATE_TASK
Create a new task.
Action Parameters
Action Response
CLICKUP_CREATE_TASK_ATTACHMENT
Upload a file to a task as an attachment. note: this request uses multipart/form-data as the content type.
Action Parameters
Action Response
CLICKUP_CREATE_TASK_COMMENT
Add a new comment to a task.
Action Parameters
Action Response
CLICKUP_CREATE_TASK_FROM_TEMPLATE
Create a new task using a task template.
Action Parameters
Action Response
CLICKUP_CREATE_TEAM
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
Action Response
CLICKUP_CREATE_WEBHOOK
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
Action Response
CLICKUP_CREATE_WORKSPACE_EVERYTHING_LEVEL_VIEW
Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view at the everything level of a workspace.
Action Parameters
Action Response
CLICKUP_DELETE_A_TIME_ENTRY
Delete a time entry from a workspace.
Action Parameters
Action Response
CLICKUP_DELETE_CHECKLIST
Delete a checklist from a task.
Action Parameters
Action Response
CLICKUP_DELETE_CHECKLIST_ITEM
Delete a line item from a task checklist.
Action Parameters
Action Response
CLICKUP_DELETE_COMMENT
Delete a task comment.
Action Parameters
Action Response
CLICKUP_DELETE_DEPENDENCY
Remove the dependency relationship between two or more tasks.
Action Parameters
Action Response
CLICKUP_DELETE_FOLDER
Delete a folder from your workspace.
Action Parameters
Action Response
CLICKUP_DELETE_GOAL
Remove a goal from your workspace.
Action Parameters
Action Response
CLICKUP_DELETE_KEY_RESULT
Delete a target from a goal.
Action Parameters
Action Response
CLICKUP_DELETE_LIST
Delete a list from your workspace.
Action Parameters
Action Response
CLICKUP_DELETE_SPACE
Delete a space from your workspace.
Action Parameters
Action Response
CLICKUP_DELETE_SPACE_TAG
Delete a task tag from a space.
Action Parameters
Action Response
CLICKUP_DELETE_TASK
Delete a task from your workspace.
Action Parameters
Action Response
CLICKUP_DELETE_TASK_LINK
Remove the link between two tasks.
Action Parameters
Action Response
CLICKUP_DELETE_TEAM
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
Action Response
CLICKUP_DELETE_TIME_TRACKED
note: this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.
Action Parameters
Action Response
CLICKUP_DELETE_VIEW
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
Action Response
CLICKUP_DELETE_WEBHOOK
Delete a webhook to stop monitoring the events and locations of the webhook.
Action Parameters
Action Response
CLICKUP_EDIT_CHECKLIST
Rename a task checklist, or reorder a checklist so it appears above or below other checklists on a task.
Action Parameters
Action Response
CLICKUP_EDIT_CHECKLIST_ITEM
Update an individual line item in a task checklist. you can rename it, set the assignee, mark it as resolved, or nest it under another checklist item.
Action Parameters
Action Response
CLICKUP_EDIT_GUEST_ON_WORKSPACE
Rename and configure options for a guest. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_EDIT_KEY_RESULT
Update a target.
Action Parameters
Action Response
CLICKUP_EDIT_SPACE_TAG
Update a task tag.
Action Parameters
Action Response
CLICKUP_EDIT_TIME_TRACKED
note: this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.
Action Parameters
Action Response
CLICKUP_EDIT_USER_ON_WORKSPACE
Update a user’s name and role. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_FOLDERS_CREATE_NEW_FOLDER
Add a new folder to a space.(DEPRECATED use create_folder)
Action Parameters
Action Response
CLICKUP_FOLDERS_GET_CONTENTS_OF
View the folders in a space.(DEPRECATED use get_folders)
Action Parameters
Action Response
CLICKUP_FOLDERS_GET_FOLDER_CONTENT
View the lists within a folder.(DEPRECATED use get_folder)
Action Parameters
Action Response
CLICKUP_GET_ACCESSIBLE_CUSTOM_FIELDS
View the custom fields available on tasks in a specific list.
Action Parameters
Action Response
CLICKUP_GET_ACCESS_TOKEN
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
Action Response
CLICKUP_GET_ALL_TAGS_FROM_TIME_ENTRIES
View all the labels that have been applied to time entries in a workspace.
Action Parameters
Action Response
CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES
View the workspaces available to the authenticated user.
Action Parameters
Action Response
CLICKUP_GET_AUTHORIZED_USER
View the details of the authenticated user’s clickup account.
Action Parameters
Action Response
CLICKUP_GET_BULK_TASKS_TIME_IN_STATUS
View how long two or more tasks have been in each status.
Action Parameters
Action Response
CLICKUP_GET_CHAT_VIEW_COMMENTS
View comments from a chat view. if you do not include the start and start id parameters, this endpoint will return the most recent 25 comments. use the start and start id parameters of the oldest comment to retrieve the next 25 comments.
Action Parameters
Action Response
CLICKUP_GET_CUSTOM_ROLES
View the custom roles available in a workspace.
Action Parameters
Action Response
CLICKUP_GET_CUSTOM_TASK_TYPES
View the custom task types available in a workspace.
Action Parameters
Action Response
CLICKUP_GET_FILTERED_TEAM_TASKS
View the tasks that meet specific criteria from a workspace. responses are limited to 100 tasks per page. you can only view task information of tasks you can access.
Action Parameters
Action Response
CLICKUP_GET_FOLDER
View the lists within a folder.
Action Parameters
Action Response
CLICKUP_GET_FOLDERLESS_LISTS
View the lists in a space that aren’t located in a folder.
Action Parameters
Action Response
CLICKUP_GET_FOLDERS
View the folders in a space.
Action Parameters
Action Response
CLICKUP_GET_FOLDER_VIEWS
View the task and page views available for a folder.
Action Parameters
Action Response
CLICKUP_GET_GOAL
View the details of a goal including its targets.
Action Parameters
Action Response
CLICKUP_GET_GOALS
View the goals available in a workspace.
Action Parameters
Action Response
CLICKUP_GET_GUEST
View information about a guest. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_GET_LIST
View information about a list.
Action Parameters
Action Response
CLICKUP_GET_LISTS
View the lists within a folder.
Action Parameters
Action Response
CLICKUP_GET_LIST_COMMENTS
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
Action Response
CLICKUP_GET_LIST_MEMBERS
View the people who have access to a list.
Action Parameters
Action Response
CLICKUP_GET_LIST_VIEWS
View the task and page views available for a list. views and required views are separate responses.
Action Parameters
Action Response
CLICKUP_GET_RUNNING_TIME_ENTRY
View a time entry that’s currently tracking time for the authenticated user. note: a time entry that has a negative duration means that timer is currently running for that user.
Action Parameters
Action Response
CLICKUP_GET_SINGULAR_TIME_ENTRY
View a single time entry. note: a time entry that has a negative duration means that timer is currently running for that user.
Action Parameters
Action Response
CLICKUP_GET_SPACE
View the spaces available in a workspace.
Action Parameters
Action Response
CLICKUP_GET_SPACES
View the spaces avialable in a workspace. you can only get member info in private spaces.
Action Parameters
Action Response
CLICKUP_GET_SPACE_TAGS
View the task tags available in a space.
Action Parameters
Action Response
CLICKUP_GET_SPACE_VIEWS
View the task and page views available for a space.
Action Parameters
Action Response
CLICKUP_GET_TASK
View information about a task. you can only view task information of tasks you can access. tasks with attachments will return an “attachments” response.
Action Parameters
Action Response
CLICKUP_GET_TASKS
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
Action Response
CLICKUP_GET_TASK_COMMENTS
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
Action Response
CLICKUP_GET_TASK_MEMBERS
View the people who have access to a task.
Action Parameters
Action Response
CLICKUP_GET_TASK_S_TIME_IN_STATUS
View how long a task has been in each status. the total time in status clickapp must first be enabled by the workspace owner or an admin.
Action Parameters
Action Response
CLICKUP_GET_TASK_TEMPLATES
View the task templates available in a workspace.
Action Parameters
Action Response
CLICKUP_GET_TEAMS
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
Action Response
CLICKUP_GET_TIME_ENTRIES_WITHIN_A_DATE_RANGE
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
Action Response
CLICKUP_GET_TIME_ENTRY_HISTORY
View a list of changes made to a time entry.
Action Parameters
Action Response
CLICKUP_GET_TRACKED_TIME
note: this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.
Action Parameters
Action Response
CLICKUP_GET_USER
View information about a user in a workspace. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_GET_VIEW
View information about a specific task or page view.
Action Parameters
Action Response
CLICKUP_GET_VIEW_TASKS
See all visible tasks in a view in clickup.
Action Parameters
Action Response
CLICKUP_GET_WEBHOOKS
View the webhooks created via the api for a workspace. this endpoint returns webhooks created by the authenticated user.
Action Parameters
Action Response
CLICKUP_GET_WORKSPACE_EVERYTHING_LEVEL_VIEWS
View the task and page views available at the everything level of a workspace.
Action Parameters
Action Response
CLICKUP_GET_WORKSPACE_PLAN
View the current plan for the specified workspace.
Action Parameters
Action Response
CLICKUP_GET_WORKSPACE_SEATS
View the used, total, and available member and guest seats for a workspace.
Action Parameters
Action Response
CLICKUP_INVITE_GUEST_TO_WORKSPACE
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
Action Response
CLICKUP_INVITE_USER_TO_WORKSPACE
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
Action Response
CLICKUP_LISTS_GET_FOLDER_LISTS
View the lists within a folder.(DEPRECATED use get_lists)
Action Parameters
Action Response
CLICKUP_MEMBERS_GET_LIST_USERS
View the people who have access to a list.(DEPRECATED use get_list_members)
Action Parameters
Action Response
CLICKUP_REMOVE_CUSTOM_FIELD_VALUE
Remove the data from a custom field on a task. this does not delete the option from the custom field.
Action Parameters
Action Response
CLICKUP_REMOVE_GUEST_FROM_FOLDER
Revoke a guest’s access to a folder. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_REMOVE_GUEST_FROM_LIST
Revoke a guest’s access to a list. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_REMOVE_GUEST_FROM_TASK
Revoke a guest’s access to a task. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_REMOVE_GUEST_FROM_WORKSPACE
Revoke a guest’s access to a workspace. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_REMOVE_TAGS_FROM_TIME_ENTRIES
Remove labels from time entries. this does not remove the label from a workspace.
Action Parameters
Action Response
CLICKUP_REMOVE_TAG_FROM_TASK
Remove a tag from a task. this does not delete the tag from the space.
Action Parameters
Action Response
CLICKUP_REMOVE_TASK_FROM_LIST
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
Action Response
CLICKUP_REMOVE_USER_FROM_WORKSPACE
Deactivate a user from a workspace. note: this endpoint is only available to workspaces on our enterprise plan.
Action Parameters
Action Response
CLICKUP_SET_CUSTOM_FIELD_VALUE
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
Action Response
CLICKUP_SPACES_GET_DETAILS
View the spaces available in a workspace.(DEPRECATED use get_space)
Action Parameters
Action Response
CLICKUP_SPACES_GET_SPACE_DETAILS
View the spaces avialable in a workspace. you can only get member info in private spaces.(DEPRECATED use get_spaces)
Action Parameters
Action Response
CLICKUP_START_A_TIME_ENTRY
Start a timer for the authenticated user.
Action Parameters
Action Response
CLICKUP_STOP_A_TIME_ENTRY
Stop a timer that’s currently running for the authenticated user.
Action Parameters
Action Response
CLICKUP_TASKS_GET_LIST_TASKS
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
Action Response
CLICKUP_TASKS_GET_TASK_DETAILS
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
Action Response
CLICKUP_TASK_CHECKLISTS_CREATE_NEW_CHECKLIST
Add a new checklist to a task.(DEPRECATED use create_checklist)
Action Parameters
Action Response
CLICKUP_TEAMS_USER_GROUPS_CREATE_TEAM
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
Action Response
CLICKUP_TEAMS_WORK_SPACES_GET_WORK_SPACE_PLAN
View the current plan for the specified workspace.(DEPRECATED use get_workspace_plan)
Action Parameters
Action Response
CLICKUP_TEAMS_WORK_SPACES_GET_WORK_SPACE_SEATS
View the used, total, and available member and guest seats for a workspace.(DEPRECATED use get_workspace_seats)
Action Parameters
Action Response
CLICKUP_TRACK_TIME
note: this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.
Action Parameters
Action Response
CLICKUP_UPDATE_A_TIME_ENTRY
Update the details of a time entry.
Action Parameters
Action Response
CLICKUP_UPDATE_COMMENT
Replace the content of a task commment, assign a comment, and mark a comment as resolved.
Action Parameters
Action Response
CLICKUP_UPDATE_FOLDER
Rename a folder.
Action Parameters
Action Response
CLICKUP_UPDATE_GOAL
Rename a goal, set the due date, replace the description, add or remove owners, and set the goal color.
Action Parameters
Action Response
CLICKUP_UPDATE_LIST
Rename a list, update the list info description, set a due date/time, set the list’s priority, set an assignee, set or remove the list color.
Action Parameters
Action Response
CLICKUP_UPDATE_SPACE
Rename, set the space color, and enable clickapps for a space.
Action Parameters
Action Response
CLICKUP_UPDATE_TASK
Update a task by including one or more fields in the request body.
Action Parameters
Action Response
CLICKUP_UPDATE_TEAM
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
Action Response
CLICKUP_UPDATE_VIEW
Rename a view, update the grouping, sorting, filters, columns, and settings of a view.
Action Parameters
Action Response
CLICKUP_UPDATE_WEBHOOK
Update a webhook to change the events to be monitored.
Action Parameters
Action Response
CLICKUP_VIEWS_GET_EVERYTHING_LEVEL
View the task and page views available at the everything level of a workspace.(DEPRECATED use get_workspace_everything_level_views)
Action Parameters
Action Response
CLICKUP_VIEWS_SPACE_VIEWS_GET
View the task and page views available for a space.(DEPRECATED use get_space_views)
Action Parameters
Action Response