ClickUp Component

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

Component key: click-up ·

· Changelog ↓

Description

ClickUp ClickUp is a CRM, collaboration, knowledge base, and project management tool.

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

Connections

Personal Access Token

key: apiKey

Personal API token Configuration Instructions

To make API requests to ClickUp using a personal API token you may generate one using the following Personal API token steps.

Log into ClickUp.
Click on your avatar in the lower-left corner and select Apps.
Under API Token, click Generate.
You can copy and paste your personal API token.

Input	Notes	Example
Personal Access Token	Your ClickUp Personal Access Token. Generate one in ClickUp Settings > Apps > API Token. See <a href="https://help.clickup.com/hc/en-us/articles/6303426241687-Getting-Started-with-the-ClickUp-API#personal-api-key">ClickUp API documentation</a>.	pk_123456_ABC123DEF456GHI789

OAuth 2.0

key: clickUpOauth2Connection

Oauth Configuration Instructions

To make API requests of Clickup on behalf of your customers you will need to create an "App" within Clickup. https://clickup.com/api/developer-portal/authentication/#step-1-create-an-oauth-app

Log into ClickUp.
Click on your avatar in the lower-left corner and select Integrations.
Click on ClickUp API.
Click Create an App.
Give your app a name and provide the redirect URL as https://oauth2.prismatic.io/callback
Once your app is created, you'll be provided with a client ID and Secret that may be entered in the connection

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for ClickUp.	https://app.clickup.com/api
Client ID	The Client ID from your ClickUp OAuth app. Create an OAuth app at <a href="https://clickup.com/api/developer-portal/authentication/#step-1-create-an-oauth-app">ClickUp Developer Portal</a>.	ABC123DEF456GHI789
Client Secret	The Client Secret from your ClickUp OAuth app. Create an OAuth app at <a href="https://clickup.com/api/developer-portal/authentication/#step-1-create-an-oauth-app">ClickUp Developer Portal</a>.
Headers	Additional headers to supply to authorization requests.	{"X-Custom-Header": "value"}
Scopes	ClickUp does not support granular scopes.
Token URL	The OAuth 2.0 Token URL for ClickUp.	https://api.clickup.com/api/v2/oauth/token

Triggers

Webhook

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

Data Sources

Calendar Views

A picklist of Calendar Views in a Space | key: calendars | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
Space ID

Custom Field Options

A picklist of Options for a given Custom Field | key: customFieldOptions | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
Field Name		Sales Stage
List ID

Custom Fields

A picklist of Custom Fields | key: customFields | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID

Folders

A picklist of Folders in a Space | key: folders | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
Space ID

Lists

A picklist of available Lists in a given Folder | key: lists | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
Folder ID

Spaces

A picklist of Spaces available in a Workspace | key: spaces | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID

Tasks

A picklist of Tasks in a List | key: tasks | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID

Teams Authorized Workspaces

A picklist of Workspaces available to the authenticated user | key: teams | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.

Actions

Add Guest to Folder

Share a Folder with a guest. | key: addGuestToFolder

Input	Notes	Example
Connection	The ClickUp connection to use.
Folder ID	Folder ID
Guest ID	Guest ID
Include Shared	Exclude details of items shared with the guest by setting this parameter to false	true
Permission Level	Can be read (view only), comment, edit, or create (full).	read

Example Payload for Add Guest to Folder⤓

Loading…

Add Guest to List

Share a List with a guest. | key: addGuestToList

Input	Notes	Example
Connection	The ClickUp connection to use.
Guest ID	Guest ID
Include Shared	Exclude details of items shared with the guest by setting this parameter to false	true
List ID	List ID
Permission Level	Can be read (view only), comment, edit, or create (full).	read

Example Payload for Add Guest to List⤓

Loading…

Add Guest to Task

Share a task with a guest. | key: addGuestToTask

Input	Notes	Example
Connection	The ClickUp connection to use.
Custom Task ID	If you want to reference a task by its Custom Task ID, this value must be true.	true
Guest ID	Guest ID
Include Shared	Exclude details of items shared with the guest by setting this parameter to false	true
Permission Level	Can be read (view only), comment, edit, or create (full).	read
Task ID	Task ID
Team ID	Only used when the custom_task_ids parameter is set to true	9010065123

Example Payload for Add Guest to Task⤓

Loading…

Add Task to List

Add a new task to an additional List. | key: addTaskToList

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	List ID
Task ID	Task ID

Example Payload for Add Task to List⤓

Loading…

Create Folder

Add a new Folder to a Space. | key: createFolder

Input	Notes	Example
Connection	The ClickUp connection to use.
Name	The name of the folder.	My Folder
Space ID	Space ID value.

Example Payload for Create Folder⤓

Loading…

Create List

Add a new list to a folder. | key: createList

Input	Notes	Example
Assignee	Include a user_id to assign this List.	12345678
Connection	The ClickUp connection to use.
Content	Content
Due Date	Initial due date of the new list
Due Date Time	Due Date Time	false
Folder ID	Folder ID
Name	Name of the new list
Name	Name of the new list
Priority	Initial priority of the new list
Status	Status refers to the List color rather than the task Statuses available in the List.

Example Payload for Create List⤓

Loading…

Create Space

Add a new Space to a Workspace. | key: createSpace

Input	Notes	Example
Connection	The ClickUp connection to use.
Enable Checklists	When true, enables checklists for tasks in the Space.	true
Enable Custom Fields	When true, enables custom fields for tasks in the Space.	true
Enable Dependency Warning	When true, enables warnings for task dependency conflicts.	true
Enable Due Dates	When true, enables due dates for tasks in the Space.	true
Enable Portfolios	When true, enables portfolios for the Space.	true
Enable Remap Dependencies	When true, enables remapping of task dependencies when moved.	true
Enable Tags	When true, enables tags for tasks in the Space.	true
Enable Time Estimates	When true, enables time estimates for tasks in the Space.	true
Enable Time Tracking	When true, enables time tracking for tasks in the Space.	true
Multiple Assignees	When true, the Space allows multiple assignees on tasks.	true
Remap closed Due Dates	When true, remaps due dates for closed tasks when moved.	false
Remap Due Dates	When true, remaps due dates when tasks are moved.	true
Space Name	Space Name.	Engineering Space
Team ID	Team ID (Workspace) value.	9010065123
Use Start Date	When true, enables start dates for tasks in the Space.	true

Example Payload for Create Space⤓

Loading…

Create Task

Create a new Task | key: createTask

Input	Notes	Example
Assignee	Task Assignees
Check Required Custom Fields	When creating a task via API any required Custom Fields are ignored by default (false).	false
Connection	The ClickUp connection to use.
Custom Fields	Custom field key-value pairs to set on the task.	{"field_id": "value"}
Custom Task ID	If you want to reference a task by it's custom task id, this value must be true.	false
Description	Task Description
Due Date	Task Due Date	1508369194377
Due Date Time	Task Due Date Time	false
Links To	Include a task ID to create a linked dependency with your new task.
List ID	List ID
Markdown Description	Markdown formatted description.	# Task Description This task involves...
Name	Task Name
Notify All	If notify_all is true, notifications will be sent to everyone including the creator of the comment.	true
Parent	You 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.
Priority	Task Priority
Start Date	Task Start Date	1567780450202
Start Date Time	Task Start Date Time	false
Status	Task Status
Tag	Task Tags
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123
Time Estimate	Task Time Estimate	8640000

Example Payload for Create Task⤓

Loading…

Create Task Attachment

Upload a file to a task as an attachment. | key: createTaskAttachment

Input	Notes	Example
Connection	The ClickUp connection to use.
Custom Task ID	When true, allows referencing a task by its custom task ID.	false
File	File to attach.
File Name	Name of the file to attach.	my-image.png
Task ID	Task ID
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123

Example Payload for Create Task Attachment⤓

Loading…

Create Task Comment

Add a new comment to a task. | key: createTaskComment

Input	Notes	Example
Assignee	Assignee by ID.	12345678
Comment Text	Comment Text
Connection	The ClickUp connection to use.
Custom Task ID	When true, allows referencing a task by its custom task ID.	false
Notify All	If notify_all is true, notifications will be sent to everyone including the creator of the comment.	true
Task ID	Task ID
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123

Example Payload for Create Task Comment⤓

Loading…

Create Team

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

Input	Notes	Example
Connection	The ClickUp connection to use.
Member	Add user by ID.	["12345678", "87654321"]
Name	Desired Team Name.	Engineering Team
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Create Team⤓

Loading…

Create Time Entry

Create a time entry. | key: createTimeEntry

Input	Notes	Example
Assignee	Workspace owners and admins can include unknown user id. Workspace members can only include their own user id.	12345678
Billable	Billable	false
Connection	The ClickUp connection to use.
Custom Task ID	When true, allows referencing a task by its custom task ID.	false
Custom Team ID	Only used when the custom_task_ids parameter is set to true.
Description	Description
Duration	Duration
Start	Start time
Tags	JSON object containing an array of tag objects with name, background color (tag_bg), and foreground color (tag_fg) properties.	`{ "tags": [ { "name": "name of tag", "tag_bg": "#BF55EC", "tag_fg": "#FFFFFF" } ] }`
Task ID	Associate a time entry with a task by ID
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Create Time Entry⤓

Loading…

Create Webhook

Create a new webhook for a specific List. | key: createWebhook

Input	Notes	Example
Connection	The ClickUp connection to use.
Endpoint	URL of the webhook endpoint.
Event	Event type to trigger the webhook.	["taskCreated", "taskUpdated"]
Folder ID	Folder ID
List ID	List ID
Space ID	Space ID
Task ID	Task ID
Team ID	Team ID (Workspace)	9010065123

Example Payload for Create Webhook⤓

Loading…

Delete Comment

Delete a task comment. | key: deleteComment

Input	Notes	Example
Comment ID	Comment ID
Connection	The ClickUp connection to use.

Example Payload for Delete Comment⤓

Loading…

Delete Folder

Delete a Folder from your Workspace. | key: deleteFolder

Input	Notes	Example
Connection	The ClickUp connection to use.
Folder ID	Folder ID

Example Payload for Delete Folder⤓

Loading…

Delete List

Delete a List from your Workspace. | key: deleteList

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	List ID

Example Payload for Delete List⤓

Loading…

Delete Space

Delete a Space from your Workspace. | key: deleteSpace

Input	Notes	Example
Connection	The ClickUp connection to use.
Space ID	Space ID value.

Example Payload for Delete Space⤓

Loading…

Delete Task

Delete a task from your Workspace. | key: deleteTask

Input	Notes	Example
Connection	The ClickUp connection to use.
Custom Task ID	When true, allows referencing a task by its custom task ID.	false
Task ID	Task ID
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123

Example Payload for Delete Task⤓

Loading…

Delete Team

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

Input	Notes	Example
Connection	The ClickUp connection to use.
Group ID	Team ID (user group).	7C73-4002-A6A9-310014852858

Example Payload for Delete Team⤓

Loading…

Delete Time Entry

Delete a time entry from a Workspace. | key: deleteTimeEntry

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	Team ID (Workspace) value.	9010065123
Timer ID	The ID of a time entry.	12345678

Example Payload for Delete Time Entry⤓

Loading…

Delete Webhook

Delete a webhook. | key: deleteWebhook

Input	Notes	Example
Connection	The ClickUp connection to use.
Webhook ID	Webhook ID	e506-4a29-9d42-26e504e3435e

Example Payload for Delete Webhook⤓

Loading…

Edit Guest on Workspace

Rename and configure options for a guest. | key: editGuestOnWorkspace

Input	Notes	Example
Can Create Views		true
Can Edit Tags		true
Can See Time Estimated		true
Can See Time Spent		true
Connection	The ClickUp connection to use.
Custom Role ID	Custom Role ID value.	12345
Guest ID	Guest ID
Team ID	Team ID (Workspace) value.	9010065123
Username

Example Payload for Edit Guest on Workspace⤓

Loading…

Edit User On Workspace

Update a user's name and role. | key: editUserOnWorkspace

Input	Notes	Example
Admin	When true, grants admin privileges to the user.	true
Connection	The ClickUp connection to use.
Custom Role ID	Custom Role ID value.	12345
Team ID	Team ID (Workspace) value.	9010065123
User ID	User ID value.	38312345

Example Payload for Edit User On Workspace⤓

Loading…

Get Accessible Custom Fields

View the Custom Fields available on tasks in a specific List. | key: getAccessibleCustomFields

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	Only include time entries associated with tasks in a specific List.

Example Payload for Get Accessible Custom Fields⤓

Loading…

Get Authorized Teams (Workspaces)

View the Workspaces available to the authenticated user. | key: getAuthorizedTeams

Input	Notes	Example
Connection	The ClickUp connection to use.

Example Payload for Get Authorized Teams (Workspaces)⤓

Loading…

Get Folder

View the Lists within a Folder. | key: getFolder

Input	Notes	Example
Connection	The ClickUp connection to use.
Folder ID	Folder ID

Example Payload for Get Folder⤓

Loading…

Get Guest

View information about a guest in a Workspace. | key: getGuest

Input	Notes	Example
Connection	The ClickUp connection to use.
Guest ID	Guest ID
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Get Guest⤓

Loading…

Get List

View details for a specific List. | key: getList

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	List ID

Example Payload for Get List⤓

Loading…

Get List Members

View the people who have access to a List. | key: getListMembers

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	List ID

Example Payload for Get List Members⤓

Loading…

Get Singular Time Entry

View a single time entry. | key: getSingularTimeEntry

Input	Notes	Example
Connection	The ClickUp connection to use.
Include Location Names	When true, includes the names of the List, Folder, and Space along with the list_id, folder_id, and space_id.	true
Include Task Tags	When true, includes task tags in the response for time entries associated with tasks.	true
Team ID	Team ID (Workspace) value.	9010065123
Timer ID	The ID of a time entry.	12345678

Example Payload for Get Singular Time Entry⤓

Loading…

Get Space

View the Spaces available in a Workspace by ID. | key: getSpace

Input	Notes	Example
Connection	The ClickUp connection to use.
Space ID	Space ID value.

Example Payload for Get Space⤓

Loading…

Get Task

View information about a task. | key: getTask

Input	Notes	Example
Connection	The ClickUp connection to use.
Custom Task ID	When true, allows referencing a task by its custom task ID.	false
Include Subtasks	Include or exclude subtasks. By default, subtasks are excluded.	false
Task ID	Task ID
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123

Example Payload for Get Task⤓

Loading…

Get Task Comments

View task comments. | key: getTaskComments

Input	Notes	Example
Connection	The ClickUp connection to use.
Custom Task ID	When true, allows referencing a task by its custom task ID.	false
Start Date	Unix time in milliseconds.	1609459200000
Start ID	Enter the Comment id of a task comment.
Task ID	Task ID
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123

Example Payload for Get Task Comments⤓

Loading…

Get Task Members

View the members assigned to a task. | key: getTaskMembers

Input	Notes	Example
Connection	The ClickUp connection to use.
Task ID	Task ID

Example Payload for Get Task Members⤓

Loading…

Get Team

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

Input	Notes	Example
Connection	The ClickUp connection to use.
Group IDs	Enter one or more Team IDs (user groups) to retrieve information about specific Teams.	C9C58BE9-7C73-4002-A6A9-310014852858
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Get Team⤓

Loading…

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. | key: getTimeEntriesWithinDateRange

Input	Notes	Example
Assignee	Filter by User ID
Connection	The ClickUp connection to use.
Custom Task ID	When true, allows referencing a task by its custom task ID.	false
Custom Team ID	Only used when the custom_task_ids parameter is set to true.
End Date	Unix time in milliseconds.	1609459200000
Folder ID	Only include time entries associated with tasks in a specific Folder.
Include Location Names	When true, includes the names of the List, Folder, and Space along with the list_id, folder_id, and space_id.	true
Include Task Tags	When true, includes task tags in the response for time entries associated with tasks.	true
List ID	Only include time entries associated with tasks in a specific List.
Space ID	Only include time entries associated with tasks in a specific Space.
Start Date	Unix time in milliseconds.	1609459200000
Task ID	Only include time entries associated with a specific task.
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Get Time Entries Within a Date Range⤓

Loading…

Get User

View information about a user in a Workspace. | key: getUser

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	Team ID (Workspace) value.	9010065123
User ID	User ID value.	38312345

Example Payload for Get User⤓

Loading…

Get Webhooks

View all webhooks for a list. | key: getWebhooks

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Get Webhooks⤓

Loading…

Get Workspace Plan

View the current Plan for the specified Workspace. | key: getWorkspacePlan

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Get Workspace Plan⤓

Loading…

Get Workspace Seats

View the used, total, and available member and guest seats for a Workspace. | key: getWorkspaceSeats

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Get Workspace Seats⤓

Loading…

Invite Guest to Workspace

Invite a new guest to a workspace. | key: inviteGuestToWorkspace

Input	Notes	Example
Can Create Views		true
Can Edit Tags		true
Can See Time Estimated		true
Can See Time Spent		true
Connection	The ClickUp connection to use.
Custom Role ID	Custom Role ID value.	12345
Email	Email address of the invited guest	john.doe@example.com
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Invite Guest to Workspace⤓

Loading…

Invite User To Workspace

Invite someone to join your Workspace as a member. | key: inviteUserToWorkspace

Input	Notes	Example
Admin	When true, grants admin privileges to the user.	true
Connection	The ClickUp connection to use.
Custom Role ID	Custom Role ID value.	12345
Email	Email address of User being added	john.doe@example.com
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Invite User To Workspace⤓

Loading…

List Folders

View all folders in a space. | key: listFolders

Input	Notes	Example
Archived	Archived?	false
Connection	The ClickUp connection to use.
Space ID	Space ID value.

Example Payload for List Folders⤓

Loading…

List Lists

View the Lists within a Folder. | key: getLists

Input	Notes	Example
Archived	Filter for archived Lists?	false
Connection	The ClickUp connection to use.
Folder ID	Folder ID

Example Payload for List Lists⤓

Loading…

List Spaces

View the Spaces available in a Workspace. | key: listSpaces

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for List Spaces⤓

Loading…

List Tasks

View the tasks in a List. | key: listTasks

Input	Notes	Example
Archived	Archived?	false
Assignee	Filter by Assignees. Add Assingee
Connection	The ClickUp connection to use.
Custom Fields	JSON object containing an array of custom field filters. Each filter has a field_id, operator (=, <, >, <=, >=, !=), and value.	`{ "custom_fields": [ { "field_id": "abcdefghi12345678", "operator": "=", "value": "1234" }, { "field_id": "jklmnop123456", "operator": "<", "value": "5" } ] }`
Date Created Greater Than	Filter by date created greater than Unix time in milliseconds.	1609459200000
Date Created Less Than	Filter by date created less than Unix time in milliseconds.	1609459200000
Date Done Greater Than	Filter by date done greater than Unix time in milliseconds.	1609459200000
Date Done Less Than	Filter by date done less than Unix time in milliseconds.	1609459200000
Date Updated Greater Than	Filter by date updated greater than Unix time in milliseconds.	1609459200000
Date Updated Less Than	Filter by date updated less than Unix time in milliseconds.	1609459200000
Due Date Greater Than	Filter by due date greater than Unix time in milliseconds.	1609459200000
Due Date Less Than	Filter by due date less than Unix time in milliseconds.	1609459200000
Include Closed	When true, includes closed tasks in the results. By default, they are excluded.	false
List ID	Team ID (Workspace)
Order By	Order by a particular field. By default, tasks are ordered by created.	created
Page	The page number for pagination.	0
Reverse	When true, tasks are displayed in reverse order.	false
Include Subtasks	Include or exclude subtasks. By default, subtasks are excluded.	false
Tag	Filter by tags. Add a tag to filter.

Example Payload for List Tasks⤓

Loading…

Raw Request

Send raw HTTP request to ClickUp | key: rawRequest

Input	Notes	Example
Connection	The ClickUp connection to use.
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A 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.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If 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
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input 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.	/space/${spaceId}/tag
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Example Payload for Raw Request⤓

Loading…

Remove Custom Field Value

Remove the data from a Custom Field on a task. This does not delete the option from the Custom Field. | key: removeCustomFieldValue

Input	Notes	Example
Connection	The ClickUp connection to use.
Custom Task ID	If you want to reference a task by its Custom Task ID, this value must be true.	true
Field ID	Enter the universal unique identifier (UUID) of the Custom Field you want to set.
Task ID	Enter the task ID of the task you want to update.
Team ID	Only used when the custom_task_ids parameter is set to true	9010065123

Example Payload for Remove Custom Field Value⤓

Loading…

Remove Guest From Folder

Revoke a guest's access to a Folder. | key: removeGuestFromFolder

Input	Notes	Example
Connection	The ClickUp connection to use.
Folder ID	Folder ID
Guest ID	Guest ID
Include Shared	Exclude details of items shared with the guest by setting this parameter to false	true

Example Payload for Remove Guest From Folder⤓

Loading…

Remove Guest From List

Revoke a guest's access to a List. | key: removeGuestFromList

Input	Notes	Example
Connection	The ClickUp connection to use.
Guest ID	Guest ID
Include Shared	Exclude details of items shared with the guest by setting this parameter to false	true
List ID	List ID

Example Payload for Remove Guest From List⤓

Loading…

Remove Guest From Task

Revoke a guest's access to a task. | key: removeGuestFromTask

Input	Notes	Example
Connection	The ClickUp connection to use.
Custom Task ID	If you want to reference a task by its Custom Task ID, this value must be true.	true
Guest ID	Guest ID
Include Shared	Exclude details of items shared with the guest by setting this parameter to false	true
Task ID	Task ID
Team ID	Only used when the custom_task_ids parameter is set to true	9010065123

Example Payload for Remove Guest From Task⤓

Loading…

Remove Guest From Workspace

Revoke a guest's access to a Workspace. | key: removeGuestFromWorkspace

Input	Notes	Example
Connection	The ClickUp connection to use.
Guest ID	Guest ID
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Remove Guest From Workspace⤓

Loading…

Remove Task From List

Remove a task from an additional List. You can't remove a task from its home List. | key: removeTaskFromList

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	List ID
Task ID	Task ID

Example Payload for Remove Task From List⤓

Loading…

Remove User From Workspace

Deactivate a user from a Workspace. | key: removeUserFromWorkspace

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	Team ID (Workspace) value.	9010065123
User ID	User ID value.	38312345

Example Payload for Remove User From Workspace⤓

Loading…

Set Custom Field Value

Update the value of a Custom Field on a task. | key: setCustomFieldValue

Input	Notes	Example
Connection	The ClickUp connection to use.
Field ID	Enter the universal unique identifier (UUID) of the Custom Field you want to set.
Field Value	The value to set for the custom field.
Task ID	Enter the task ID of the task you want to update.
Value Type	The type of the value being set.

Example Payload for Set Custom Field Value⤓

Loading…

Start a Time Entry

Start a timer for the authenticated user. | key: startTimeEntry

Input	Notes	Example
Billable	Billable	false
Connection	The ClickUp connection to use.
Custom Task ID	When true, allows referencing a task by its custom task ID.	false
Custom Team ID	Only used when the custom_task_ids parameter is set to true.
Description	Description
Tag name	Add a tag name
Task ID	Associate a time entry with a task by ID
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Start a Time Entry⤓

Loading…

Stop a Time Entry

Stop a timer that's currently running for the authenticated user. | key: stopTimeEntry

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	Team ID (Workspace) value.	9010065123

Example Payload for Stop a Time Entry⤓

Loading…

Update Comment

Replace the content of a task comment, assign a comment, and mark a comment as resolved. | key: updateComment

Input	Notes	Example
Assignee	Assignee by ID.	12345678
Comment ID	Comment ID
Comment Text	Comment Text
Connection	The ClickUp connection to use.
Resolved	Resolved?	false

Example Payload for Update Comment⤓

Loading…

Update Folder

Rename a Folder | key: updateFolder

Input	Notes	Example
Connection	The ClickUp connection to use.
Folder ID	Folder ID
Name	The name of the folder.	My Folder

Example Payload for Update Folder⤓

Loading…

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. | key: updateList

Input	Notes	Example
Assignee	User ID of the list assignee
Connection	The ClickUp connection to use.
Content	Content
Due Date	Due date of the list
Due Date Time	Set to true if due date has a time	false
List ID	List ID
Name	Name of the list
Priority	Priority of the list
Status	Status refers to the List color rather than the task Statuses available in the List.
Unset Status	By default, this is false. To remove the List color use unset_status: true.	false

Example Payload for Update List⤓

Loading…

Update Space

Rename, set the Space color, and enable ClickApps for a Space. | key: updateSpace

Input	Notes	Example
Admin Can Manage	When true, admins can manage the Space.	true
Connection	The ClickUp connection to use.
Color	Hex color code.	#7B68EE
Enable Checklists	When true, enables checklists for tasks in the Space.	true
Enable Custom Fields	When true, enables custom fields for tasks in the Space.	true
Enable Dependency Warning	When true, enables warnings for task dependency conflicts.	true
Enable Due Dates	When true, enables due dates for tasks in the Space.	true
Enable Portfolios	When true, enables portfolios for the Space.	true
Enable Remap Dependencies	When true, enables remapping of task dependencies when moved.	true
Enable Tags	When true, enables tags for tasks in the Space.	true
Enable Time Estimates	When true, enables time estimates for tasks in the Space.	true
Enable Time Tracking	When true, enables time tracking for tasks in the Space.	true
Multiple Assignees	When true, the Space allows multiple assignees on tasks.	true
Private	When true, the Space is private.	true
Remap closed Due Dates	When true, remaps due dates for closed tasks when moved.	false
Remap Due Dates	When true, remaps due dates when tasks are moved.	true
Space ID	Space ID value.
Space Name	Space Name.	Engineering Space
Use Start Date	When true, enables start dates for tasks in the Space.	true

Example Payload for Update Space⤓

Loading…

Update Task

Update a task | key: updateTask

Input	Notes	Example
Add Assignee	Add Assignee
Archived	Include Archived?	false
Connection	The ClickUp connection to use.
Custom Task ID	If you want to reference a task by it's custom task id, this value must be true.	false
Description	Task Description
Due Date	Task Due Date	1508369194377
Due Date Time	Task Due Date Time	false
Markdown Description	Markdown formatted description.	# Task Description This task involves...
Name	Task Name
Parent	You can move a subtask to another parent task by including "parent" with a valid task id.
Priority	Task Priority
Remove Assignee	Remove Assignee
Start Date	Task Start Date	1567780450202
Start Date Time	Task Start Date Time	false
Status	Task Status
Task ID	Task ID
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123
Time Estimate	Task Time Estimate	8640000

Example Payload for Update Task⤓

Loading…

Update Team

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

Input	Notes	Example
Add Member	Add members by ID. Comma separate each user ID.	12345,5678
Connection	The ClickUp connection to use.
Group ID	Team ID (user group).	7C73-4002-A6A9-310014852858
Remove Member	Remove members by ID. Comma separate each user ID.	12345,5678
Team Handle	You may update the team handle which is used to @mention a Team (user group) in your Workspace.	engineering
Team Name	Desired Team Name.	Engineering Team

Example Payload for Update Team⤓

Loading…

Update Time Entry

Update the details of a time entry. | key: updateTimeEntry

Input	Notes	Example
Assignee	Workspace owners and admins can include unknown user id. Workspace members can only include their own user id.	12345678
Billable	Billable	false
Connection	The ClickUp connection to use.
Custom Task ID	When true, allows referencing a task by its custom task ID.	false
Custom Team ID	Only used when the custom_task_ids parameter is set to true.
Description	Description
Duration	Duration
End	End time
Start	Start time
Tag Action	Tag Action (use replace, add or remove).	replace
Tags	JSON object containing an array of tag objects with name, background color (tag_bg), and foreground color (tag_fg) properties.	`{ "tags": [ { "name": "name of tag", "tag_bg": "#BF55EC", "tag_fg": "#FFFFFF" } ] }`
Task ID	Associate a time entry with a task by ID
Team ID	Team ID (Workspace) value.	9010065123
Timer ID	The ID of a time entry.	12345678

Example Payload for Update Time Entry⤓

Loading…

Update Webhook

Update the configuration of a webhook. | key: updateWebhook

Input	Notes	Example
All Events	When true, subscribes to all events and overrides the event inputs.	false
Connection	The ClickUp connection to use.
Endpoint	URL of the webhook endpoint.
Event	Event type to trigger the webhook.	["taskCreated", "taskUpdated"]
Status	Status
Webhook ID	Webhook ID	e506-4a29-9d42-26e504e3435e

Example Payload for Update Webhook⤓

Loading…

Changelog

2026-04-30

Updated spectral version

2026-04-10

Updated Example Payloads

2026-03-31

Various modernizations and documentation updates

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

Description​

Connections​

Personal Access Token​

OAuth 2.0​

Triggers​

Webhook​

Data Sources​

Calendar Views​

Custom Field Options​

Custom Fields​

Folders​

Lists​

Spaces​

Tasks​

Teams Authorized Workspaces​

Actions​

Add Guest to Folder​

Add Guest to List​

Add Guest to Task​

Add Task to List​

Create Folder​

Create List​

Create Space​

Create Task​

Create Task Attachment​

Create Task Comment​

Create Team​

Create Time Entry​

Create Webhook​

Delete Comment​

Delete Folder​

Delete List​

Delete Space​

Delete Task​

Delete Team​

Delete Time Entry​

Delete Webhook​

Edit Guest on Workspace​

Edit User On Workspace​

Get Accessible Custom Fields​

Get Authorized Teams (Workspaces)​

Get Folder​

Get Guest​

Get List​

Get List Members​

Get Singular Time Entry​

Get Space​

Get Task​

Get Task Comments​

Get Task Members​

Get Team​

Get Time Entries Within a Date Range​

Get User​

Get Webhooks​

Get Workspace Plan​

Get Workspace Seats​

Invite Guest to Workspace​

Invite User To Workspace​

List Folders​

List Lists​

List Spaces​

List Tasks​

Raw Request​

Remove Custom Field Value​

Remove Guest From Folder​

Remove Guest From List​

Remove Guest From Task​

Remove Guest From Workspace​

Remove Task From List​

Remove User From Workspace​

Set Custom Field Value​

Start a Time Entry​

Stop a Time Entry​

Update Comment​

Update Folder​

Update List​

Update Space​

Update Task​

Update Team​

Description

Connections

Personal Access Token

OAuth 2.0

Triggers

Webhook

Data Sources

Calendar Views

Custom Field Options

Custom Fields

Folders

Lists

Spaces

Tasks

Teams Authorized Workspaces

Actions

Add Guest to Folder

Add Guest to List

Add Guest to Task

Add Task to List

Create Folder

Create List

Create Space

Create Task

Create Task Attachment

Create Task Comment

Create Team

Create Time Entry

Create Webhook

Delete Comment

Delete Folder

Delete List

Delete Space

Delete Task

Delete Team

Delete Time Entry

Delete Webhook

Edit Guest on Workspace

Edit User On Workspace

Get Accessible Custom Fields

Get Authorized Teams (Workspaces)

Get Folder

Get Guest

Get List

Get List Members

Get Singular Time Entry

Get Space

Get Task

Get Task Comments

Get Task Members

Get Team

Get Time Entries Within a Date Range

Get User

Get Webhooks

Get Workspace Plan

Get Workspace Seats

Invite Guest to Workspace

Invite User To Workspace

List Folders

List Lists

List Spaces

List Tasks

Raw Request

Remove Custom Field Value

Remove Guest From Folder

Remove Guest From List

Remove Guest From Task

Remove Guest From Workspace

Remove Task From List

Remove User From Workspace

Set Custom Field Value

Start a Time Entry

Stop a Time Entry

Update Comment

Update Folder

Update List

Update Space

Update Task

Update Team

Update Time Entry