ClickUp Component

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

Component key: click-up

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

ClickUp Personal Access Token

Personal API token Configuration Instructions

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

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

Input	Notes
Personal Access Token string / Required apiKey	Follow the next steps to get an API key https://help.clickup.com/hc/en-us/articles/6303426241687-Getting-Started-with-the-ClickUp-API#personal-api-key

ClickUp OAuth 2.0

Oauth Configuration Instructions

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

Log into ClickUp.
Click on your avatar in the lower-left corner and select Integrations.
Click on ClickUp API.
Click Create an App.
Give your app a name and provide the redirect URL ashttps://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 configuration page of Prismatic

Input	Default	Notes
Authorize URL string / Required Hidden Field authorizeUrl	https://app.clickup.com/api	The OAuth 2.0 Authorization URL for Click Up
Client ID string / Required clientId		Follow this step to generate https://clickup.com/api/developer-portal/authentication/#step-1-create-an-oauth-app
Client Secret password / Required clientSecret		Follow this step to generate https://clickup.com/api/developer-portal/authentication/#step-1-create-an-oauth-app
Headers string Hidden Field Key Value List headers		Additional header to supply to authorization requests
Scopes string Hidden Field scopes		ClickUp does not support granular scopes
Token URL string / Required Hidden Field tokenUrl	https://api.clickup.com/api/v2/oauth/token	The OAuth 2.0 Token URL for Click Up

Triggers

Webhook

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

Example Payload for Webhook

{
  "payload": {
    "headers": {
      "content-type": "application/json",
      "Host": "hooks.prismatic.io",
      "User-Agent": "Amazon CloudFront",
      "X-Amz-Cf-Id": "Rac2uF9zf4sP-YoeH6Kw-hDwC2_Gv85W8C1234erwnvP7w9Svi1-1w==",
      "X-Amzn-Trace-Id": "Root=1-6488ce8f-1f6fe8a9778e3019463c9038",
      "x-b3-parentspanid": "25dad6fe551084df",
      "x-b3-sampled": "0",
      "x-b3-spanid": "229e0462ba367dd5",
      "x-b3-traceid": "79aa6cbfbd57277e",
      "x-datadog-parent-id": "2494436065687272917",
      "x-datadog-sampling-priority": "-1",
      "x-datadog-trace-id": "8766939195401250686",
      "x-signature": "5163a9e3d476388b9e3bb0263881234425660f948bba8bff9b32a2ae882bf1be"
    },
    "queryParameters": null,
    "rawBody": "<data (N bytes)>",
    "body": {
      "data": {
        "event": "taskCreated",
        "history_items": [
          {
            "id": "3538167764785216452",
            "type": 1,
            "date": "1686687372646",
            "field": "status",
            "parent_id": "901234567891",
            "data": {
              "status_type": "open"
            },
            "source": null,
            "user": {
              "id": 38312345,
              "username": "Uername",
              "email": "user@mail.com",
              "color": "#4169e1",
              "initials": "UN",
              "profilePicture": null
            },
            "before": {
              "status": null,
              "color": "#000000",
              "type": "removed",
              "orderindex": -1
            },
            "after": {
              "status": "to do",
              "color": "#a09d9d",
              "orderindex": 0,
              "type": "open"
            }
          },
          {
            "id": "3538167768123456789",
            "type": 1,
            "date": "1686687372646",
            "field": "task_creation",
            "parent_id": "901234567891",
            "data": {
              "via": "user",
              "trace_id": "7436346685143012345",
              "subcategory_id": "901001112345"
            },
            "source": "user",
            "user": {
              "id": 38312345,
              "username": "Uername",
              "email": "user@mail.com",
              "color": "#4169e1",
              "initials": "UN",
              "profilePicture": null
            },
            "before": null,
            "after": null
          }
        ],
        "task_id": "8684ud1r5",
        "webhook_id": "67d99bf6-0fb8-4db4-a4e1-a0e759573240"
      },
      "contentType": "application/json"
    },
    "pathFragment": "",
    "webhookUrls": {
      "flow2": "https://hooks.prismatic.io/trigger/WEBHOOK_ID",
      "Flow 1": "https://hooks.prismatic.io/trigger/WEBHOOK_ID",
      "webhook": "https://hooks.prismatic.io/trigger/WEBHOOK_ID"
    },
    "webhookApiKeys": {
      "flow2": [
        "sample-api-key"
      ],
      "Flow 1": [
        "sample-api-key"
      ],
      "webhook": [
        "sample-api-key"
      ]
    },
    "invokeUrl": "https://hooks.prismatic.io/trigger/WEBHOOK_ID",
    "executionId": "EXECUTION_ID",
    "customer": {
      "id": "testCustomerId",
      "name": "Test Customer",
      "externalId": "testCustomerExternalId"
    },
    "instance": {
      "id": "testInstanceId",
      "name": "Test Instance"
    },
    "user": {
      "id": "testUserId",
      "email": "testUserEmail@example.com",
      "name": "Test User",
      "externalId": "testUserExternalId"
    }
  }
}

Data Sources

Custom Field Options

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

Input	Default	Notes
Connection connection / Required connection
Field Name string / Required fieldName	Sales Stage
List ID string / Required listId		Only include time entries associated with tasks in a specific List.

Custom Fields

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

Input	Notes
Connection connection / Required connection
List ID string / Required listId	Only include time entries associated with tasks in a specific List.

Folders

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

Input	Notes
Connection connection / Required connection
Space ID string / Required spaceId

Lists

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

Input	Notes
Connection connection / Required connection
Folder ID string / Required folderId	Only include time entries associated with tasks in a specific Folder.

Spaces

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

Input	Notes
Connection connection / Required connection
Team ID string / Required teamId

Teams Authorized Workspaces

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

Input	Notes
Connection connection / Required connection

Actions

Add Guest to Folder

Share a Folder with a guest. | key: addGuestToFolder

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Folder ID string / Required folderId		Folder ID
Guest ID string / Required guestId		Guest ID
Include Shared boolean includeShared		Exclude details of items shared with the guest by setting this parameter to false
Permission Level string / Required permissionLevel	create	Can be read (view only), comment, edit, or create (full).	read

Add Guest to List

Share a List with a guest. | key: addGuestToList

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Guest ID string / Required guestId		Guest ID
Include Shared boolean includeShared		Exclude details of items shared with the guest by setting this parameter to false
List ID string / Required listId		List ID
Permission Level string / Required permissionLevel	create	Can be read (view only), comment, edit, or create (full).	read

Add Guest to Task

Share a task with a guest. | key: addGuestToTask

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Custom Task ID boolean customTaskIds		If you want to reference a task by its Custom Task ID, this value must be true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Guest ID string / Required guestId		Guest ID
Include Shared boolean includeShared		Exclude details of items shared with the guest by setting this parameter to false
Permission Level string / Required permissionLevel		Can be read (view only), comment, edit, or create (full).	read
Task ID string / Required taskId		Task ID
Team ID string teamId		Only used when the custom_task_ids parameter is set to true	9010065123

Add Task to List

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

Input	Default	Notes
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
List ID string / Required listId		List ID
Task ID string / Required taskId		Task ID

Create Folder

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

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Name string / Required folderName		Folder Name
Space ID string / Required spaceId		Space ID value.

Create List

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

Input	Default	Notes
Assignee string assigneeInt		Include a user_id to assign this List.
Connection connection / Required clickUpConnection
Content string content		Content
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Due Date string dueDate		Initial due date of the new list
Due Date Time boolean dueDateTime		Due Date Time
Folder ID string / Required folderId		Folder ID
Name string / Required listName		Name of the new list
Name string / Required name		Name of the new list
Priority string priority		Initial priority of the new list
Status string status		Status refers to the List color rather than the task Statuses available in the List.

Create Space

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Enable Checklists boolean / Required enableChecklists		Enable Checklists?
Enable Custom Fields boolean / Required enableCustomFields		Enable Custom Fields?
Enable Dependency Warning boolean / Required enableDependencyWarning		Enable Dependency Warning?
Enable Due Dates boolean / Required enableDueDates		Enable Due Dates?
Enable Portfolios boolean / Required enablePortfolios		Enable Portfolios?
Enable Remap Dependencies boolean / Required enableRemapDependencies		Enable Remap Dependencies?
Enable Tags boolean / Required enableTags		Enable Tags?
Enable Time Estimates boolean / Required enableTimeEstimates		Enable Time Estimates?
Enable Time Tracking boolean / Required enableTimeTracking		Enable Time Tracking?
Multiple Assignees boolean / Required multipleAssignees		Will this Space have multiple assignees?
Remap closed Due Dates boolean / Required remapClosedDueDates		Remap closed Due Dates?
Remap Due Dates boolean / Required remapDueDates		Remap Due Dates?
Space Name string / Required spaceName		Space Name	New space name
Team ID string / Required teamId		Team ID (Workspace) value	9010065123
Use Start Date boolean / Required useStartDate		Use Start Date?

Create Task

Create a new Task | key: createTask

Input	Default	Notes	Example
Assignee string Value List assignees		Task Assignees
Check Required Custom Fields boolean checkRequiredCustomFields		When creating a task via API any required Custom Fields are ignored by default (false).
Connection connection / Required connection
Custom Fields string Key Value List customFields
Custom Task ID boolean customTaskIds		If you want to reference a task by it's custom task id, this value must be true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		Task Description
Due Date string dueDate		Task Due Date	1508369194377
Due Date Time boolean dueDateTime		Task Due Date Time
Links To string linksTo		Include a task ID to create a linked dependency with your new task.
List ID string / Required listId		List ID
Markdown Description string markdownDescription		Markdown formatted description.
Name string / Required name		Task Name
Notify All boolean notifyAll		If notify_all is true, notifications will be sent to everyone including the creator of the comment.
Parent string 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 string priority		Task Priority
Start Date string startDate		Task Start Date	1567780450202
Start Date Time boolean startDateTime		Task Start Date Time
Status string status		Task Status
Tag string Value List tags		Task Tags
Team ID string teamId		Only used when the custom_task_ids parameter is set to true.	9010065123
Time Estimate string timeEstimate		Task Time Estimate	8640000

Create Task Attachment

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

Input	Default	Notes	Example
Connection connection / Required connection
Custom Task ID boolean customTaskIds		If you want to reference a task by it's custom task id, this value must be true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
File data / Required file		File to attach.
File Name string / Required fileName		Name of the file to attach.	my-image.png
Task ID string / Required taskId		Task ID
Team ID string teamId		Only used when the custom_task_ids parameter is set to true.	9010065123

Create Task Comment

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

Input	Default	Notes	Example
Assignee string assigneeId		Assignee by ID
Comment Text string / Required commentText		Comment Text
Connection connection / Required connection
Custom Task ID boolean customTaskIds		If you want to reference a task by it's custom task id, this value must be true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Notify All boolean / Required notifyAll		If notify_all is true, notifications will be sent to everyone including the creator of the comment.
Task ID string / Required taskId		Task ID
Team ID string teamId		Only used when the custom_task_ids parameter is set to true.	9010065123

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	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Member string / Required Value List members		Add user by ID	123456
Name string / Required name		Desired Team Name	New team name
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

Create Time Entry

Create a time entry. | key: createTimeEntry

Input	Default	Notes	Example
Assignee string / Required assigneeTimeEntry		Workspace owners and admins can include any user id. Workspace members can only include their own user id.
Include Subtasks boolean / Required billable		Billable
Connection connection / Required clickUpConnection
Custom Task ID boolean / Required customTaskIds		If you want to reference a task by it's custom task id, this value must be true.
Custom Team ID string / Required customTeamId		Only used when the custom_task_ids parameter is set to true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string / Required description		Description
Duration string / Required duration		Duration
Start string / Required start		Start time
Tags code / Required tagsCode		Code should have this format
Task ID string / Required taskId		Associate a time entry with a task by ID
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

Create Webhook

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Endpoint string / Required endpoint		URL of the webhook endpoint.
Event string / Required Value List events		Event type to trigger the webhook.	taskCreated
Folder ID string folderId		Folder ID
List ID string listId		List ID
Space ID string spaceId		Space ID
Task ID string taskId		Task ID
Team ID string / Required teamId		Team ID (Workspace)	9010065123

Delete Comment

Delete a task comment. | key: deleteComment

Input	Default	Notes
Comment ID string / Required commentId		Comment ID
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Delete Folder

Delete a Folder from your Workspace. | key: deleteFolder

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Folder ID string / Required folderId		Folder ID

Delete List

Delete a List from your Workspace. | key: deleteList

Input	Default	Notes
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
List ID string / Required listId		List ID

Delete Space

Delete a Space from your Workspace. | key: deleteSpace

Input	Default	Notes
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Space ID string / Required spaceId		Space ID value.

Delete Task

Delete a task from your Workspace. | key: deleteTask

Input	Default	Notes	Example
Connection connection / Required connection
Custom Task ID boolean customTaskIds		If you want to reference a task by it's custom task id, this value must be true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Task ID string / Required taskId		Task ID
Team ID string teamId		Only used when the custom_task_ids parameter is set to true.	9010065123

Delete Team

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Group ID string / Required groupId		Team ID (user group).	7C73-4002-A6A9-310014852858

Delete Time Entry

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Team ID string / Required teamId		Team ID (Workspace) value	9010065123
Timer ID string / Required timerId		The ID of a time entry.

Delete Webhook

Delete a webhook. | key: deleteWebhook

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Webhook ID string / Required webhookId		Webhook ID	e506-4a29-9d42-26e504e3435e (uuid)

Edit Guest on Workspace

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

Input	Default	Notes	Example
Can Create Views boolean / Required canCreateViews
Can Edit Tags boolean / Required canEditTags
Can See Time Estimated boolean / Required canSeeTimeEstimated
Can See Time Spent boolean / Required canSeeTimeSpent
Connection connection / Required clickUpConnection
Custom Role ID string / Required customRoleId		Custom Role ID value
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Guest ID string / Required guestId		Guest ID
Team ID string / Required teamId		Team ID (Workspace) value	9010065123
Username string / Required username

Edit User On Workspace

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

Input	Default	Notes	Example
Admin boolean / Required admin		Make an admin?
Connection connection / Required clickUpConnection
Custom Role ID string / Required customRoleId		Custom Role ID value
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Team ID string / Required teamId		Team ID (Workspace) value	9010065123
User ID string / Required userId		User ID value	38312345

Get Accessible Custom Fields

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

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
List ID string / Required listId		Only include time entries associated with tasks in a specific List.

Get Authorized Teams (Workspaces)

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

Input	Default	Notes
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Get Folder

View the Lists within a Folder. | key: getFolder

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Folder ID string / Required folderId		Folder ID

Get Guest

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Guest ID string / Required guestId		Guest ID
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

Get List

View details for a specific List. | key: getList

Input	Default	Notes
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
List ID string / Required listId		List ID

Get List Members

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

Input	Default	Notes
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
List ID string / Required listId		List ID

Get Singular Time Entry

View a single time entry. | key: getSingularTimeEntry

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Include Location Names boolean includeLocationNames		Include the names of the List, Folder, and Space along with the list_id,folder_id, and space_id.
Include Task Tags boolean includeTaskTags		Include task tags in the response for time entries associated with tasks.
Team ID string / Required teamId		Team ID (Workspace) value	9010065123
Timer ID string / Required timerId		The ID of a time entry.

Get Space

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

Input	Default	Notes
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Space ID string / Required spaceId		Space ID value.

Get Task

View information about a task. | key: getTask

Input	Default	Notes	Example
Connection connection / Required connection
Custom Task ID boolean customTaskIds		If you want to reference a task by it's custom task id, this value must be true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Include Subtasks boolean subTasks		Include or exclude subtasks. By default, subtasks are excluded.
Task ID string / Required taskId		Task ID
Team ID string / Required teamId		Only used when the custom_task_ids parameter is set to true.	9010065123

Get Task Comments

View task comments. | key: getTaskComments

Input	Default	Notes	Example
Connection connection / Required connection
Custom Task ID boolean customTaskIds		If you want to reference a task by it's custom task id, this value must be true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Start Date string startDate		Unix time in milliseconds
Start ID string startId		Enter the Comment id of a task comment.
Task ID string / Required taskId		Task ID
Team ID string teamId		Only used when the custom_task_ids parameter is set to true.	9010065123

Get Task Members

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

Input	Default	Notes
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Task ID string / Required taskId		Task ID

Get Team

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Group IDs string groupIds		Enter one or more Team ids (user groups) to retrieve information about specific Teams.	C9C58BE9-7C73-4002-A6A9-310014852858
Team ID string teamId		Team ID (Workspace) value	9010065123

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	Default	Notes	Example
Assignee string assignee		Filter by User ID
Connection connection / Required clickUpConnection
Custom Task ID boolean customTaskIds		If you want to reference a task by it's custom task id, this value must be true.
Custom Team ID string customTeamId		Only used when the custom_task_ids parameter is set to true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
End Date string endDate		Unix time in milliseconds
Folder ID string folderId		Only include time entries associated with tasks in a specific Folder.
Include Location Names boolean includeLocationNames		Include the names of the List, Folder, and Space along with the list_id,folder_id, and space_id.
Include Task Tags boolean includeTaskTags		Include task tags in the response for time entries associated with tasks.
List ID string listId		Only include time entries associated with tasks in a specific List.
Space ID string spaceId		Only include time entries associated with tasks in a specific Space.
Start Date string startDate		Unix time in milliseconds
Task ID string taskId		Only include time entries associated with a specific task.
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

Get User

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Team ID string / Required teamId		Team ID (Workspace) value	9010065123
User ID string / Required userId		User ID value	38312345

Get Webhooks

View all webhooks for a list. | key: getWebhooks

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

Get Workspace Plan

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

Get Workspace Seats

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

Invite Guest to Workspace

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

Input	Default	Notes	Example
Can Create Views boolean / Required canCreateViews
Can Edit Tags boolean / Required canEditTags
Can See Time Estimated boolean / Required canSeeTimeEstimated
Can See Time Spent boolean / Required canSeeTimeSpent
Connection connection / Required clickUpConnection
Custom Role ID string / Required customRoleId		Custom Role ID value
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Email string / Required email		Email address of the invited guest	example@email.com
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

Invite User To Workspace

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

Input	Default	Notes	Example
Admin boolean / Required admin		Make an admin?
Connection connection / Required clickUpConnection
Custom Role ID string / Required customRoleId		Custom Role ID value
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Email string / Required email		Email address of User being added	example@email.com
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

List Folders

View all folders in a space. | key: listFolders

Input	Default	Notes
Archived boolean archived	false	Archived?
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Space ID string / Required spaceId		Space ID value.

List Lists

View the Lists within a Folder. | key: getLists

Input	Default	Notes
Archived boolean archived		Filter for archived Lists?
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Folder ID string / Required folderId		Folder ID

List Spaces

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

List Tasks

View the tasks in a List. | key: listTasks

Input	Default	Notes	Example
Archived boolean archived		Archived?
Assignee string Value List assignees		Filter by Assignees. Add Assingee
Connection connection / Required connection
Custom Fields code customFieldsCode		Code should have this format
Date Created Greater Than string dateCreatedGt		Filter by date created greater than Unix time in milliseconds.
Date Created Less Than string dateCreatedLt		Filter by date created less than Unix time in milliseconds.
Date Done Greater Than string dateDoneGt		Filter by date done greater than Unix time in milliseconds.
Date Done Less Than string dateDoneLt		Filter by date done less than Unix time in milliseconds.
Date Updated Greater Than string dateUpdatedGt		Filter by date updated greater than Unix time in milliseconds.
Date Updated Less Than string dateUpdatedLt		Filter by date updated less than Unix time in milliseconds.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Due Date Greater Than string dueDateGt		Filter by due date greater than Unix time in milliseconds.
Due Date Less Than string dueDateLt		Filter by due date less than Unix time in milliseconds.
Include Closed boolean includeClosed		Include or excluse closed tasks. By default, they are excluded.
List ID string / Required listId		Team ID (Workspace)
Order By string orderBy		Order by a particular field. By default, tasks are ordered by created.	Options include: id, created, updated, and due_date.
Page string / Required page	0
Reverse boolean reverse		Tasks are displayed in reverse order.
Include Subtasks boolean / Required subTasks		Include or exclude subtasks. By default, subtasks are excluded.
Tag string Value List tags		Filter by tags. Add a tag to filter.

Raw Request

Send raw HTTP request to ClickUp | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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 string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required 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 boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

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	Default	Notes	Example
Connection connection / Required connection
Custom Task ID boolean customTaskIds		If you want to reference a task by its Custom Task ID, this value must be true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Field ID string / Required fieldId		Enter the universal unique identifier (UUID) of the Custom Field you want to set.
Task ID string / Required taskId		Enter the task ID of the task you want to update.
Team ID string teamId		Only used when the custom_task_ids parameter is set to true	9010065123

Remove Guest From Folder

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

Input	Default	Notes
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Folder ID string / Required folderId		Folder ID
Guest ID string / Required guestId		Guest ID
Include Shared boolean includeShared		Exclude details of items shared with the guest by setting this parameter to false

Remove Guest From List

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

Input	Default	Notes
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Guest ID string / Required guestId		Guest ID
Include Shared boolean includeShared		Exclude details of items shared with the guest by setting this parameter to false
List ID string / Required listId		List ID

Remove Guest From Task

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Custom Task ID boolean customTaskIds		If you want to reference a task by its Custom Task ID, this value must be true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Guest ID string / Required guestId		Guest ID
Include Shared boolean includeShared		Exclude details of items shared with the guest by setting this parameter to false
Task ID string / Required taskId		Task ID
Team ID string teamId		Only used when the custom_task_ids parameter is set to true	9010065123

Remove Guest From Workspace

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Guest ID string / Required guestId		Guest ID
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

Remove Task From List

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

Input	Default	Notes
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
List ID string / Required listId		List ID
Task ID string / Required taskId		Task ID

Remove User From Workspace

Deactivate a user from a Workspace. | key: removeUserFromWorkspace

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Team ID string / Required teamId		Team ID (Workspace) value	9010065123
User ID string / Required userId		User ID value	38312345

Set Custom Field Value

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

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Field ID string / Required fieldId		Enter the universal unique identifier (UUID) of the Custom Field you want to set.
Field Value data / Required fieldValue
Task ID string / Required taskId		Enter the task ID of the task you want to update.
Value Type string valueType

Start a Time Entry

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

Input	Default	Notes	Example
Include Subtasks boolean / Required billable		Billable
Connection connection / Required clickUpConnection
Custom Task ID boolean customTaskIds		If you want to reference a task by it's custom task id, this value must be true.
Custom Team ID string customTeamId		Only used when the custom_task_ids parameter is set to true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string / Required description		Description
Tag name string / Required Value List tagNamesArray		Add a tag name
Task ID string / Required taskId		Associate a time entry with a task by ID
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

Stop a Time Entry

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

Input	Default	Notes	Example
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Team ID string / Required teamId		Team ID (Workspace) value	9010065123

Update Comment

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

Input	Default	Notes
Assignee string / Required assigneeId		Assignee by ID
Comment ID string / Required commentId		Comment ID
Comment Text string / Required commentText		Comment Text
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Resolved boolean / Required resolved		Resolved?

Update Folder

Rename a Folder | key: updateFolder

Input	Default	Notes
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Folder ID string / Required folderId		Folder ID
Name string / Required folderName		Folder Name

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	Default	Notes
Assignee string / Required assignee		User ID of the list assignee
Connection connection / Required clickUpConnection
Content string / Required content		Content
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Due Date string / Required dueDate		Due date of the list
Due Date Time boolean / Required dueDateTime		Set to true if due date has a time
List ID string / Required listId		List ID
Name string / Required name		Name of the list
Priority string / Required priority		Priority of the list
Status string / Required status		Status refers to the List color rather than the task Statuses available in the List.
Unset Status boolean / Required unsetStatus		By default, this is false. To remove the List color use unset_status: true.

Update Space

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

Input	Default	Notes	Example
Admin Can Manage boolean / Required adminCanManage		Admin Can Manage?
Connection connection / Required clickUpConnection
Color string / Required color		Hex Color Number	#7B68EE
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Enable Checklists boolean / Required enableChecklists		Enable Checklists?
Enable Custom Fields boolean / Required enableCustomFields		Enable Custom Fields?
Enable Dependency Warning boolean / Required enableDependencyWarning		Enable Dependency Warning?
Enable Due Dates boolean / Required enableDueDates		Enable Due Dates?
Enable Portfolios boolean / Required enablePortfolios		Enable Portfolios?
Enable Remap Dependencies boolean / Required enableRemapDependencies		Enable Remap Dependencies?
Enable Tags boolean / Required enableTags		Enable Tags?
Enable Time Estimates boolean / Required enableTimeEstimates		Enable Time Estimates?
Enable Time Tracking boolean / Required enableTimeTracking		Enable Time Tracking?
Multiple Assignees boolean / Required multipleAssignees		Will this Space have multiple assignees?
Private boolean / Required privateInput		Private?
Remap closed Due Dates boolean / Required remapClosedDueDates		Remap closed Due Dates?
Remap Due Dates boolean / Required remapDueDates		Remap Due Dates?
Space ID string / Required spaceId		Space ID value.
Space Name string / Required spaceName		Space Name	New space name
Use Start Date boolean / Required useStartDate		Use Start Date?

Update Task

Update a task | key: updateTask

Input	Default	Notes	Example
Add Assignee string Value List addAssignees		Add Assignee
Archived boolean archived		Include Archived?
Connection connection / Required connection
Custom Task ID boolean customTaskIds		If you want to reference a task by it's custom task id, this value must be true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		Task Description
Due Date string dueDate		Task Due Date	1508369194377
Due Date Time boolean dueDateTime		Task Due Date Time
Markdown Description string markdownDescription		Markdown formatted description.
Name string name		Task Name
Parent string parent		You can move a subtask to another parent task by including "parent" with a valid task id.
Priority string priority		Task Priority
Remove Assignee string Value List removeAssignees		Remove Assignee
Start Date string startDate		Task Start Date	1567780450202
Start Date Time boolean startDateTime		Task Start Date Time
Status string status		Task Status
Task ID string / Required taskId		Task ID
Team ID string teamId		Only used when the custom_task_ids parameter is set to true.	9010065123
Time Estimate string timeEstimate		Task Time Estimate	8640000

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	Default	Notes	Example
Add Member string addMember		Add members by ID. Comma separate each user ID.	12345,5678
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Group ID string / Required groupId		Team ID (user group).	7C73-4002-A6A9-310014852858
Remove Member string removeMember		Remove members by ID. Comma separate each user ID.	12345,5678
Team Handle string teamHandle		You may update the team handle which is used to @mention a Team (user group) in your Workspace.	handle
Team Name string teamName		Desired Team Name	team name

Update Time Entry

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

Input	Default	Notes	Example
Assignee string / Required assigneeTimeEntry		Workspace owners and admins can include any user id. Workspace members can only include their own user id.
Include Subtasks boolean / Required billable		Billable
Connection connection / Required clickUpConnection
Custom Task ID boolean / Required customTaskIds		If you want to reference a task by it's custom task id, this value must be true.
Custom Team ID string / Required customTeamId		Only used when the custom_task_ids parameter is set to true.
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string / Required description		Description
Duration string / Required duration		Duration
End string / Required end		End time
Start string / Required start		Start time
Tag Action string / Required tagAction		Tag Action (use replace, add or remove)	replace, add or remove
Tags code / Required tagsCode		Code should have this format
Task ID string / Required taskId		Associate a time entry with a task by ID
Team ID string / Required teamId		Team ID (Workspace) value	9010065123
Timer ID string / Required timerId		The ID of a time entry.

Update Webhook

Update the configuration of a webhook. | key: updateWebhook

Input	Default	Notes	Example
All Events boolean allEvents		Subscribe to all events, when set to true it overrides the event inputs
Connection connection / Required clickUpConnection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Endpoint string / Required endpoint		URL of the webhook endpoint.
Event string / Required Value List events		Event type to trigger the webhook.	taskCreated
Status string / Required status		Status
Webhook ID string / Required webhookId		Webhook ID	e506-4a29-9d42-26e504e3435e (uuid)

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

Description​

Connections​

ClickUp Personal Access Token​

ClickUp OAuth 2.0​

Triggers​

Webhook​

Data Sources​

Custom Field Options​

Custom Fields​

Folders​

Lists​

Spaces​

Teams Authorized Workspaces​

Actions​

Add Guest to Folder​

Add Guest to List​

Add Guest to Task​

Add Task to List​

Create Folder​

Create List​

Create Space​

Create Task​

Create Task Attachment​

Create Task Comment​

Create Team​

Create Time Entry​

Create Webhook​

Delete Comment​

Delete Folder​

Delete List​

Delete Space​

Delete Task​

Delete Team​

Delete Time Entry​

Delete Webhook​

Edit Guest on Workspace​

Edit User On Workspace​

Get Accessible Custom Fields​

Get Authorized Teams (Workspaces)​

Get Folder​

Get Guest​

Get List​

Get List Members​

Get Singular Time Entry​

Get Space​

Get Task​

Get Task Comments​

Get Task Members​

Get Team​

Get Time Entries Within a Date Range​

Get User​

Get Webhooks​

Get Workspace Plan​

Get Workspace Seats​

Invite Guest to Workspace​

Invite User To Workspace​

List Folders​

List Lists​

List Spaces​

List Tasks​

Raw Request​

Remove Custom Field Value​

Remove Guest From Folder​

Remove Guest From List​

Remove Guest From Task​

Remove Guest From Workspace​

Remove Task From List​

Remove User From Workspace​

Set Custom Field Value​

Start a Time Entry​

Stop a Time Entry​

Update Comment​

Update Folder​

Update List​

Update Space​

Update Task​

Update Team​

Update Time Entry​

Update Webhook​