ClickUp Connector

Source API Docs API Changelog Connector Changelog

Description

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

This component allows managing tasks, lists, folders, and spaces in a ClickUp Workspace.

API Documentation

This component was built using the ClickUp API currently utilizing v2.

Connections

Personal Access Token

key: apiKey

To make API requests to ClickUp using a personal access token, follow the steps below. For full details, see the ClickUp Authentication documentation.

Prerequisites

A ClickUp account

Setup Steps

Log into ClickUp.
Click the avatar in the upper-right corner and select Settings.
In the sidebar, click Apps.
Under API Token, click Generate.
Copy the personal access token.

Configure the Connection

Enter the Personal Access Token into the connection configuration.

Input	Notes	Example
Personal Access Token	The ClickUp Personal Access Token used to authenticate API requests. Generate one in ClickUp Settings > Apps > API Token. See the ClickUp Authentication docs for details.	pk_123456_ABC123DEF456GHI789

OAuth 2.0

key: clickUpOauth2Connection

To make API requests to ClickUp on behalf of end customers, an "App" must be created within ClickUp. See the ClickUp Authentication documentation for full details.

Prerequisites

A ClickUp account with the Workspace owner or admin role

Setup Steps

Log into ClickUp.
Click the avatar in the upper-right corner and select Settings.
In the sidebar, click Apps.
Click Create new app.
Provide an app name and set the redirect URL to https://oauth2.prismatic.io/callback.
Once the app is created, copy the Client ID and Client Secret.

Configure the Connection

Enter the Client ID and Client Secret from the ClickUp app.

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for ClickUp.	https://app.clickup.com/api
Client ID	The Client ID from the ClickUp OAuth app. Create an OAuth app via the ClickUp Developer Portal.	ABC123DEF456GHI789
Client Secret	The Client Secret from the ClickUp OAuth app. Create an OAuth app via the ClickUp Developer Portal.
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

New and Updated Tasks

Retrieves existing and ongoing tasks for a specified ClickUp workspace or list. Load history once, check for changes on a schedule, or both. | key: pollChangesTrigger

Input	Notes	Example
Connection	The ClickUp connection to use.
Look-back Date	The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each record modified on or after this date once, ignoring the field and visibility filters.	2026-01-01
Scope ID	The Team ID or List ID to monitor for changes, depending on the Scope selected above.	9010065123
Scope	Whether to poll tasks across an entire Team (Workspace) or scoped to a single List.
Show New Records	When true, tasks created since the last poll are returned in the trigger payload.	true
Show Updated Records	When true, tasks updated since the last poll are returned in the trigger payload.	true

The New and Updated Tasks polling trigger checks ClickUp on a configured schedule for tasks that were created or modified since the last poll. Unlike webhook-based triggers, polling does not require webhook subscription management and works reliably for low-frequency monitoring scenarios.

How It Works

On each scheduled execution, the trigger:

Reads the last poll timestamp from the polling state. On the first run it starts from the Look-back Date when one is set (an initial sync), or from the current execution time when it is empty, and converts it to Unix milliseconds
Queries the ClickUp tasks API with a date_updated_gt filter, including closed tasks and subtasks, scoped to either an entire Team (Workspace) or a single List depending on the Scope input
Partitions the returned tasks into created and updated buckets by comparing each task's date_created Unix millisecond timestamp against the last poll cutoff. Tasks whose date_created falls after the cutoff land in created, while all others land in updated
Persists the current execution time as the new last-poll timestamp for the next run
Emits the partitioned results in the trigger payload, filtered by the Show New Records and Show Updated Records toggles

On the initial sync, every task modified on or after the Look-back Date is returned once, sorted into created (created on or after that date) or updated, regardless of the Show New Records and Show Updated Records toggles; those toggles apply from the next recurrence on. The whole backlog is fetched in a single recurrence.

The sync window has no fixed upper bound: the trigger stores the time the recurrence started as its position, so the next recurrence resumes from there and nothing is lost. A task modified while the sync is being fetched can appear again in that next recurrence. No payload field marks the handoff.

The Scope and Scope ID inputs still apply to the initial sync.

Batching

Batching is enabled per flow on this trigger: each changed record is dispatched as its own execution, or grouped by the configured batch size. Batch size and batch concurrency can both be overridden per instance. Raising concurrency increases the request volume sent to ClickUp.

To turn it on, select the flow's trigger, open the Flow control tab, and switch on Enable Batching. Under Batch Size, keep Trigger default or choose Custom batch size. Batch Concurrency is optional; leave it blank for no batch-level limit.

With batching off, a downstream step reads the data.created and data.updated arrays:

Unbatched payload

{
  "data": {
    "created": [{ "id": "abc123", "...": "..." }],
    "updated": [{ "id": "def456", "...": "..." }]
  }
}

With batching enabled, those arrays do not exist. Each execution receives one task (or a group of tasks, up to the configured batch size), tagged with how it changed:

Batched item

{ "changeType": "created", "record": { "id": "abc123", "...": "..." } }

Update any step that reads data.created or data.updated before enabling batching. Because batching is enabled per flow, the change affects only that flow, not other flows using this trigger.

Each recurrence still fetches every task changed since the previous one before batching splits them, so a large initial sync is fetched in one recurrence and dispatched across many executions.

Returned Data

The trigger emits a payload with two arrays, created and updated, each containing task resources from ClickUp.

Example Payload

{
  "data": {
    "created": [
      {
        "id": "abc123",
        "name": "New task",
        "date_created": "1716220800000",
        "date_updated": "1716220800000",
        "status": { "status": "to do", "color": "#87909e" },
        "assignees": [],
        "list": { "id": "9010065123", "name": "Sprint 1" }
      }
    ],
    "updated": [
      {
        "id": "def456",
        "name": "Updated task",
        "date_created": "1716134400000",
        "date_updated": "1716224400000",
        "status": { "status": "in progress", "color": "#4194f6" },
        "assignees": [],
        "list": { "id": "9010065123", "name": "Sprint 1" }
      }
    ]
  }
}

Fields shown are representative. The full response object includes additional properties.

Notes

Task timestamps from ClickUp are returned as Unix millisecond strings, which the trigger uses to categorize tasks as created or updated
Selecting List scope narrows the poll to a single List, which reduces payload size and API load compared to polling an entire Team
For near real-time delivery, use the Webhook trigger instead. Polling is best suited for scheduled, lower-frequency monitoring where webhook lifecycle management is not desired

Example Payload for New and Updated Tasks⤓

Loading…

Webhook

Receive and validate webhook requests from ClickUp for manually configured webhook subscriptions. | key: webhook

Example Payload for Webhook⤓

Loading…

Data Sources

Select Authorized Workspace

Select a workspace available to the authenticated user. | key: teams | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.

Example Payload for Select Authorized Workspace⤓

Loading…

Select Calendar View

Select a calendar view from a space. | key: calendars | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
Space ID	The unique identifier for the Space.

Example Payload for Select Calendar View⤓

Loading…

Select Custom Field

Select a custom field from a list. | key: customFields | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	The unique identifier for the List.

Example Payload for Select Custom Field⤓

Loading…

Select Custom Field Option

Select an option from a given custom field. | key: customFieldOptions | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
Field Name	The name of the custom field whose options should be returned.	Sales Stage
List ID	The unique identifier for the List.

Example Payload for Select Custom Field Option⤓

Loading…

Select Folder

Select a folder from a space. | key: folders | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
Space ID	The unique identifier for the Space.

Example Payload for Select Folder⤓

Loading…

Select List

Select an available list in a given folder. | key: lists | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
Folder ID	The unique identifier for the Folder.

Example Payload for Select List⤓

Loading…

Select Space

Select a space available in a workspace. | key: spaces | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	The unique identifier for the Team (Workspace).

Example Payload for Select Space⤓

Loading…

Select Task

Select a task from a list. | key: tasks | type: picklist

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	The unique identifier for the List.

Example Payload for Select Task⤓

Loading…

Actions

Add Guest to Folder

Share a folder with a guest. | key: addGuestToFolder

Input	Notes	Example
Connection	The ClickUp connection to use.
Folder ID	The unique identifier for the Folder.
Guest ID	The unique identifier for the guest.
Include Shared	When true, includes details of items shared with the guest. Set to false to exclude them.	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	The unique identifier for the guest.
Include Shared	When true, includes details of items shared with the guest. Set to false to exclude them.	true
List ID	The unique identifier for the List.
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	When true, the Task ID is treated as a custom task ID. Requires Team ID.	true
Guest ID	The unique identifier for the guest.
Include Shared	When true, includes details of items shared with the guest. Set to false to exclude them.	true
Permission Level	Can be read (view only), comment, edit, or create (full).	read
Task ID	The unique identifier for the task.
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 task to an additional list. | key: addTaskToList

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	The unique identifier for the List.
Task ID	The unique identifier for the task.

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	The unique identifier for the Space.

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	The description of the List, in plain text.
Due Date	Initial due date of the new list
Due Date Time	When true, the Due Date includes a time of day rather than only a date.	false
Folder ID	The unique identifier for the Folder.
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	The display name of the Space.	Engineering Space
Team ID	The unique identifier for the Team (Workspace).	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 in a list. | key: createTask

Input	Notes	Example
Additional Fields	Additional optional fields: includes Markdown Description, Notify All, and Check Required Custom Fields.
Assignee	User IDs of the people to assign to the task.
Connection	The ClickUp connection to use.
Custom Fields	Custom field key-value pairs to set on the task.	{"field_id": "value"}
Custom Task ID	When true, task IDs in this request are treated as custom task IDs. Requires Team ID.	false
Description	The description of the task.
Links To	A task ID to create a linked dependency with the new task.
List ID	The unique identifier for the List.
Name	The name of the task.
Parent	An existing task ID to create this task as a subtask of. The parent task cannot itself be a subtask and must be in the List specified by List ID.
Priority	The task priority: 1 (Urgent), 2 (High), 3 (Normal), or 4 (Low).
Schedule	Start and due dates, whether each includes a time of day, and time estimate.
Status	The name of the status to apply to the task, as configured in the List.
Tag	Tag names to apply to the task.
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123

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	The unique identifier for the task.
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	The user ID of the person to assign the comment to.	12345678
Comment Text	The text content of the comment.
Connection	The ClickUp connection to use.
Custom Task ID	When true, allows referencing a task by its custom task ID.	false
Notify All	When true, sends notifications to everyone, including the creator of the comment.	true
Task ID	The unique identifier for the task.
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123

Example Payload for Create Task Comment⤓

Loading…

Create Team

Create a user group (Team) of users that can be assigned to items in a 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	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Create Team⤓

Loading…

Create Time Entry

Create a time entry. | key: createTimeEntry

Input	Notes	Example
Assignee	The user ID to assign the time entry to. Workspace owners and admins can use any user ID; Workspace members can only use their own.	12345678
Billable	When true, marks the time entry as 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	The description of the time entry.
Duration	The duration of the time entry, in milliseconds.
Start	The start time of the time entry as a Unix timestamp in milliseconds.
Tags	JSON object containing an array of tag objects with name, background color (tag_bg), and foreground color (tag_fg) properties.	`{ "tags": [ { "name": "urgent", "tag_bg": "#BF55EC", "tag_fg": "#FFFFFF" } ] }`
Task ID	Associate a time entry with a task by ID
Team ID	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Create Time Entry⤓

Loading…

Create Webhook

Create a new webhook for a workspace, space, folder, list, or task. | key: createWebhook

Input	Notes	Example
Connection	The ClickUp connection to use.
Endpoint	URL of the webhook endpoint.	https://example.com/webhooks/clickup
Event	Event type to trigger the webhook.	["taskCreated", "taskUpdated"]
Folder ID	The unique identifier for the Folder.
List ID	The unique identifier for the List.
Space ID	The unique identifier for the Space.
Task ID	The unique identifier for the task.
Team ID	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Create Webhook⤓

Loading…

Delete Comment

Delete a task comment. | key: deleteComment

Input	Notes	Example
Comment ID	The unique identifier for the comment.
Connection	The ClickUp connection to use.

Example Payload for Delete Comment⤓

Loading…

Delete Folder

Delete a folder from a workspace. | key: deleteFolder

Input	Notes	Example
Connection	The ClickUp connection to use.
Folder ID	The unique identifier for the Folder.

Example Payload for Delete Folder⤓

Loading…

Delete List

Delete a list from a workspace. | key: deleteList

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	The unique identifier for the List.

Example Payload for Delete List⤓

Loading…

Delete Space

Delete a space from a workspace. | key: deleteSpace

Input	Notes	Example
Connection	The ClickUp connection to use.
Space ID	The unique identifier for the Space.

Example Payload for Delete Space⤓

Loading…

Delete Task

Delete a task from a 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	The unique identifier for the task.
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123

Example Payload for Delete Task⤓

Loading…

Delete Team

Remove a user group (Team) from a 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	The unique identifier for the Team (Workspace).	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	The unique identifier for the webhook.	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	When true, the guest can create views.	true
Can Edit Tags	When true, the guest can edit tags.	true
Can See Time Estimated	When true, the guest can see time estimates on tasks.	true
Can See Time Spent	When true, the guest can see time spent on tasks.	true
Connection	The ClickUp connection to use.
Custom Role ID	The unique identifier for the custom role to assign.	12345
Guest ID	The unique identifier for the guest.
Team ID	The unique identifier for the Team (Workspace).	9010065123
Username	The new username for the guest in the Workspace.

Example Payload for Edit Guest on Workspace⤓

Loading…

Edit User on Workspace

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

Input	Notes	Example
Admin	When true, grants admin privileges to the user.	true
Connection	The ClickUp connection to use.
Custom Role ID	The unique identifier for the custom role to assign.	12345
Team ID	The unique identifier for the Team (Workspace).	9010065123
User ID	The unique identifier for the user.	38312345
Username	The new display name for the user. Leave empty to keep the current username.	Jane Smith

Example Payload for Edit User on Workspace⤓

Loading…

Get Accessible Custom Fields

List the custom fields available on tasks in a specific list. | key: getAccessibleCustomFields

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	The unique identifier for the List whose Custom Fields are returned.

Example Payload for Get Accessible Custom Fields⤓

Loading…

Get Authorized Workspaces

List the workspaces available to the authenticated user. | key: getAuthorizedTeams

Input	Notes	Example
Connection	The ClickUp connection to use.

Example Payload for Get Authorized Workspaces⤓

Loading…

Get Folder

Retrieve a folder and its lists. | key: getFolder

Input	Notes	Example
Connection	The ClickUp connection to use.
Folder ID	The unique identifier for the Folder.

Example Payload for Get Folder⤓

Loading…

Get Guest

Retrieve information about a guest in a workspace. | key: getGuest

Input	Notes	Example
Connection	The ClickUp connection to use.
Guest ID	The unique identifier for the guest.
Team ID	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Get Guest⤓

Loading…

Get List

Retrieve details for a specific list. | key: getList

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	The unique identifier for the List.

Example Payload for Get List⤓

Loading…

Get List Members

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

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	The unique identifier for the List.

Example Payload for Get List Members⤓

Loading…

Get Space

Retrieve details for a specific space by ID. | key: getSpace

Input	Notes	Example
Connection	The ClickUp connection to use.
Space ID	The unique identifier for the Space.

Example Payload for Get Space⤓

Loading…

Get Task

Retrieve 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	When true, includes subtasks in the results. By default, subtasks are excluded.	false
Task ID	The unique identifier for the task.
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123

Example Payload for Get Task⤓

Loading…

Get Task Comments

List all comments on a task. | 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
Pagination	Start timestamp and start ID cursor controls for paging through results.
Task ID	The unique identifier for the task.
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

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

Input	Notes	Example
Connection	The ClickUp connection to use.
Task ID	The unique identifier for the task.

Example Payload for Get Task Members⤓

Loading…

Get Team

Retrieve user groups (Teams) in a 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	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Get Team⤓

Loading…

Get Time Entries Within Date Range

List time entries filtered by start and end date. By default, returns 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	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Get Time Entries Within Date Range⤓

Loading…

Get Time Entry

Retrieve 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	The unique identifier for the Team (Workspace).	9010065123
Timer ID	The ID of a time entry.	12345678

Example Payload for Get Time Entry⤓

Loading…

Get User

Retrieve information about a user in a workspace. | key: getUser

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	The unique identifier for the Team (Workspace).	9010065123
User ID	The unique identifier for the user.	38312345

Example Payload for Get User⤓

Loading…

Get Workspace Plan

Retrieve the current plan for a specified workspace. | key: getWorkspacePlan

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Get Workspace Plan⤓

Loading…

Get Workspace Seats

Retrieve 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	The unique identifier for the Team (Workspace).	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	When true, the guest can create views.	true
Can Edit Tags	When true, the guest can edit tags.	true
Can See Time Estimated	When true, the guest can see time estimates on tasks.	true
Can See Time Spent	When true, the guest can see time spent on tasks.	true
Connection	The ClickUp connection to use.
Custom Role ID	The unique identifier for the custom role to assign.	12345
Email	Email address of the invited guest	john.doe@example.com
Team ID	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Invite Guest to Workspace⤓

Loading…

Invite User to Workspace

Invite someone to join a 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	The unique identifier for the custom role to assign.	12345
Email	Email address of User being added	john.doe@example.com
Team ID	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Invite User to Workspace⤓

Loading…

List Folders

List all folders in a space. | key: listFolders

Input	Notes	Example
Archived	When true, returns archived Folders.	false
Connection	The ClickUp connection to use.
Space ID	The unique identifier for the Space.

Example Payload for List Folders⤓

Loading…

List Lists in Folder

List the lists within a folder. | key: getLists

Input	Notes	Example
Archived	When true, returns archived Lists.	false
Connection	The ClickUp connection to use.
Folder ID	The unique identifier for the Folder.

Example Payload for List Lists in Folder⤓

Loading…

List Spaces

List the spaces available in a workspace. | key: listSpaces

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	The unique identifier for the Team (Workspace).	9010065123

Example Payload for List Spaces⤓

Loading…

List Tasks

List the tasks in a list. | key: listTasks

Input	Notes	Example
Assignee	User IDs to filter tasks by assignee.
Connection	The ClickUp connection to use.
Date Range Filters	Optional date-range filters. Narrow results by when tasks are due, were created, were last updated, or were done.
Filters	Optional query controls to sort and refine the results.
List ID	The unique identifier for the List whose tasks are returned.
Page	The page number to retrieve (starts at 0).	0
Include Subtasks	When true, includes subtasks in the results. By default, subtasks are excluded.	false
Tag	Filter by tags. Add a tag to filter.

Example Payload for List Tasks⤓

Loading…

List Webhooks

List all webhooks for a workspace. | key: getWebhooks

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	The unique identifier for the Team (Workspace).	9010065123

Example Payload for List Webhooks⤓

Loading…

Raw Request

Send a raw HTTP request to the ClickUp API. | 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	When true, the Task ID is treated as a custom task ID. Requires Team ID.	true
Field ID	The universal unique identifier (UUID) of the Custom Field.
Task ID	The unique identifier for the task 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	The unique identifier for the Folder.
Guest ID	The unique identifier for the guest.
Include Shared	When true, includes details of items shared with the guest. Set to false to exclude them.	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	The unique identifier for the guest.
Include Shared	When true, includes details of items shared with the guest. Set to false to exclude them.	true
List ID	The unique identifier for the List.

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	When true, the Task ID is treated as a custom task ID. Requires Team ID.	true
Guest ID	The unique identifier for the guest.
Include Shared	When true, includes details of items shared with the guest. Set to false to exclude them.	true
Task ID	The unique identifier for the task.
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	The unique identifier for the guest.
Team ID	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Remove Guest from Workspace⤓

Loading…

Remove Task from List

Remove a task from an additional list. A task cannot be removed from its home list. | key: removeTaskFromList

Input	Notes	Example
Connection	The ClickUp connection to use.
List ID	The unique identifier for the List.
Task ID	The unique identifier for the task.

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	The unique identifier for the Team (Workspace).	9010065123
User ID	The unique identifier for the user.	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	The universal unique identifier (UUID) of the Custom Field.
Field Value	The value to set for the custom field.
Task ID	The unique identifier for the task to update.
Value Type	Set to date when Field Value is a date, so it is converted to a Unix timestamp in milliseconds. Leave empty for other values.

Example Payload for Set Custom Field Value⤓

Loading…

Start Time Entry

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

Input	Notes	Example
Billable	When true, marks the time entry as 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	The description of the time entry.
Tag Name	Add a tag name
Task ID	Associate a time entry with a task by ID
Team ID	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Start Time Entry⤓

Loading…

Stop Time Entry

Stop the timer that is currently running for the authenticated user. | key: stopTimeEntry

Input	Notes	Example
Connection	The ClickUp connection to use.
Team ID	The unique identifier for the Team (Workspace).	9010065123

Example Payload for Stop 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	The user ID of the person to assign the comment to.	12345678
Comment ID	The unique identifier for the comment.
Comment Text	The text content of the comment.
Connection	The ClickUp connection to use.
Resolved	When true, marks the comment as 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	The unique identifier for the Folder.
Name	The name of the folder.	My Folder

Example Payload for Update Folder⤓

Loading…

Update List

Update a list's name, info description, due date/time, priority, assignee, and color. | key: updateList

Input	Notes	Example
Assignee	User ID of the list assignee
Connection	The ClickUp connection to use.
Content	The description of the List, in plain text.
Due Date	Due date of the list
Due Date Time	When true, the Due Date includes a time of day rather than only a date.	false
List ID	The unique identifier for the List.
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	When true, removes the List color.	false

Example Payload for Update List⤓

Loading…

Update Space

Rename a space, set its color, and enable ClickApps for the 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	The unique identifier for the Space.
Space Name	The display name of the Space.	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 an existing task. | key: updateTask

Input	Notes	Example
Add Assignee	User IDs to add as assignees on the task.
Archived	When true, archives the task. When false, the task is unarchived.	false
Connection	The ClickUp connection to use.
Custom Task ID	When true, task IDs in this request are treated as custom task IDs. Requires Team ID.	false
Description	The description of the task.
Markdown Description	Markdown formatted description.	# Task Description This task involves...
Name	The name of the task.
Parent	A task ID to move this subtask under.
Priority	The task priority: 1 (Urgent), 2 (High), 3 (Normal), or 4 (Low).
Remove Assignee	User IDs to remove as assignees from the task.
Schedule	Start and due dates, whether each includes a time of day, and time estimate.
Status	The name of the status to apply to the task, as configured in the List.
Task ID	The unique identifier for the task.
Team ID	Only used when the custom_task_ids parameter is set to true.	9010065123

Example Payload for Update Task⤓

Loading…

Update Team

Update a user group (Team) of users that can be assigned to items in a 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	The handle used to @mention the Team (user group) in the 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	The user ID to assign the time entry to. Workspace owners and admins can use any user ID; Workspace members can only use their own.	12345678
Billable	When true, marks the time entry as 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	The description of the time entry.
Duration	The duration of the time entry, in milliseconds.
End	The end time of the time entry as a Unix timestamp in milliseconds.
Start	The start time of the time entry as a Unix timestamp in milliseconds.
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": "urgent", "tag_bg": "#BF55EC", "tag_fg": "#FFFFFF" } ] }`
Task ID	Associate a time entry with a task by ID
Team ID	The unique identifier for the Team (Workspace).	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.	https://example.com/webhooks/clickup
Event	Event type to trigger the webhook.	["taskCreated", "taskUpdated"]
Status	The status to set on the webhook, such as active.
Webhook ID	The unique identifier for the webhook.	e506-4a29-9d42-26e504e3435e

Example Payload for Update Webhook⤓

Loading…

Changelog

2026-10-06

Fixed several action and trigger defects, and added initial sync, batching, grouped inputs, output schemas, and inline action calling:

Fixed Get Task Members sending a DELETE request instead of a GET, so the action now returns the task's members
Fixed Raw Request failing to authenticate with a Personal Access Token connection
Fixed New and Updated Tasks never returning closed tasks or subtasks
Fixed Edit User on Workspace renaming every edited user to "User Name"; it now keeps the current username unless the new optional Username input is set
Fixed Update Task clearing the task's Name, Description, Status, and Parent when those inputs were left empty; optional inputs left empty are now omitted from requests across the component
Added an optional Look-back Date input to the New and Updated Tasks trigger for performing an initial sync of tasks. The initial sync begins on the first recurrence and backfills every task modified on or after the specified date, seeding each once and ignoring the visibility filters; later recurrences are unaffected. Leave it empty to start from the first recurrence with no backfill
Added opt-in batching to the New and Updated Tasks trigger, dispatching each changed task individually or in configured batches so large backlogs drain in one recurrence; enabling it changes the shape a downstream step receives, which gets each changed task with its change type instead of separate created and updated lists
Updated List Tasks to group its date filters into Date Range Filters and its sort, archive, closed-task, and custom-field query controls into Filters
Updated Create Task and Update Task to group their start date, due date, and time estimate inputs into Schedule, with Create Task also grouping its Markdown description, notification, and required custom field options into Additional Fields, and Get Task Comments to group its start date and start ID cursor into Pagination
Added output schemas to 49 actions for improved field mapping during configuration
Added inline action calling support to 64 actions for improved example output during configuration

2026-05-26

Added New and Updated Tasks polling trigger that monitors a Team (Workspace) or List for changes via the date_updated_gt filter on ClickUp's tasks API. Results are partitioned into created and updated buckets based on each task's date_created/date_updated Unix-millisecond timestamps

2026-04-30

Updated spectral version

2026-04-10

Updated Example Payloads

2026-03-31

Various modernizations and documentation updates

ClickUp Connector

Description​

API Documentation​

Connections​

Personal Access Token​

Prerequisites​

Setup Steps​

Configure the Connection​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

Triggers​

New and Updated Tasks​

How It Works​

Returned Data​

Notes​

Webhook​

Data Sources​

Select Authorized Workspace​

Select Calendar View​

Select Custom Field​

Select Custom Field Option​

Select Folder​

Select List​

Select Space​

Select Task​

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 Workspaces​

Get Folder​

Get Guest​

Get List​

Get List Members​

Get Space​

Get Task​

Get Task Comments​

Get Task Members​

Get Team​

Get Time Entries Within Date Range​

Get Time Entry​

Get User​

Get Workspace Plan​

Get Workspace Seats​

Invite Guest to Workspace​

Invite User to Workspace​

List Folders​

List Lists in Folder​

List Spaces​

List Tasks​

List Webhooks​

Raw Request​

Remove Custom Field Value​

Remove Guest from Folder​

Remove Guest from List​

Remove Guest from Task​

Remove Guest from Workspace​

Description

API Documentation

Connections

Personal Access Token

Prerequisites

Setup Steps

Configure the Connection

OAuth 2.0

Prerequisites

Setup Steps

Configure the Connection

Triggers

New and Updated Tasks

How It Works

Returned Data

Notes

Webhook

Data Sources

Select Authorized Workspace

Select Calendar View

Select Custom Field

Select Custom Field Option

Select Folder

Select List

Select Space

Select Task

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 Workspaces

Get Folder

Get Guest

Get List

Get List Members

Get Space

Get Task

Get Task Comments

Get Task Members

Get Team

Get Time Entries Within Date Range

Get Time Entry

Get User

Get Workspace Plan

Get Workspace Seats

Invite Guest to Workspace

Invite User to Workspace

List Folders

List Lists in Folder

List Spaces

List Tasks

List Webhooks

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