Skip to main content

ClickUp Connector

ClickUp Use the ClickUp component to manage users, projects, and teams in your ClickUp workspace.

Connections

ClickUp OAuth 2.0

ClickUp OAuth 2.0

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Client IDFollow this step to generate https://clickup.com/api/developer-portal/authentication/#step-1-create-an-oauth-app
Client SecretFollow this step to generate https://clickup.com/api/developer-portal/authentication/#step-1-create-an-oauth-app

ClickUp Personal Access Token

ClickUp Personal Access Token

InputCommentsDefault
Personal Access TokenFollow the next steps to get an API key https://help.clickup.com/hc/en-us/articles/6303426241687-Getting-Started-with-the-ClickUp-API#personal-api-key

Triggers

Webhook

Receive and validate webhook requests from ClickUp for webhooks you configure.

Actions

Add Guest to Folder

Share a Folder with a guest.

InputCommentsDefault
Connection
Folder IDFolder ID
Guest IDGuest ID
Include SharedExclude details of items shared with the guest by setting this parameter to falsetrue
Permission LevelCan be read (view only), comment, edit, or create (full).create
Debug RequestEnabling this flag will log out the current request.false

Add Guest to List

Share a List with a guest.

InputCommentsDefault
Connection
List IDList ID
Guest IDGuest ID
Include SharedExclude details of items shared with the guest by setting this parameter to falsetrue
Permission LevelCan be read (view only), comment, edit, or create (full).create
Debug RequestEnabling this flag will log out the current request.false

Add Guest to Task

Share a task with a guest.

InputCommentsDefault
Connection
Task IDTask ID
Guest IDGuest ID
Include SharedExclude details of items shared with the guest by setting this parameter to falsetrue
Custom Task IDIf you want to reference a task by its Custom Task ID, this value must be true.true
Team IDOnly used when the custom_task_ids parameter is set to true
Permission LevelCan be read (view only), comment, edit, or create (full).
Debug RequestEnabling this flag will log out the current request.false

Add Task to List

Add a new task to an additional List.

InputCommentsDefault
Connection
List IDList ID
Task IDTask ID
Debug RequestEnabling this flag will log out the current request.false

Create Folder

Add a new Folder to a Space.

InputCommentsDefault
Connection
Space IDSpace ID value.
NameFolder Name
Debug RequestEnabling this flag will log out the current request.false

Create List

Add a new list to a folder.

InputCommentsDefault
Connection
Folder IDFolder ID
NameName of the new list
ContentContent
Due DateInitial due date of the new list
Due Date TimeDue Date Timefalse
PriorityInitial priority of the new list
AssigneeInclude a user_id to assign this List.
StatusStatus refers to the List color rather than the task Statuses available in the List.
NameName of the new list
Debug RequestEnabling this flag will log out the current request.false

Create Space

Add a new Space to a Workspace.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Space NameSpace Name
Multiple AssigneesWill this Space have multiple assignees?true
Enable Due DatesEnable Due Dates?true
Use Start DateUse Start Date?true
Remap Due DatesRemap Due Dates?true
Remap closed Due DatesRemap closed Due Dates?false
Enable Time TrackingEnable Time Tracking?true
Enable TagsEnable Tags?true
Enable Time EstimatesEnable Time Estimates?true
Enable ChecklistsEnable Checklists?true
Enable Custom FieldsEnable Custom Fields?true
Enable Remap DependenciesEnable Remap Dependencies?true
Enable Dependency WarningEnable Dependency Warning?true
Enable PortfoliosEnable Portfolios?true
Debug RequestEnabling this flag will log out the current request.false

Create Task

Create a new Task

InputCommentsDefault
Connection
List IDList ID
Custom Task IDIf you want to reference a task by it's custom task id, this value must be true.false
Team IDOnly used when the custom_task_ids parameter is set to true.
NameTask Name
DescriptionTask Description
Markdown DescriptionMarkdown formatted description.
AssigneeTask Assignees
TagTask Tags
StatusTask Status
PriorityTask Priority
Due DateTask Due Date
Due Date TimeTask Due Date Timefalse
Time EstimateTask Time Estimate
Start DateTask Start Date
Start Date TimeTask Start Date Timefalse
Notify AllIf notify_all is true, notifications will be sent to everyone including the creator of the comment.true
ParentYou can create a subtask by including an existing task ID. The parent task ID you include cannot be a subtask, and must be in the same List specified in the path parameter.
Links ToInclude a task ID to create a linked dependency with your new task.
Check Required Custom FieldsWhen creating a task via API any required Custom Fields are ignored by default (false).false
Custom Fields
Debug RequestEnabling this flag will log out the current request.false

Create Task Attachment

Upload a file to a task as an attachment.

InputCommentsDefault
Connection
Task IDTask ID
Custom Task IDIf you want to reference a task by it's custom task id, this value must be true.false
Team IDOnly used when the custom_task_ids parameter is set to true.
FileFile to attach.
File NameName of the file to attach.
Debug RequestEnabling this flag will log out the current request.false

Create Task Comment

Add a new comment to a task.

InputCommentsDefault
Connection
Task IDTask ID
Custom Task IDIf you want to reference a task by it's custom task id, this value must be true.false
Team IDOnly used when the custom_task_ids parameter is set to true.
Comment TextComment Text
Notify AllIf notify_all is true, notifications will be sent to everyone including the creator of the comment.true
AssigneeAssignee by ID
Debug RequestEnabling this flag will log out the current request.false

Create Team

This endpoint is used to create Teams: user groups which are groups of users you can assign items to in your Workspace.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
NameDesired Team Name
MemberAdd user by ID
Debug RequestEnabling this flag will log out the current request.false

Create Time Entry

Create a time entry.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Custom Task IDIf you want to reference a task by it's custom task id, this value must be true.false
Custom Team IDOnly used when the custom_task_ids parameter is set to true.
DescriptionDescription
StartStart time
Include SubtasksBillablefalse
DurationDuration
AssigneeWorkspace owners and admins can include unknown user id. Workspace members can only include their own user id.
Task IDAssociate a time entry with a task by ID
TagsCode should have this format
Debug RequestEnabling this flag will log out the current request.false

Create Webhook

Create a new webhook for a specific List.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace)
EndpointURL of the webhook endpoint.
Space IDSpace ID
EventEvent type to trigger the webhook.
Folder IDFolder ID
List IDList ID
Task IDTask ID
Debug RequestEnabling this flag will log out the current request.false

Delete Comment

Delete a task comment.

InputCommentsDefault
Connection
Comment IDComment ID
Debug RequestEnabling this flag will log out the current request.false

Delete Folder

Delete a Folder from your Workspace.

InputCommentsDefault
Connection
Folder IDFolder ID
Debug RequestEnabling this flag will log out the current request.false

Delete List

Delete a List from your Workspace.

InputCommentsDefault
Connection
List IDList ID
Debug RequestEnabling this flag will log out the current request.false

Delete Space

Delete a Space from your Workspace.

InputCommentsDefault
Connection
Space IDSpace ID value.
Debug RequestEnabling this flag will log out the current request.false

Delete Task

Delete a task from your Workspace.

InputCommentsDefault
Connection
Task IDTask ID
Custom Task IDIf you want to reference a task by it's custom task id, this value must be true.false
Team IDOnly used when the custom_task_ids parameter is set to true.
Debug RequestEnabling this flag will log out the current request.false

Delete Team

This endpoint is used to remove a Team: user group from your Workspace.

InputCommentsDefault
Connection
Group IDTeam ID (user group).
Debug RequestEnabling this flag will log out the current request.false

Delete Time Entry

Delete a time entry from a Workspace.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Timer IDThe ID of a time entry.
Debug RequestEnabling this flag will log out the current request.false

Delete Webhook

Delete a webhook.

InputCommentsDefault
Connection
Webhook IDWebhook ID
Debug RequestEnabling this flag will log out the current request.false

Edit Guest on Workspace

Rename and configure options for a guest.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Username
Can Edit Tagstrue
Can See Time Spenttrue
Can See Time Estimatedtrue
Can Create Viewstrue
Custom Role IDCustom Role ID value
Guest IDGuest ID
Debug RequestEnabling this flag will log out the current request.false

Edit User On Workspace

Update a user's name and role.

InputCommentsDefault
Team IDTeam ID (Workspace) value
Connection
AdminMake an admin?true
Custom Role IDCustom Role ID value
User IDUser ID value
Debug RequestEnabling this flag will log out the current request.false

Get Accessible Custom Fields

View the Custom Fields available on tasks in a specific List.

InputCommentsDefault
Connection
List IDOnly include time entries associated with tasks in a specific List.
Debug RequestEnabling this flag will log out the current request.false

Get Authorized Teams (Workspaces)

View the Workspaces available to the authenticated user.

InputCommentsDefault
Connection
Debug RequestEnabling this flag will log out the current request.false

Get Folder

View the Lists within a Folder.

InputCommentsDefault
Connection
Folder IDFolder ID
Debug RequestEnabling this flag will log out the current request.false

Get Guest

View information about a guest in a Workspace.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Guest IDGuest ID
Debug RequestEnabling this flag will log out the current request.false

Get List

View details for a specific List.

InputCommentsDefault
Connection
List IDList ID
Debug RequestEnabling this flag will log out the current request.false

Get List Members

View the people who have access to a List.

InputCommentsDefault
Connection
List IDList ID
Debug RequestEnabling this flag will log out the current request.false

Get Singular Time Entry

View a single time entry.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Timer IDThe ID of a time entry.
Include Task TagsInclude task tags in the response for time entries associated with tasks.true
Include Location NamesInclude the names of the List, Folder, and Space along with the list_id,folder_id, and space_id.true
Debug RequestEnabling this flag will log out the current request.false

Get Space

View the Spaces available in a Workspace by ID.

InputCommentsDefault
Connection
Space IDSpace ID value.
Debug RequestEnabling this flag will log out the current request.false

Get Task

View information about a task.

InputCommentsDefault
Connection
Task IDTask ID
Custom Task IDIf you want to reference a task by it's custom task id, this value must be true.false
Team IDOnly used when the custom_task_ids parameter is set to true.
Include SubtasksInclude or exclude subtasks. By default, subtasks are excluded.false
Debug RequestEnabling this flag will log out the current request.false

Get Task Comments

View task comments.

InputCommentsDefault
Connection
Task IDTask ID
Custom Task IDIf you want to reference a task by it's custom task id, this value must be true.false
Team IDOnly used when the custom_task_ids parameter is set to true.
Start IDEnter the Comment id of a task comment.
Start DateUnix time in milliseconds
Debug RequestEnabling this flag will log out the current request.false

Get Task Members

View the members assigned to a task.

InputCommentsDefault
Connection
Task IDTask ID
Debug RequestEnabling this flag will log out the current request.false

Get Team

This endpoint is used to view Teams: user groups in your Workspace.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Group IDsEnter one or more Team ids (user groups) to retrieve information about specific Teams.
Debug RequestEnabling this flag will log out the current request.false

Get Time Entries Within a Date Range

View time entries filtered by start and end date. By default, this endpoint returns time entries from the last 30 days created by the authenticated user.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Start DateUnix time in milliseconds
End DateUnix time in milliseconds
AssigneeFilter by User ID
Include Task TagsInclude task tags in the response for time entries associated with tasks.true
Include Location NamesInclude the names of the List, Folder, and Space along with the list_id,folder_id, and space_id.true
Space IDOnly include time entries associated with tasks in a specific Space.
Folder IDOnly include time entries associated with tasks in a specific Folder.
List IDOnly include time entries associated with tasks in a specific List.
Task IDOnly include time entries associated with a specific task.
Custom Task IDIf you want to reference a task by it's custom task id, this value must be true.false
Custom Team IDOnly used when the custom_task_ids parameter is set to true.
Debug RequestEnabling this flag will log out the current request.false

Get User

View information about a user in a Workspace.

InputCommentsDefault
Team IDTeam ID (Workspace) value
User IDUser ID value
Connection
Debug RequestEnabling this flag will log out the current request.false

Get Webhooks

View all webhooks for a list.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Debug RequestEnabling this flag will log out the current request.false

Get Workspace Plan

View the current Plan for the specified Workspace.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Debug RequestEnabling this flag will log out the current request.false

Get Workspace Seats

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

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Debug RequestEnabling this flag will log out the current request.false

Invite Guest to Workspace

Invite a new guest to a workspace.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
EmailEmail address of the invited guest
Can Edit Tagstrue
Can See Time Spenttrue
Can See Time Estimatedtrue
Can Create Viewstrue
Custom Role IDCustom Role ID value
Debug RequestEnabling this flag will log out the current request.false

Invite User To Workspace

Invite someone to join your Workspace as a member.

InputCommentsDefault
Team IDTeam ID (Workspace) value
Connection
EmailEmail address of User being added
AdminMake an admin?true
Custom Role IDCustom Role ID value
Debug RequestEnabling this flag will log out the current request.false

List Folders

View all folders in a space.

InputCommentsDefault
Connection
Space IDSpace ID value.
ArchivedArchived?false
Debug RequestEnabling this flag will log out the current request.false

List Lists

View the Lists within a Folder.

InputCommentsDefault
Connection
Folder IDFolder ID
ArchivedFilter for archived Lists?false
Debug RequestEnabling this flag will log out the current request.false

List Spaces

View the Spaces available in a Workspace.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Debug RequestEnabling this flag will log out the current request.false

List Tasks

View the tasks in a List.

InputCommentsDefault
Connection
List IDTeam ID (Workspace)
ArchivedArchived?false
Page0
Order ByOrder by a particular field. By default, tasks are ordered by created.
ReverseTasks are displayed in reverse order.false
Include SubtasksInclude or exclude subtasks. By default, subtasks are excluded.false
Include ClosedInclude or excluse closed tasks. By default, they are excluded.false
AssigneeFilter by Assignees. Add Assingee
TagFilter by tags. Add a tag to filter.
Due Date Greater ThanFilter by due date greater than Unix time in milliseconds.
Due Date Less ThanFilter by due date less than Unix time in milliseconds.
Date Created Greater ThanFilter by date created greater than Unix time in milliseconds.
Date Created Less ThanFilter by date created less than Unix time in milliseconds.
Date Updated Greater ThanFilter by date updated greater than Unix time in milliseconds.
Date Updated Less ThanFilter by date updated less than Unix time in milliseconds.
Date Done Greater ThanFilter by date done greater than Unix time in milliseconds.
Date Done Less ThanFilter by date done less than Unix time in milliseconds.
Custom FieldsCode should have this format
Debug RequestEnabling this flag will log out the current request.false

Raw Request

Send raw HTTP request to ClickUp

InputCommentsDefault
Connection
URLInput the path only (/space/${spaceId}/tag), The base URL is already included (https://api.clickup.com/api/v2). For example, to connect to https://api.clickup.com/api/v2/space/${spaceId}/tag, only /space/${spaceId}/tag is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Remove Custom Field Value

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

InputCommentsDefault
Connection
Task IDEnter the task ID of the task you want to update.
Field IDEnter the universal unique identifier (UUID) of the Custom Field you want to set.
Custom Task IDIf you want to reference a task by its Custom Task ID, this value must be true.true
Team IDOnly used when the custom_task_ids parameter is set to true
Debug RequestEnabling this flag will log out the current request.false

Remove Guest From Folder

Revoke a guest's access to a Folder.

InputCommentsDefault
Connection
Folder IDFolder ID
Guest IDGuest ID
Include SharedExclude details of items shared with the guest by setting this parameter to falsetrue
Debug RequestEnabling this flag will log out the current request.false

Remove Guest From List

Revoke a guest's access to a List.

InputCommentsDefault
Connection
List IDList ID
Guest IDGuest ID
Include SharedExclude details of items shared with the guest by setting this parameter to falsetrue
Debug RequestEnabling this flag will log out the current request.false

Remove Guest From Task

Revoke a guest's access to a task.

InputCommentsDefault
Connection
Task IDTask ID
Guest IDGuest ID
Include SharedExclude details of items shared with the guest by setting this parameter to falsetrue
Custom Task IDIf you want to reference a task by its Custom Task ID, this value must be true.true
Team IDOnly used when the custom_task_ids parameter is set to true
Debug RequestEnabling this flag will log out the current request.false

Remove Guest From Workspace

Revoke a guest's access to a Workspace.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Guest IDGuest ID
Debug RequestEnabling this flag will log out the current request.false

Remove Task From List

Remove a task from an additional List. You can't remove a task from its home List.

InputCommentsDefault
Connection
List IDList ID
Task IDTask ID
Debug RequestEnabling this flag will log out the current request.false

Remove User From Workspace

Deactivate a user from a Workspace.

InputCommentsDefault
Team IDTeam ID (Workspace) value
Connection
User IDUser ID value
Debug RequestEnabling this flag will log out the current request.false

Set Custom Field Value

Update the value of a Custom Field on a task.

InputCommentsDefault
Connection
Task IDEnter the task ID of the task you want to update.
Field IDEnter the universal unique identifier (UUID) of the Custom Field you want to set.
Field Value
Value Type
Debug RequestEnabling this flag will log out the current request.false

Start a Time Entry

Start a timer for the authenticated user.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Custom Task IDIf you want to reference a task by it's custom task id, this value must be true.false
Custom Team IDOnly used when the custom_task_ids parameter is set to true.
DescriptionDescription
Include SubtasksBillablefalse
Task IDAssociate a time entry with a task by ID
Tag nameAdd a tag name
Debug RequestEnabling this flag will log out the current request.false

Stop a Time Entry

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

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Debug RequestEnabling this flag will log out the current request.false

Update Comment

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

InputCommentsDefault
Connection
Comment IDComment ID
Comment TextComment Text
ResolvedResolved?false
AssigneeAssignee by ID
Debug RequestEnabling this flag will log out the current request.false

Update Folder

Rename a Folder

InputCommentsDefault
Connection
Folder IDFolder ID
NameFolder Name
Debug RequestEnabling this flag will log out the current request.false

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.

InputCommentsDefault
Connection
List IDList ID
NameName of the list
ContentContent
Due DateDue date of the list
Due Date TimeSet to true if due date has a timefalse
PriorityPriority of the list
AssigneeUser ID of the list assignee
StatusStatus refers to the List color rather than the task Statuses available in the List.
Unset StatusBy default, this is false. To remove the List color use unset_status: true.false
Debug RequestEnabling this flag will log out the current request.false

Update Space

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

InputCommentsDefault
Connection
Space IDSpace ID value.
Space NameSpace Name
Multiple AssigneesWill this Space have multiple assignees?true
Enable Due DatesEnable Due Dates?true
Use Start DateUse Start Date?true
Remap Due DatesRemap Due Dates?true
Remap closed Due DatesRemap closed Due Dates?false
Enable Time TrackingEnable Time Tracking?true
Enable TagsEnable Tags?true
Enable Time EstimatesEnable Time Estimates?true
Enable ChecklistsEnable Checklists?true
Enable Custom FieldsEnable Custom Fields?true
Enable Remap DependenciesEnable Remap Dependencies?true
Enable Dependency WarningEnable Dependency Warning?true
Enable PortfoliosEnable Portfolios?true
ColorHex Color Number
PrivatePrivate?true
Admin Can ManageAdmin Can Manage?true
Debug RequestEnabling this flag will log out the current request.false

Update Task

Update a task

InputCommentsDefault
Connection
Task IDTask ID
Custom Task IDIf you want to reference a task by it's custom task id, this value must be true.false
Team IDOnly used when the custom_task_ids parameter is set to true.
NameTask Name
DescriptionTask Description
Markdown DescriptionMarkdown formatted description.
StatusTask Status
PriorityTask Priority
Due DateTask Due Date
Due Date TimeTask Due Date Timefalse
ParentYou can move a subtask to another parent task by including "parent" with a valid task id.
Time EstimateTask Time Estimate
Start DateTask Start Date
Start Date TimeTask Start Date Timefalse
Add AssigneeAdd Assignee
Remove AssigneeRemove Assignee
ArchivedInclude Archived?false
Debug RequestEnabling this flag will log out the current request.false

Update Team

This endpoint is used to manage Teams: user groups which are groups of users you can assign items to in your Workspace

InputCommentsDefault
Connection
Group IDTeam ID (user group).
Team NameDesired Team Name
Team HandleYou may update the team handle which is used to @mention a Team (user group) in your Workspace.
Add MemberAdd members by ID. Comma separate each user ID.
Remove MemberRemove members by ID. Comma separate each user ID.
Debug RequestEnabling this flag will log out the current request.false

Update Time Entry

Update the details of a time entry.

InputCommentsDefault
Connection
Team IDTeam ID (Workspace) value
Custom Task IDIf you want to reference a task by it's custom task id, this value must be true.false
Custom Team IDOnly used when the custom_task_ids parameter is set to true.
DescriptionDescription
StartStart time
Include SubtasksBillablefalse
DurationDuration
AssigneeWorkspace owners and admins can include unknown user id. Workspace members can only include their own user id.
Task IDAssociate a time entry with a task by ID
Timer IDThe ID of a time entry.
Tag ActionTag Action (use replace, add or remove)
EndEnd time
TagsCode should have this format
Debug RequestEnabling this flag will log out the current request.false

Update Webhook

Update the configuration of a webhook.

InputCommentsDefault
Connection
Webhook IDWebhook ID
EndpointURL of the webhook endpoint.
All EventsSubscribe to all events, when set to true it overrides the event inputsfalse
EventEvent type to trigger the webhook.
StatusStatus
Debug RequestEnabling this flag will log out the current request.false