ClickUp Component
Manage tasks, lists, spaces, time tracking, and team members in ClickUp.
Component key: click-up · · Changelog ↓Description
ClickUp is a CRM, collaboration, knowledge base, and project management tool.
Use the ClickUp component to manage users, projects, and teams in a ClickUp workspace.
Connections
Personal Access Token
key: apiKeyPersonal Access Token Configuration Instructions
To make API requests to ClickUp using a personal access token, follow the steps below. For full details, see the ClickUp Authentication documentation.
- Log into ClickUp.
- Click on the avatar in the lower-left corner and select Apps.
- Under API Token, click Generate.
- Copy the personal access token and paste it into the connection configuration in the integration.
| 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: clickUpOauth2ConnectionOAuth 2.0 Configuration Instructions
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.
- Log into ClickUp.
- Click on the avatar in the lower-left corner and select Integrations.
- Click on ClickUp API.
- Click Create an App.
- Provide an app name and set the redirect URL to
https://oauth2.prismatic.io/callback. - Once the app is created, a Client ID and Client Secret will be provided. Enter these values into the connection configuration.
| 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
Checks for new and updated tasks in ClickUp on a configured schedule. | key: pollChangesTrigger
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| 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 enabled, tasks created since the last poll are returned in the trigger payload. | true |
| Show Updated Records | When enabled, 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 (or uses the current execution time on the first run) and converts it to Unix milliseconds
- Queries the ClickUp tasks API with a
date_updated_gtfilter, 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_createdUnix millisecond timestamp against the last poll cutoff. Tasks whosedate_createdfalls 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
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⤓
Webhook
Receive and validate webhook requests from ClickUp for manually configured webhook subscriptions. | key: webhook
Example Payload for Webhook⤓
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. |
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. |
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. |
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. |
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. |
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. |
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). |
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. |
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⤓
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⤓
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⤓
Add Task to List
Add a 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⤓
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⤓
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⤓
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⤓
Create Task
Create a new task in a list. | 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⤓
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⤓
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⤓
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 | Team ID (Workspace) value. | 9010065123 |
Example Payload for Create Team⤓
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. | |
| Task ID | Associate a time entry with a task by ID | |
| Team ID | Team ID (Workspace) value. | 9010065123 |
Example Payload for Create Time Entry⤓
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. | |
| 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⤓
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⤓
Delete Folder
Delete a folder from a workspace. | key: deleteFolder
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| Folder ID | Folder ID |
Example Payload for Delete Folder⤓
Delete List
Delete a list from a workspace. | key: deleteList
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| List ID | List ID |
Example Payload for Delete List⤓
Delete Space
Delete a space from a workspace. | key: deleteSpace
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| Space ID | Space ID value. |
Example Payload for Delete Space⤓
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 | Task ID | |
| Team ID | Only used when the custom_task_ids parameter is set to true. | 9010065123 |
Example Payload for Delete Task⤓
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⤓
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⤓
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⤓
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⤓
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 | 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⤓
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 | Only include time entries associated with tasks in a specific List. |
Example Payload for Get Accessible Custom Fields⤓
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⤓
Get Folder
Retrieve a folder and its lists. | key: getFolder
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| Folder ID | Folder ID |
Example Payload for Get Folder⤓
Get Guest
Retrieve 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⤓
Get List
Retrieve 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⤓
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 | List ID |
Example Payload for Get List Members⤓
Get Space
Retrieve details for a specific space by ID. | key: getSpace
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| Space ID | Space ID value. |
Example Payload for Get Space⤓
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 | 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⤓
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 |
| 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⤓
Get Task Members
List 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⤓
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 | Team ID (Workspace) value. | 9010065123 |
Example Payload for Get Team⤓
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 | Team ID (Workspace) value. | 9010065123 |
Example Payload for Get Time Entries Within Date Range⤓
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 | Team ID (Workspace) value. | 9010065123 |
| Timer ID | The ID of a time entry. | 12345678 |
Example Payload for Get Time Entry⤓
Get User
Retrieve 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⤓
Get Workspace Plan
Retrieve the current plan for a 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⤓
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 | Team ID (Workspace) value. | 9010065123 |
Example Payload for Get Workspace Seats⤓
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 address of the invited guest | john.doe@example.com | |
| Team ID | Team ID (Workspace) value. | 9010065123 |
Example Payload for Invite Guest to Workspace⤓
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 | Custom Role ID value. | 12345 |
Email address of User being added | john.doe@example.com | |
| Team ID | Team ID (Workspace) value. | 9010065123 |
Example Payload for Invite User to Workspace⤓
List Folders
List 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⤓
List Lists in Folder
List 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 in Folder⤓
List Spaces
List 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⤓
List Tasks
List 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. | |
| 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⤓
List Webhooks
List all webhooks for a workspace. | key: getWebhooks
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| Team ID | Team ID (Workspace) value. | 9010065123 |
Example Payload for List Webhooks⤓
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⤓
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⤓
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⤓
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⤓
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⤓
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⤓
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 | List ID | |
| Task ID | Task ID |
Example Payload for Remove Task from List⤓
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⤓
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⤓
Start 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 Time Entry⤓
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 | Team ID (Workspace) value. | 9010065123 |
Example Payload for Stop Time Entry⤓
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⤓
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⤓
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 | 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⤓
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 | 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⤓
Update Task
Update an existing 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⤓
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 | 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⤓
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. | |
| 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⤓
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⤓
Changelog
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