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: apiKeyPersonal 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: clickUpOauth2ConnectionOauth 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 |
{
"data": {
"guest": {
"id": 40237592,
"username": "External Reviewer",
"email": "reviewer@partner-company.com",
"color": "#e91e63",
"initials": "ER",
"profilePicture": null,
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_create_views": false,
"custom_role_id": null
}
}
}
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 |
{
"data": {
"guest": {
"id": 40237592,
"username": "External Reviewer",
"email": "reviewer@partner-company.com",
"color": "#e91e63",
"initials": "ER",
"profilePicture": null,
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_create_views": false,
"custom_role_id": null
}
}
}
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 |
{
"data": {
"guest": {
"id": 40237592,
"username": "External Reviewer",
"email": "reviewer@partner-company.com",
"color": "#e91e63",
"initials": "ER",
"profilePicture": null,
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_create_views": false,
"custom_role_id": null
}
}
}
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 |
{
"data": null
}
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. |
{
"data": {
"id": "457",
"name": "Website Redesign",
"orderindex": 0,
"override_statuses": false,
"hidden": false,
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"task_count": "12",
"archived": false,
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "in progress",
"orderindex": 1,
"color": "#4194f6",
"type": "custom"
},
{
"status": "complete",
"orderindex": 2,
"color": "#6bc950",
"type": "closed"
}
],
"lists": [
{
"id": "124",
"name": "Sprint Backlog",
"orderindex": 0,
"status": null,
"priority": null,
"assignee": null,
"task_count": 8,
"due_date": null,
"start_date": null,
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"archived": false,
"override_statuses": null,
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "create"
}
],
"permission_level": "create"
}
}
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. |
{
"data": {
"id": "124",
"name": "Sprint Backlog",
"orderindex": 0,
"content": "Tasks for the current sprint cycle.",
"status": {
"status": "active",
"color": "#87909e",
"hide_label": true
},
"priority": {
"priority": "high",
"color": "#ffcc00"
},
"assignee": null,
"task_count": 8,
"due_date": "1706745600000",
"due_date_time": false,
"start_date": "1704067200000",
"start_date_time": false,
"folder": {
"id": "457",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "in progress",
"orderindex": 1,
"color": "#4194f6",
"type": "custom"
},
{
"status": "complete",
"orderindex": 2,
"color": "#6bc950",
"type": "closed"
}
],
"inbound_address": "add.task.124.U-81942673.ccc7c26e-3ab9-46d5-ad07-62a9a7d0f0c4@tasks.clickup.com",
"archived": false,
"permission_level": "create"
}
}
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 |
{
"data": {
"id": "790",
"name": "Engineering",
"private": false,
"statuses": [
{
"id": "p790_awaiting",
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"id": "p790_inprogress",
"status": "in progress",
"type": "custom",
"orderindex": 1,
"color": "#4194f6"
},
{
"id": "p790_review",
"status": "review",
"type": "custom",
"orderindex": 2,
"color": "#a875ff"
},
{
"id": "p790_closed",
"status": "complete",
"type": "closed",
"orderindex": 3,
"color": "#6bc950"
}
],
"multiple_assignees": true,
"features": {
"due_dates": {
"enabled": true,
"start_date": true,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"sprints": {
"enabled": false
},
"time_tracking": {
"enabled": true
},
"points": {
"enabled": false
},
"custom_items": {
"enabled": false
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"check_unresolved": {
"enabled": true,
"subtasks": null,
"checklists": null,
"comments": null
},
"zoom": {
"enabled": false
},
"milestones": {
"enabled": false
},
"remap_dependencies": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"multiple_assignees": {
"enabled": true
},
"emails": {
"enabled": true
}
},
"archived": false
}
}
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 |
{
"data": {
"id": "9hx",
"custom_id": null,
"name": "Design Homepage",
"text_content": "Design the new homepage with a modern and clean look.",
"description": "Design the new homepage for the website.",
"status": {
"status": "in progress",
"color": "#4194f6",
"type": "custom",
"orderindex": 1
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1704067200000",
"date_updated": "1704153600000",
"date_closed": null,
"date_done": null,
"archived": false,
"creator": {
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"profilePicture": "https://attachments.clickup.com/profilePictures/81942673_abc.jpg"
},
"assignees": [
{
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"initials": "JD",
"profilePicture": null
}
],
"watchers": [
{
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"initials": "JD",
"profilePicture": null
}
],
"checklists": [],
"tags": [
{
"name": "design",
"tag_bg": "#1e90ff",
"tag_fg": "#ffffff",
"creator": 81942673
}
],
"parent": null,
"priority": {
"id": "2",
"priority": "high",
"color": "#ffcc00",
"orderindex": "2"
},
"due_date": "1706745600000",
"start_date": "1704067200000",
"points": null,
"time_estimate": 28800000,
"time_spent": 3600000,
"custom_fields": [
{
"id": "0a52c486-7f05-403c-b4b0-2a1f6dd4b840",
"name": "Sprint",
"type": "drop_down",
"type_config": {
"default": 0,
"placeholder": null,
"options": [
{
"id": "4aa3b3f7-1a02-4e57-a8cc-0ef8b1a9e07d",
"name": "Sprint 1",
"color": "#04a9f4",
"orderindex": 0
}
]
},
"date_created": "1704067200000",
"hide_from_guests": false,
"required": false
}
],
"dependencies": [],
"linked_tasks": [],
"team_id": "9012345",
"url": "https://app.clickup.com/t/9hx",
"sharing": {
"public": false,
"public_share_expires_on": null,
"whitelisted": [],
"token": null
},
"permission_level": "create",
"list": {
"id": "124",
"name": "Sprint Backlog",
"access": true
},
"project": {
"id": "456",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"folder": {
"id": "456",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"space": {
"id": "789"
}
}
}
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 |
{
"data": {
"id": "ac905d76-3456-4d84-8c75-a7c0faa092ea",
"version": "0",
"date": 1704153600000,
"title": "project-mockup.png",
"parent": "9hx",
"type": 1,
"source": 1,
"size": 245892,
"total_comments": 0,
"resolved_comments": 0,
"email_data": null,
"hidden": false,
"orientation": null,
"url": "https://t.attachments.clickup.com/9012345/ac905d76-3456-4d84-8c75-a7c0faa092ea/project-mockup.png",
"url_w_query": "https://t.attachments.clickup.com/9012345/ac905d76-3456-4d84-8c75-a7c0faa092ea/project-mockup.png?view=open",
"url_w_host": "https://t.attachments.clickup.com/9012345/ac905d76-3456-4d84-8c75-a7c0faa092ea/project-mockup.png",
"is_folder": null,
"mimetype": "image/png",
"thumbnail_small": null,
"thumbnail_medium": null,
"thumbnail_large": null,
"extension": "png"
}
}
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 |
{
"data": {
"id": 458,
"hist_id": "2b46a082-d55d-4a5e-957e-023af4f1d28e",
"date": 1704153600000
}
}
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 |
{
"data": {
"id": "2b4dc017-deb0-4cff-8675-3a4a492e13e4",
"team_id": "9012345",
"userid": 81942673,
"name": "Design Team",
"handle": "design-team",
"date_created": "1704067200000",
"initials": "DT",
"members": [
{
"id": 81942673,
"username": "John Doe",
"email": "john.doe@example.com",
"color": "#7b68ee",
"initials": "JD",
"profilePicture": null
}
],
"avatar": {
"attachment_id": null,
"color": "#40bc86",
"icon": null
}
}
}
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 |
{
"data": {
"data": {
"id": "2004673344540003622",
"wid": "9012345",
"user": {
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"profilePicture": null
},
"billable": false,
"start": "1704067200000",
"end": "1704070800000",
"duration": "3600000",
"description": "Working on homepage layout",
"source": "clickup",
"at": "1704070800000",
"is_locked": false,
"task_location": {
"list_id": "124",
"folder_id": "457",
"space_id": "790",
"list_name": "Sprint Backlog",
"folder_name": "Website Redesign",
"space_name": "Engineering"
},
"task": {
"id": "9hx",
"name": "Design Homepage",
"status": {
"status": "in progress",
"color": "#4194f6",
"type": "custom",
"orderindex": 1
},
"custom_type": null
},
"tags": [
{
"name": "development",
"tag_bg": "#1e90ff",
"tag_fg": "#ffffff",
"creator": 81942673
}
],
"task_url": "https://app.clickup.com/t/9hx"
}
}
}
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 |
{
"data": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"webhook": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"userid": 81942673,
"team_id": 9012345,
"endpoint": "https://hooks.example.com/clickup/events",
"client_id": "ABCDEF1234567890ABCDEF",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted"
],
"task_id": null,
"list_id": null,
"folder_id": null,
"space_id": 790,
"health": {
"status": "active",
"fail_count": 0
},
"secret": "7x1PK3mISQG0jBqeNYuhWn8alZdRtf5E"
}
}
}
Delete Comment
Delete a task comment. | key: deleteComment
| Input | Notes | Example |
|---|---|---|
| Comment ID | Comment ID | |
| Connection | The ClickUp connection to use. |
{
"data": null
}
Delete Folder
Delete a Folder from your Workspace. | key: deleteFolder
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| Folder ID | Folder ID |
{
"data": null
}
Delete List
Delete a List from your Workspace. | key: deleteList
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| List ID | List ID |
{
"data": null
}
Delete Space
Delete a Space from your Workspace. | key: deleteSpace
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| Space ID | Space ID value. |
{
"data": null
}
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 |
{
"data": null
}
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 |
{
"data": null
}
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 |
{
"data": null
}
Delete Webhook
Delete a webhook. | key: deleteWebhook
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| Webhook ID | Webhook ID | e506-4a29-9d42-26e504e3435e |
{
"data": null
}
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 |
{
"data": {
"guest": {
"id": 40237592,
"username": "External Reviewer",
"email": "reviewer@partner-company.com",
"color": "#e91e63",
"initials": "ER",
"profilePicture": null,
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_create_views": false,
"custom_role_id": null
}
}
}
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 |
{
"data": {
"user": {
"id": 81942673,
"username": "John Doe",
"email": "john.doe@example.com",
"color": "#7b68ee",
"profilePicture": "https://attachments.clickup.com/profilePictures/81942673_abc.jpg",
"initials": "JD",
"role": 1,
"custom_role": null,
"last_active": "1704153600000",
"date_joined": "1672531200000",
"date_invited": "1672531200000"
}
}
}
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. |
{
"data": {
"fields": [
{
"id": "0a52c486-7f05-403c-b4b0-2a1f6dd4b840",
"name": "Sprint",
"type": "drop_down",
"type_config": {
"default": 0,
"placeholder": null,
"options": [
{
"id": "4aa3b3f7-1a02-4e57-a8cc-0ef8b1a9e07d",
"name": "Sprint 1",
"color": "#04a9f4",
"orderindex": 0
},
{
"id": "5bb4c4g8-2b13-5f68-b9dd-1fg9c2b0f18e",
"name": "Sprint 2",
"color": "#ff7043",
"orderindex": 1
}
]
},
"date_created": "1704067200000",
"hide_from_guests": false,
"required": false
},
{
"id": "1b63d597-8g16-514d-c5c1-3b2g7ee5c951",
"name": "Story Points",
"type": "number",
"type_config": {},
"date_created": "1704067200000",
"hide_from_guests": false,
"required": false
}
]
}
}
Get Authorized Teams (Workspaces)
View the Workspaces available to the authenticated user. | key: getAuthorizedTeams
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. |
{
"data": {
"teams": [
{
"id": "9012345",
"name": "Acme Corp Workspace",
"color": "#536cfe",
"avatar": null,
"members": [
{
"user": {
"id": 81942673,
"username": "John Doe",
"email": "john.doe@example.com",
"color": "#7b68ee",
"profilePicture": "https://attachments.clickup.com/profilePictures/81942673_abc.jpg",
"initials": "JD",
"role": 1,
"custom_role": null,
"last_active": "1704153600000",
"date_joined": "1672531200000",
"date_invited": "1672531200000"
},
"invited_by": {
"id": 81942670,
"username": "Jane Smith",
"color": "#e91e63",
"email": "jane.smith@example.com",
"initials": "JS",
"profilePicture": null
}
}
]
}
]
}
}
Get Folder
View the Lists within a Folder. | key: getFolder
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| Folder ID | Folder ID |
{
"data": {
"id": "457",
"name": "Website Redesign",
"orderindex": 0,
"override_statuses": false,
"hidden": false,
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"task_count": "12",
"archived": false,
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "in progress",
"orderindex": 1,
"color": "#4194f6",
"type": "custom"
},
{
"status": "complete",
"orderindex": 2,
"color": "#6bc950",
"type": "closed"
}
],
"lists": [
{
"id": "124",
"name": "Sprint Backlog",
"orderindex": 0,
"status": null,
"priority": null,
"assignee": null,
"task_count": 8,
"due_date": null,
"start_date": null,
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"archived": false,
"override_statuses": null,
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "create"
}
],
"permission_level": "create"
}
}
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 |
{
"data": {
"guest": {
"id": 40237592,
"username": "External Reviewer",
"email": "reviewer@partner-company.com",
"color": "#e91e63",
"initials": "ER",
"profilePicture": null,
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_create_views": false,
"custom_role_id": null
}
}
}
Get List
View details for a specific List. | key: getList
| Input | Notes | Example |
|---|---|---|
| Connection | The ClickUp connection to use. | |
| List ID | List ID |
{
"data": {
"id": "124",
"name": "Sprint Backlog",
"orderindex": 0,
"content": "Tasks for the current sprint cycle.",
"status": {
"status": "active",
"color": "#87909e",
"hide_label": true
},
"priority": {
"priority": "high",
"color": "#ffcc00"
},
"assignee": null,
"task_count": 8,
"due_date": "1706745600000",
"due_date_time": false,
"start_date": "1704067200000",
"start_date_time": false,
"folder": {
"id": "457",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "in progress",
"orderindex": 1,
"color": "#4194f6",
"type": "custom"
},
{
"status": "complete",
"orderindex": 2,
"color": "#6bc950",
"type": "closed"
}
],
"inbound_address": "add.task.124.U-81942673.ccc7c26e-3ab9-46d5-ad07-62a9a7d0f0c4@tasks.clickup.com",
"archived": false,
"permission_level": "create"
}
}
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 |
{
"data": {
"members": [
{
"id": 81942673,
"username": "John Doe",
"email": "john.doe@example.com",
"color": "#7b68ee",
"initials": "JD",
"profilePicture": "https://attachments.clickup.com/profilePictures/81942673_abc.jpg",
"role": 1
}
]
}
}
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 |
{
"data": {
"data": {
"id": "2004673344540003622",
"wid": "9012345",
"user": {
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"profilePicture": null
},
"billable": false,
"start": "1704067200000",
"end": "1704070800000",
"duration": "3600000",
"description": "Working on homepage layout",
"source": "clickup",
"at": "1704070800000",
"is_locked": false,
"task_location": {
"list_id": "124",
"folder_id": "457",
"space_id": "790",
"list_name": "Sprint Backlog",
"folder_name": "Website Redesign",
"space_name": "Engineering"
},
"task": {
"id": "9hx",
"name": "Design Homepage",
"status": {
"status": "in progress",
"color": "#4194f6",
"type": "custom",
"orderindex": 1
},
"custom_type": null
},
"tags": [
{
"name": "development",
"tag_bg": "#1e90ff",
"tag_fg": "#ffffff",
"creator": 81942673
}
],
"task_url": "https://app.clickup.com/t/9hx"
}
}
}
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. |
{
"data": {
"id": "790",
"name": "Engineering",
"private": false,
"statuses": [
{
"id": "p790_awaiting",
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"id": "p790_inprogress",
"status": "in progress",
"type": "custom",
"orderindex": 1,
"color": "#4194f6"
},
{
"id": "p790_review",
"status": "review",
"type": "custom",
"orderindex": 2,
"color": "#a875ff"
},
{
"id": "p790_closed",
"status": "complete",
"type": "closed",
"orderindex": 3,
"color": "#6bc950"
}
],
"multiple_assignees": true,
"features": {
"due_dates": {
"enabled": true,
"start_date": true,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"sprints": {
"enabled": false
},
"time_tracking": {
"enabled": true
},
"points": {
"enabled": false
},
"custom_items": {
"enabled": false
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"check_unresolved": {
"enabled": true,
"subtasks": null,
"checklists": null,
"comments": null
},
"zoom": {
"enabled": false
},
"milestones": {
"enabled": false
},
"remap_dependencies": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"multiple_assignees": {
"enabled": true
},
"emails": {
"enabled": true
}
},
"archived": false
}
}
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 |
{
"data": {
"id": "9hx",
"custom_id": null,
"name": "Design Homepage",
"text_content": "Design the new homepage with a modern and clean look.",
"description": "Design the new homepage for the website.",
"status": {
"status": "in progress",
"color": "#4194f6",
"type": "custom",
"orderindex": 1
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1704067200000",
"date_updated": "1704153600000",
"date_closed": null,
"date_done": null,
"archived": false,
"creator": {
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"profilePicture": "https://attachments.clickup.com/profilePictures/81942673_abc.jpg"
},
"assignees": [
{
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"initials": "JD",
"profilePicture": null
}
],
"watchers": [
{
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"initials": "JD",
"profilePicture": null
}
],
"checklists": [],
"tags": [
{
"name": "design",
"tag_bg": "#1e90ff",
"tag_fg": "#ffffff",
"creator": 81942673
}
],
"parent": null,
"priority": {
"id": "2",
"priority": "high",
"color": "#ffcc00",
"orderindex": "2"
},
"due_date": "1706745600000",
"start_date": "1704067200000",
"points": null,
"time_estimate": 28800000,
"time_spent": 3600000,
"custom_fields": [
{
"id": "0a52c486-7f05-403c-b4b0-2a1f6dd4b840",
"name": "Sprint",
"type": "drop_down",
"type_config": {
"default": 0,
"placeholder": null,
"options": [
{
"id": "4aa3b3f7-1a02-4e57-a8cc-0ef8b1a9e07d",
"name": "Sprint 1",
"color": "#04a9f4",
"orderindex": 0
}
]
},
"date_created": "1704067200000",
"hide_from_guests": false,
"required": false
}
],
"dependencies": [],
"linked_tasks": [],
"team_id": "9012345",
"url": "https://app.clickup.com/t/9hx",
"sharing": {
"public": false,
"public_share_expires_on": null,
"whitelisted": [],
"token": null
},
"permission_level": "create",
"list": {
"id": "124",
"name": "Sprint Backlog",
"access": true
},
"project": {
"id": "456",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"folder": {
"id": "456",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"space": {
"id": "789"
}
}
}
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 |
{
"data": {
"comments": [
{
"id": "458",
"comment": [
{
"text": "Great progress on the homepage design. Let's review the color palette in the next standup."
}
],
"comment_text": "Great progress on the homepage design. Let's review the color palette in the next standup.",
"user": {
"id": 81942673,
"username": "John Doe",
"email": "john.doe@example.com",
"color": "#7b68ee",
"initials": "JD",
"profilePicture": null
},
"resolved": false,
"assignee": null,
"assigned_by": null,
"reactions": [],
"date": "1704153600000"
}
]
}
}
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 |
{
"data": {
"members": [
{
"id": 81942673,
"username": "John Doe",
"email": "john.doe@example.com",
"color": "#7b68ee",
"initials": "JD",
"profilePicture": "https://attachments.clickup.com/profilePictures/81942673_abc.jpg",
"role": 1
}
]
}
}
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 |
{
"data": {
"groups": [
{
"id": "2b4dc017-deb0-4cff-8675-3a4a492e13e4",
"team_id": "9012345",
"userid": 81942673,
"name": "Design Team",
"handle": "design-team",
"date_created": "1704067200000",
"initials": "DT",
"members": [
{
"id": 81942673,
"username": "John Doe",
"email": "john.doe@example.com",
"color": "#7b68ee",
"initials": "JD",
"profilePicture": null
}
],
"avatar": {
"attachment_id": null,
"color": "#40bc86",
"icon": null
}
}
]
}
}
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 |
{
"data": {
"data": [
{
"id": "2004673344540003622",
"wid": "9012345",
"user": {
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"profilePicture": null
},
"billable": false,
"start": "1704067200000",
"end": "1704070800000",
"duration": "3600000",
"description": "Working on homepage layout",
"source": "clickup",
"at": "1704070800000",
"is_locked": false,
"task_location": {
"list_id": "124",
"folder_id": "457",
"space_id": "790",
"list_name": "Sprint Backlog",
"folder_name": "Website Redesign",
"space_name": "Engineering"
},
"task": {
"id": "9hx",
"name": "Design Homepage",
"status": {
"status": "in progress",
"color": "#4194f6",
"type": "custom",
"orderindex": 1
},
"custom_type": null
},
"tags": [
{
"name": "development",
"tag_bg": "#1e90ff",
"tag_fg": "#ffffff",
"creator": 81942673
}
],
"task_url": "https://app.clickup.com/t/9hx"
}
]
}
}
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 |
{
"data": {
"user": {
"id": 81942673,
"username": "John Doe",
"email": "john.doe@example.com",
"color": "#7b68ee",
"profilePicture": "https://attachments.clickup.com/profilePictures/81942673_abc.jpg",
"initials": "JD",
"role": 1,
"custom_role": null,
"last_active": "1704153600000",
"date_joined": "1672531200000",
"date_invited": "1672531200000"
}
}
}
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 |
{
"data": {
"webhooks": [
{
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"userid": 81942673,
"team_id": 9012345,
"endpoint": "https://hooks.example.com/clickup/events",
"client_id": "ABCDEF1234567890ABCDEF",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted"
],
"task_id": null,
"list_id": null,
"folder_id": null,
"space_id": 790,
"health": {
"status": "active",
"fail_count": 0
},
"secret": "7x1PK3mISQG0jBqeNYuhWn8alZdRtf5E"
}
]
}
}
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 |
{
"data": {
"plan_id": 3,
"plan_name": "Business"
}
}
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 |
{
"data": {
"members": {
"filled_member_seats": 15,
"total_member_seats": 25,
"empty_member_seats": 10
},
"guests": {
"filled_guest_seats": 3,
"total_guest_seats": 10,
"empty_guest_seats": 7
}
}
}
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 |
{
"data": {
"guest": {
"id": 40237592,
"username": "External Reviewer",
"email": "reviewer@partner-company.com",
"color": "#e91e63",
"initials": "ER",
"profilePicture": null,
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_create_views": false,
"custom_role_id": null
}
}
}
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 address of User being added | john.doe@example.com | |
| Team ID | Team ID (Workspace) value. | 9010065123 |
{
"data": {
"user": {
"id": 81942673,
"username": "John Doe",
"email": "john.doe@example.com",
"color": "#7b68ee",
"profilePicture": "https://attachments.clickup.com/profilePictures/81942673_abc.jpg",
"initials": "JD",
"role": 1,
"custom_role": null,
"last_active": "1704153600000",
"date_joined": "1672531200000",
"date_invited": "1672531200000"
}
}
}
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. |
{
"data": {
"folders": [
{
"id": "457",
"name": "Website Redesign",
"orderindex": 0,
"override_statuses": false,
"hidden": false,
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"task_count": "12",
"archived": false,
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "in progress",
"orderindex": 1,
"color": "#4194f6",
"type": "custom"
},
{
"status": "complete",
"orderindex": 2,
"color": "#6bc950",
"type": "closed"
}
],
"lists": [
{
"id": "124",
"name": "Sprint Backlog",
"orderindex": 0,
"status": null,
"priority": null,
"assignee": null,
"task_count": 8,
"due_date": null,
"start_date": null,
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"archived": false,
"override_statuses": null,
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "create"
}
],
"permission_level": "create"
}
]
}
}
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 |
{
"data": {
"lists": [
{
"id": "124",
"name": "Sprint Backlog",
"orderindex": 0,
"content": "Tasks for the current sprint cycle.",
"status": {
"status": "active",
"color": "#87909e",
"hide_label": true
},
"priority": {
"priority": "high",
"color": "#ffcc00"
},
"assignee": null,
"task_count": 8,
"due_date": "1706745600000",
"due_date_time": false,
"start_date": "1704067200000",
"start_date_time": false,
"folder": {
"id": "457",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "in progress",
"orderindex": 1,
"color": "#4194f6",
"type": "custom"
},
{
"status": "complete",
"orderindex": 2,
"color": "#6bc950",
"type": "closed"
}
],
"inbound_address": "add.task.124.U-81942673.ccc7c26e-3ab9-46d5-ad07-62a9a7d0f0c4@tasks.clickup.com",
"archived": false,
"permission_level": "create"
}
]
}
}
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 |
{
"data": {
"spaces": [
{
"id": "790",
"name": "Engineering",
"private": false,
"statuses": [
{
"id": "p790_awaiting",
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"id": "p790_inprogress",
"status": "in progress",
"type": "custom",
"orderindex": 1,
"color": "#4194f6"
},
{
"id": "p790_review",
"status": "review",
"type": "custom",
"orderindex": 2,
"color": "#a875ff"
},
{
"id": "p790_closed",
"status": "complete",
"type": "closed",
"orderindex": 3,
"color": "#6bc950"
}
],
"multiple_assignees": true,
"features": {
"due_dates": {
"enabled": true,
"start_date": true,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"sprints": {
"enabled": false
},
"time_tracking": {
"enabled": true
},
"points": {
"enabled": false
},
"custom_items": {
"enabled": false
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"check_unresolved": {
"enabled": true,
"subtasks": null,
"checklists": null,
"comments": null
},
"zoom": {
"enabled": false
},
"milestones": {
"enabled": false
},
"remap_dependencies": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"multiple_assignees": {
"enabled": true
},
"emails": {
"enabled": true
}
},
"archived": false
}
]
}
}
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. | |
| 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. |
{
"data": {
"tasks": [
{
"id": "9hx",
"custom_id": null,
"name": "Design Homepage",
"text_content": "Design the new homepage with a modern and clean look.",
"description": "Design the new homepage for the website.",
"status": {
"status": "in progress",
"color": "#4194f6",
"type": "custom",
"orderindex": 1
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1704067200000",
"date_updated": "1704153600000",
"date_closed": null,
"date_done": null,
"archived": false,
"creator": {
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"profilePicture": "https://attachments.clickup.com/profilePictures/81942673_abc.jpg"
},
"assignees": [
{
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"initials": "JD",
"profilePicture": null
}
],
"watchers": [
{
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"initials": "JD",
"profilePicture": null
}
],
"checklists": [],
"tags": [
{
"name": "design",
"tag_bg": "#1e90ff",
"tag_fg": "#ffffff",
"creator": 81942673
}
],
"parent": null,
"priority": {
"id": "2",
"priority": "high",
"color": "#ffcc00",
"orderindex": "2"
},
"due_date": "1706745600000",
"start_date": "1704067200000",
"points": null,
"time_estimate": 28800000,
"time_spent": 3600000,
"custom_fields": [
{
"id": "0a52c486-7f05-403c-b4b0-2a1f6dd4b840",
"name": "Sprint",
"type": "drop_down",
"type_config": {
"default": 0,
"placeholder": null,
"options": [
{
"id": "4aa3b3f7-1a02-4e57-a8cc-0ef8b1a9e07d",
"name": "Sprint 1",
"color": "#04a9f4",
"orderindex": 0
}
]
},
"date_created": "1704067200000",
"hide_from_guests": false,
"required": false
}
],
"dependencies": [],
"linked_tasks": [],
"team_id": "9012345",
"url": "https://app.clickup.com/t/9hx",
"sharing": {
"public": false,
"public_share_expires_on": null,
"whitelisted": [],
"token": null
},
"permission_level": "create",
"list": {
"id": "124",
"name": "Sprint Backlog",
"access": true
},
"project": {
"id": "456",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"folder": {
"id": "456",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"space": {
"id": "789"
}
}
]
}
}
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 |
{
"data": {
"id": "9hx",
"name": "Design Homepage",
"status": {
"status": "in progress",
"color": "#4194f6",
"type": "custom",
"orderindex": 1
},
"date_created": "1704067200000",
"date_updated": "1704153600000"
}
}
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 |
{
"data": null
}
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 |
{
"data": null
}
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 |
{
"data": null
}
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 |
{
"data": null
}
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 |
{
"data": null
}
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 |
{
"data": null
}
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 |
{
"data": null
}
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. |
{
"data": null
}
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 |
{
"data": {
"data": {
"id": "2004673344540003622",
"wid": "9012345",
"user": {
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"profilePicture": null
},
"billable": false,
"start": "1704067200000",
"end": "1704070800000",
"duration": "3600000",
"description": "Working on homepage layout",
"source": "clickup",
"at": "1704070800000",
"is_locked": false,
"task_location": {
"list_id": "124",
"folder_id": "457",
"space_id": "790",
"list_name": "Sprint Backlog",
"folder_name": "Website Redesign",
"space_name": "Engineering"
},
"task": {
"id": "9hx",
"name": "Design Homepage",
"status": {
"status": "in progress",
"color": "#4194f6",
"type": "custom",
"orderindex": 1
},
"custom_type": null
},
"tags": [
{
"name": "development",
"tag_bg": "#1e90ff",
"tag_fg": "#ffffff",
"creator": 81942673
}
],
"task_url": "https://app.clickup.com/t/9hx"
}
}
}
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 |
{
"data": {
"data": {
"id": "2004673344540003622",
"wid": "9012345",
"user": {
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"profilePicture": null
},
"billable": false,
"start": "1704067200000",
"end": "1704070800000",
"duration": "3600000",
"description": "Working on homepage layout",
"source": "clickup",
"at": "1704070800000",
"is_locked": false,
"task_location": {
"list_id": "124",
"folder_id": "457",
"space_id": "790",
"list_name": "Sprint Backlog",
"folder_name": "Website Redesign",
"space_name": "Engineering"
},
"task": {
"id": "9hx",
"name": "Design Homepage",
"status": {
"status": "in progress",
"color": "#4194f6",
"type": "custom",
"orderindex": 1
},
"custom_type": null
},
"tags": [
{
"name": "development",
"tag_bg": "#1e90ff",
"tag_fg": "#ffffff",
"creator": 81942673
}
],
"task_url": "https://app.clickup.com/t/9hx"
}
}
}
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 |
{
"data": null
}
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 |
{
"data": {
"id": "457",
"name": "Website Redesign",
"orderindex": 0,
"override_statuses": false,
"hidden": false,
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"task_count": "12",
"archived": false,
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "in progress",
"orderindex": 1,
"color": "#4194f6",
"type": "custom"
},
{
"status": "complete",
"orderindex": 2,
"color": "#6bc950",
"type": "closed"
}
],
"lists": [
{
"id": "124",
"name": "Sprint Backlog",
"orderindex": 0,
"status": null,
"priority": null,
"assignee": null,
"task_count": 8,
"due_date": null,
"start_date": null,
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"archived": false,
"override_statuses": null,
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "create"
}
],
"permission_level": "create"
}
}
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 |
{
"data": {
"id": "124",
"name": "Sprint Backlog",
"orderindex": 0,
"content": "Tasks for the current sprint cycle.",
"status": {
"status": "active",
"color": "#87909e",
"hide_label": true
},
"priority": {
"priority": "high",
"color": "#ffcc00"
},
"assignee": null,
"task_count": 8,
"due_date": "1706745600000",
"due_date_time": false,
"start_date": "1704067200000",
"start_date_time": false,
"folder": {
"id": "457",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"space": {
"id": "790",
"name": "Engineering",
"access": true
},
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "in progress",
"orderindex": 1,
"color": "#4194f6",
"type": "custom"
},
{
"status": "complete",
"orderindex": 2,
"color": "#6bc950",
"type": "closed"
}
],
"inbound_address": "add.task.124.U-81942673.ccc7c26e-3ab9-46d5-ad07-62a9a7d0f0c4@tasks.clickup.com",
"archived": false,
"permission_level": "create"
}
}
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 |
{
"data": {
"id": "790",
"name": "Engineering",
"private": false,
"statuses": [
{
"id": "p790_awaiting",
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"id": "p790_inprogress",
"status": "in progress",
"type": "custom",
"orderindex": 1,
"color": "#4194f6"
},
{
"id": "p790_review",
"status": "review",
"type": "custom",
"orderindex": 2,
"color": "#a875ff"
},
{
"id": "p790_closed",
"status": "complete",
"type": "closed",
"orderindex": 3,
"color": "#6bc950"
}
],
"multiple_assignees": true,
"features": {
"due_dates": {
"enabled": true,
"start_date": true,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"sprints": {
"enabled": false
},
"time_tracking": {
"enabled": true
},
"points": {
"enabled": false
},
"custom_items": {
"enabled": false
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"check_unresolved": {
"enabled": true,
"subtasks": null,
"checklists": null,
"comments": null
},
"zoom": {
"enabled": false
},
"milestones": {
"enabled": false
},
"remap_dependencies": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"multiple_assignees": {
"enabled": true
},
"emails": {
"enabled": true
}
},
"archived": false
}
}
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 |
{
"data": {
"id": "9hx",
"custom_id": null,
"name": "Design Homepage",
"text_content": "Design the new homepage with a modern and clean look.",
"description": "Design the new homepage for the website.",
"status": {
"status": "in progress",
"color": "#4194f6",
"type": "custom",
"orderindex": 1
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1704067200000",
"date_updated": "1704153600000",
"date_closed": null,
"date_done": null,
"archived": false,
"creator": {
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"profilePicture": "https://attachments.clickup.com/profilePictures/81942673_abc.jpg"
},
"assignees": [
{
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"initials": "JD",
"profilePicture": null
}
],
"watchers": [
{
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"initials": "JD",
"profilePicture": null
}
],
"checklists": [],
"tags": [
{
"name": "design",
"tag_bg": "#1e90ff",
"tag_fg": "#ffffff",
"creator": 81942673
}
],
"parent": null,
"priority": {
"id": "2",
"priority": "high",
"color": "#ffcc00",
"orderindex": "2"
},
"due_date": "1706745600000",
"start_date": "1704067200000",
"points": null,
"time_estimate": 28800000,
"time_spent": 3600000,
"custom_fields": [
{
"id": "0a52c486-7f05-403c-b4b0-2a1f6dd4b840",
"name": "Sprint",
"type": "drop_down",
"type_config": {
"default": 0,
"placeholder": null,
"options": [
{
"id": "4aa3b3f7-1a02-4e57-a8cc-0ef8b1a9e07d",
"name": "Sprint 1",
"color": "#04a9f4",
"orderindex": 0
}
]
},
"date_created": "1704067200000",
"hide_from_guests": false,
"required": false
}
],
"dependencies": [],
"linked_tasks": [],
"team_id": "9012345",
"url": "https://app.clickup.com/t/9hx",
"sharing": {
"public": false,
"public_share_expires_on": null,
"whitelisted": [],
"token": null
},
"permission_level": "create",
"list": {
"id": "124",
"name": "Sprint Backlog",
"access": true
},
"project": {
"id": "456",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"folder": {
"id": "456",
"name": "Website Redesign",
"hidden": false,
"access": true
},
"space": {
"id": "789"
}
}
}
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 |
{
"data": {
"id": "2b4dc017-deb0-4cff-8675-3a4a492e13e4",
"team_id": "9012345",
"userid": 81942673,
"name": "Design Team",
"handle": "design-team",
"date_created": "1704067200000",
"initials": "DT",
"members": [
{
"id": 81942673,
"username": "John Doe",
"email": "john.doe@example.com",
"color": "#7b68ee",
"initials": "JD",
"profilePicture": null
}
],
"avatar": {
"attachment_id": null,
"color": "#40bc86",
"icon": null
}
}
}
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 |
{
"data": {
"data": {
"id": "2004673344540003622",
"wid": "9012345",
"user": {
"id": 81942673,
"username": "John Doe",
"color": "#7b68ee",
"email": "john.doe@example.com",
"profilePicture": null
},
"billable": false,
"start": "1704067200000",
"end": "1704070800000",
"duration": "3600000",
"description": "Working on homepage layout",
"source": "clickup",
"at": "1704070800000",
"is_locked": false,
"task_location": {
"list_id": "124",
"folder_id": "457",
"space_id": "790",
"list_name": "Sprint Backlog",
"folder_name": "Website Redesign",
"space_name": "Engineering"
},
"task": {
"id": "9hx",
"name": "Design Homepage",
"status": {
"status": "in progress",
"color": "#4194f6",
"type": "custom",
"orderindex": 1
},
"custom_type": null
},
"tags": [
{
"name": "development",
"tag_bg": "#1e90ff",
"tag_fg": "#ffffff",
"creator": 81942673
}
],
"task_url": "https://app.clickup.com/t/9hx"
}
}
}
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 |
{
"data": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"webhook": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"userid": 81942673,
"team_id": 9012345,
"endpoint": "https://hooks.example.com/clickup/events",
"client_id": "ABCDEF1234567890ABCDEF",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted"
],
"task_id": null,
"list_id": null,
"folder_id": null,
"space_id": 790,
"health": {
"status": "active",
"fail_count": 0
},
"secret": "7x1PK3mISQG0jBqeNYuhWn8alZdRtf5E"
}
}
}
Changelog
2026-04-10
Updated Example Payloads
2026-03-31
Various modernizations and documentation updates