Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

ClickUp connector

OAuth 2.0Project ManagementCollaborationProductivity

Connect to ClickUp. Manage tasks, projects, workspaces, and team collaboration

ClickUp connector

  1. Terminal window
    npm install @scalekit-sdk/node

    Full SDK reference: Node.js | Python

  2. Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Register your ClickUp credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

    Dashboard setup steps

    Register your Scalekit environment with the ClickUp connector so Scalekit handles the authentication flow and token lifecycle for you. The connection name you create will be used to identify and invoke the connection programmatically. Then complete the configuration in your application as follows:

    1. Set up auth redirects

      • In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find ClickUp and click Create. Copy the redirect URI. It looks like https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback.

        Copy redirect URI from Scalekit dashboard

      • In ClickUp, click your Workspace avatar (lower-left corner) → SettingsIntegrationsClickUp API.

      • Open your application and paste the copied URI under Redirect URL(s), then save.

        Add redirect URI in ClickUp API settings

    2. Get client credentials

      On your ClickUp application page (SettingsIntegrationsClickUp API):

      Get ClickUp Client ID and Client Secret

      • Client ID — found under Client ID on your app page
      • Client Secret — found under Client Secret on your app page
    3. Add credentials in Scalekit

      • In Scalekit dashboard, go to AgentKit > Connections and open the connection you created.

      • Enter your credentials:

        • Client ID (from your ClickUp app page)
        • Client Secret (from your ClickUp app page)

        Add credentials for ClickUp in Scalekit dashboard

      • Click Save.

    4. Connect a user account

      • Click the Connected Accounts tab, then Add Account.
      • Enter your user’s ID and click Create Account — you’ll be redirected to ClickUp to authorize access.
  4. quickstart.ts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENV_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'clickup'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize ClickUp:', link)
    process.stdout.write('Press Enter after authorizing...')
    await new Promise(r => process.stdin.once('data', r))
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'clickup_user_get',
    toolInput: {},
    })
    console.log(result)

Connect this agent connector to let your agent:

  • Manage tasks — create, update, delete, and search tasks; set priorities, due dates, assignees, and statuses
  • Manage lists — create, update, and delete lists in folders or as folderless lists; get members
  • Manage folders — create, update, and delete folders; list all folders in a space
  • Manage spaces — create, update, and delete spaces; manage space tags and views
  • Manage comments — add, update, and delete comments on tasks and lists
  • Manage goals — create, update, delete, and list goals and their key results
  • Track time — list and create time entries for tasks
  • Manage checklists — create task checklists and checklist items
  • Manage webhooks — create, update, delete, and list workspace webhooks
  • Access workspace data — get user info, list workspaces, spaces, and views
Proxy API call
const result = await actions.request({
connectionName: 'clickup',
identifier: 'user_123',
path: '/api/v2/user',
method: 'GET',
});
console.log(result);
Execute a tool
const result = await actions.executeTool({
connector: 'clickup',
identifier: 'user_123',
toolName: 'clickup_list',
toolInput: {},
});
console.log(result);

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

clickup_checklist_item_create#Add a new item to an existing ClickUp task checklist.3 params

Add a new item to an existing ClickUp task checklist.

NameTypeRequiredDescription
checklist_idstringrequiredChecklist ID (UUID)
namestringrequiredItem label
assigneeintegeroptionalUser ID to assign to this item
clickup_comment_create#Add a new comment to a ClickUp task. Supports assigning the comment to a user and sending notifications.4 params

Add a new comment to a ClickUp task. Supports assigning the comment to a user and sending notifications.

NameTypeRequiredDescription
comment_textstringrequiredThe content of the comment
notify_allbooleanrequiredWhen true, notifies the comment creator in addition to other watchers
task_idstringrequiredThe unique identifier of the task to comment on
assigneeintegeroptionalUser ID to assign this comment to
clickup_comment_create_list#Add a new comment to a ClickUp list. Supports assigning the comment to a user and sending notifications.4 params

Add a new comment to a ClickUp list. Supports assigning the comment to a user and sending notifications.

NameTypeRequiredDescription
assigneeintegerrequiredUser ID to assign this comment to
comment_textstringrequiredThe content of the comment
list_idstringrequiredThe unique identifier of the list to comment on
notify_allbooleanrequiredWhen true, also notifies the comment creator
clickup_comment_delete#Permanently delete a ClickUp comment by comment ID. This action cannot be undone.1 param

Permanently delete a ClickUp comment by comment ID. This action cannot be undone.

NameTypeRequiredDescription
comment_idstringrequiredThe unique identifier of the comment to delete
clickup_comment_get_list#Retrieve comments on a ClickUp list. Returns up to 25 most recent comments by default. Use start and start_id for pagination.3 params

Retrieve comments on a ClickUp list. Returns up to 25 most recent comments by default. Use start and start_id for pagination.

NameTypeRequiredDescription
list_idstringrequiredThe unique identifier of the list
startintegeroptionalUnix timestamp in milliseconds of a reference comment for pagination
start_idstringoptionalID of a reference comment for pagination
clickup_comment_get_task#Retrieve comments on a ClickUp task. Returns up to 25 most recent comments. Use start and start_id for pagination.3 params

Retrieve comments on a ClickUp task. Returns up to 25 most recent comments. Use start and start_id for pagination.

NameTypeRequiredDescription
task_idstringrequiredThe unique identifier of the task
startintegeroptionalUnix timestamp in milliseconds of a reference comment for pagination
start_idstringoptionalID of a reference comment for pagination
clickup_comment_update#Update an existing ClickUp comment. Supports changing comment text, assignee, and resolved status.4 params

Update an existing ClickUp comment. Supports changing comment text, assignee, and resolved status.

NameTypeRequiredDescription
assigneeintegerrequiredUser ID to assign this comment to
comment_idstringrequiredThe unique identifier of the comment to update
comment_textstringrequiredNew text content for the comment
resolvedbooleanrequiredWhether the comment is marked as resolved
clickup_folder_create#Create a new folder within a ClickUp space to organize lists and tasks.2 params

Create a new folder within a ClickUp space to organize lists and tasks.

NameTypeRequiredDescription
namestringrequiredThe name for the new folder
space_idstringrequiredThe ID of the space to create the folder in
clickup_folder_delete#Permanently delete a ClickUp folder. This action cannot be undone.1 param

Permanently delete a ClickUp folder. This action cannot be undone.

NameTypeRequiredDescription
folder_idstringrequiredThe unique identifier of the folder to delete
clickup_folder_get#Retrieve details of a specific ClickUp folder by folder ID, including the lists it contains.1 param

Retrieve details of a specific ClickUp folder by folder ID, including the lists it contains.

NameTypeRequiredDescription
folder_idstringrequiredThe unique identifier of the folder
clickup_folder_get_all#Retrieve all folders within a ClickUp space. Optionally filter to include archived folders.2 params

Retrieve all folders within a ClickUp space. Optionally filter to include archived folders.

NameTypeRequiredDescription
space_idstringrequiredThe unique identifier of the space
archivedbooleanoptionalInclude archived folders in results
clickup_folder_update#Rename an existing ClickUp folder.2 params

Rename an existing ClickUp folder.

NameTypeRequiredDescription
folder_idstringrequiredThe unique identifier of the folder to update
namestringrequiredNew name for the folder
clickup_goal_create#Create a new goal in a ClickUp workspace. Goals help track high-level objectives with due dates and owner assignments.6 params

Create a new goal in a ClickUp workspace. Goals help track high-level objectives with due dates and owner assignments.

NameTypeRequiredDescription
colorstringrequiredColor for the goal (hex code)
descriptionstringrequiredDescription of the goal
due_dateintegerrequiredDue date as Unix timestamp in milliseconds
multiple_ownersbooleanrequiredAllow multiple owners for this goal
namestringrequiredName of the goal
team_idstringrequiredThe workspace (team) ID
clickup_goal_delete#Remove a Goal from a ClickUp Workspace.1 param

Remove a Goal from a ClickUp Workspace.

NameTypeRequiredDescription
goal_idstringrequiredGoal ID (UUID)
clickup_goal_get#Retrieve the details of a ClickUp Goal including its targets.1 param

Retrieve the details of a ClickUp Goal including its targets.

NameTypeRequiredDescription
goal_idstringrequiredGoal ID (UUID)
clickup_goal_get_all#Retrieve all goals in a ClickUp workspace. Optionally filter to include or exclude completed goals.2 params

Retrieve all goals in a ClickUp workspace. Optionally filter to include or exclude completed goals.

NameTypeRequiredDescription
team_idstringrequiredThe workspace (team) ID
include_completedbooleanoptionalInclude completed goals in results (defaults to true)
clickup_goal_update#Update an existing ClickUp goal. Supports renaming, changing due date, description, color, and managing owners.5 params

Update an existing ClickUp goal. Supports renaming, changing due date, description, color, and managing owners.

NameTypeRequiredDescription
colorstringrequiredUpdated color for the goal (hex code)
descriptionstringrequiredUpdated description of the goal
due_dateintegerrequiredUpdated due date as Unix timestamp in milliseconds
goal_idstringrequiredThe unique identifier (UUID) of the goal to update
namestringrequiredNew name for the goal
clickup_list_create#Create a new list within a ClickUp folder. Supports setting name, description, due date, priority, and assignee.6 params

Create a new list within a ClickUp folder. Supports setting name, description, due date, priority, and assignee.

NameTypeRequiredDescription
folder_idstringrequiredThe ID of the folder to create the list in
namestringrequiredThe name for the new list
assigneeintegeroptionalUser ID to assign to the list
contentstringoptionalDescription of the list
due_dateintegeroptionalDue date for the list as Unix timestamp in milliseconds
priorityintegeroptionalPriority level: 1 (urgent), 2 (high), 3 (normal), 4 (low)
clickup_list_create_folderless#Create a new list directly within a ClickUp space (not inside a folder). Useful for top-level organization.5 params

Create a new list directly within a ClickUp space (not inside a folder). Useful for top-level organization.

NameTypeRequiredDescription
namestringrequiredThe name for the new list
space_idstringrequiredThe ID of the space to create the list in
contentstringoptionalDescription of the list
due_dateintegeroptionalDue date as Unix timestamp in milliseconds
priorityintegeroptionalPriority level: 1 (urgent), 2 (high), 3 (normal), 4 (low)
clickup_list_delete#Permanently delete a ClickUp list and all its contents. This action cannot be undone.1 param

Permanently delete a ClickUp list and all its contents. This action cannot be undone.

NameTypeRequiredDescription
list_idstringrequiredThe unique identifier of the list to delete
clickup_list_get#Retrieve details of a specific ClickUp list by list ID.1 param

Retrieve details of a specific ClickUp list by list ID.

NameTypeRequiredDescription
list_idstringrequiredThe unique identifier of the list
clickup_list_get_all#Retrieve all lists within a ClickUp folder. Optionally filter to include or exclude archived lists.2 params

Retrieve all lists within a ClickUp folder. Optionally filter to include or exclude archived lists.

NameTypeRequiredDescription
folder_idstringrequiredThe unique identifier of the folder
archivedbooleanoptionalInclude archived lists in results
clickup_list_get_folderless#Retrieve all lists in a ClickUp space that are not inside a folder. These are top-level lists within the space.2 params

Retrieve all lists in a ClickUp space that are not inside a folder. These are top-level lists within the space.

NameTypeRequiredDescription
space_idstringrequiredThe unique identifier of the space
archivedbooleanoptionalInclude archived lists in results
clickup_list_members_list#Retrieve Workspace members who have explicit access to a specific ClickUp List.1 param

Retrieve Workspace members who have explicit access to a specific ClickUp List.

NameTypeRequiredDescription
list_idintegerrequiredList ID
clickup_list_update#Update an existing ClickUp list. Supports renaming, updating description, due date, priority, assignee, and status color.6 params

Update an existing ClickUp list. Supports renaming, updating description, due date, priority, assignee, and status color.

NameTypeRequiredDescription
list_idstringrequiredThe unique identifier of the list to update
namestringrequiredNew name for the list
contentstringoptionalUpdated description for the list
due_dateintegeroptionalUpdated due date as Unix timestamp in milliseconds
priorityintegeroptionalPriority level: 1 (urgent), 2 (high), 3 (normal), 4 (low)
unset_statusbooleanoptionalSet to true to remove the list color
clickup_list_views_list#Retrieve all views in a ClickUp List.1 param

Retrieve all views in a ClickUp List.

NameTypeRequiredDescription
list_idintegerrequiredList ID
clickup_space_create#Create a new space within a ClickUp workspace. Spaces are the top-level organizational units that contain folders and lists.3 params

Create a new space within a ClickUp workspace. Spaces are the top-level organizational units that contain folders and lists.

NameTypeRequiredDescription
multiple_assigneesbooleanrequiredAllow multiple assignees on tasks in this space
namestringrequiredThe name for the new space
team_idstringrequiredThe workspace (team) ID to create the space in
clickup_space_delete#Permanently delete a ClickUp space from your workspace. This action cannot be undone.1 param

Permanently delete a ClickUp space from your workspace. This action cannot be undone.

NameTypeRequiredDescription
space_idstringrequiredThe unique identifier of the space to delete
clickup_space_get#Retrieve details of a specific ClickUp space by space ID.1 param

Retrieve details of a specific ClickUp space by space ID.

NameTypeRequiredDescription
space_idstringrequiredThe unique identifier of the space
clickup_space_get_all#Retrieve all spaces available in a ClickUp workspace (team). Optionally include archived spaces.2 params

Retrieve all spaces available in a ClickUp workspace (team). Optionally include archived spaces.

NameTypeRequiredDescription
team_idstringrequiredThe workspace (team) ID
archivedbooleanoptionalInclude archived spaces in results
clickup_space_tag_create#Create a new tag in a ClickUp Space.4 params

Create a new tag in a ClickUp Space.

NameTypeRequiredDescription
space_idstringrequiredSpace ID
tag_namestringrequiredTag name
tag_bgstringoptionalBackground color (hex)
tag_fgstringoptionalForeground color (hex)
clickup_space_tag_delete#Remove a tag from a ClickUp Space.4 params

Remove a tag from a ClickUp Space.

NameTypeRequiredDescription
space_idstringrequiredSpace ID
tag_namestringrequiredTag name to delete
tag_bgstringoptionalBackground color (hex)
tag_fgstringoptionalForeground color (hex)
clickup_space_tags_list#Retrieve all task tags available in a ClickUp Space.1 param

Retrieve all task tags available in a ClickUp Space.

NameTypeRequiredDescription
space_idstringrequiredSpace ID
clickup_space_update#Update an existing ClickUp space. Supports renaming, changing color, privacy settings, and enabling multiple assignees.5 params

Update an existing ClickUp space. Supports renaming, changing color, privacy settings, and enabling multiple assignees.

NameTypeRequiredDescription
colorstringrequiredColor for the space (hex code)
multiple_assigneesbooleanrequiredAllow multiple assignees on tasks
namestringrequiredNew name for the space
privatebooleanrequiredWhether this space is private
space_idstringrequiredThe unique identifier of the space to update
clickup_space_views_list#Retrieve all views in a ClickUp Space.1 param

Retrieve all views in a ClickUp Space.

NameTypeRequiredDescription
space_idintegerrequiredSpace ID
clickup_task_checklist_create#Add a new checklist to a ClickUp task.4 params

Add a new checklist to a ClickUp task.

NameTypeRequiredDescription
namestringrequiredChecklist name
task_idstringrequiredTask ID
custom_task_idsbooleanoptionalUse custom task IDs
team_idintegeroptionalWorkspace ID (required if custom_task_ids=true)
clickup_task_create#Create a new task in a ClickUp list. Supports setting name, description, assignees, status, priority, due date, start date, and more.9 params

Create a new task in a ClickUp list. Supports setting name, description, assignees, status, priority, due date, start date, and more.

NameTypeRequiredDescription
list_idstringrequiredThe ID of the list to create the task in
namestringrequiredThe name or title of the task
descriptionstringoptionalPlain text description of the task
due_dateintegeroptionalDue date as Unix timestamp in milliseconds
notify_allbooleanoptionalWhen true, notifies task creator and all assignees/watchers
parentstringoptionalID of a parent task to create this as a subtask
priorityintegeroptionalPriority level: 1 (urgent), 2 (high), 3 (normal), 4 (low)
start_dateintegeroptionalStart date as Unix timestamp in milliseconds
statusstringoptionalThe status of the task (must match a status in the list)
clickup_task_create_from_template#Create a new ClickUp task using an existing task template. The template must be added to your workspace before use.3 params

Create a new ClickUp task using an existing task template. The template must be added to your workspace before use.

NameTypeRequiredDescription
list_idstringrequiredThe ID of the list where the task will be created
namestringrequiredThe name for the new task being created from the template
template_idstringrequiredThe ID of the task template to use
clickup_task_delete#Permanently delete a ClickUp task by task ID. This action cannot be undone.1 param

Permanently delete a ClickUp task by task ID. This action cannot be undone.

NameTypeRequiredDescription
task_idstringrequiredThe unique identifier of the task to delete
clickup_task_get#Retrieve details of a specific ClickUp task by task ID. Returns task properties, assignees, status, dates, and custom fields.3 params

Retrieve details of a specific ClickUp task by task ID. Returns task properties, assignees, status, dates, and custom fields.

NameTypeRequiredDescription
task_idstringrequiredThe unique identifier of the task
include_markdown_descriptionbooleanoptionalReturn task description in Markdown format
include_subtasksbooleanoptionalInclude subtasks in the response
clickup_task_list#Retrieve tasks from a specific ClickUp list. Supports filtering by status, assignee, tags, and date ranges. Returns up to 100 tasks per page.7 params

Retrieve tasks from a specific ClickUp list. Supports filtering by status, assignee, tags, and date ranges. Returns up to 100 tasks per page.

NameTypeRequiredDescription
list_idstringrequiredThe ID of the list to retrieve tasks from
archivedbooleanoptionalReturn archived tasks
include_closedbooleanoptionalInclude closed tasks in the results
order_bystringoptionalField to sort tasks by: id, created, updated, or due_date
pageintegeroptionalPage number for pagination (starts at 0)
reversebooleanoptionalDisplay results in reverse order
subtasksbooleanoptionalInclude subtasks in the results
clickup_task_members_list#Retrieve Workspace members who have access to a specific ClickUp task.1 param

Retrieve Workspace members who have access to a specific ClickUp task.

NameTypeRequiredDescription
task_idstringrequiredTask ID
clickup_task_update#Update an existing ClickUp task. Supports updating name, description, status, priority, due date, start date, and other fields.9 params

Update an existing ClickUp task. Supports updating name, description, status, priority, due date, start date, and other fields.

NameTypeRequiredDescription
task_idstringrequiredThe unique identifier of the task to update
archivedbooleanoptionalSet to true to archive the task
descriptionstringoptionalUpdated task description. Use a space character to clear the description.
due_dateintegeroptionalDue date as Unix timestamp in milliseconds
namestringoptionalNew name for the task
priorityintegeroptionalPriority level: 1 (urgent), 2 (high), 3 (normal), 4 (low)
start_dateintegeroptionalStart date as Unix timestamp in milliseconds
statusstringoptionalNew status for the task
time_estimateintegeroptionalTime estimate in milliseconds
clickup_time_entries_list#Retrieve time entries within a date range for a ClickUp Workspace.9 params

Retrieve time entries within a date range for a ClickUp Workspace.

NameTypeRequiredDescription
team_idstringrequiredWorkspace ID
assigneeintegeroptionalFilter by user ID
end_dateintegeroptionalEnd date (Unix ms)
folder_idintegeroptionalFilter by folder ID
is_billablebooleanoptionalFilter by billable status
list_idintegeroptionalFilter by list ID
space_idintegeroptionalFilter by space ID
start_dateintegeroptionalStart date (Unix ms)
task_idstringoptionalFilter by task ID
clickup_time_entry_create#Log a time entry for a task in a ClickUp Workspace.7 params

Log a time entry for a task in a ClickUp Workspace.

NameTypeRequiredDescription
durationintegerrequiredDuration in milliseconds
startintegerrequiredStart timestamp (Unix ms)
team_idstringrequiredWorkspace ID
assigneeintegeroptionalUser ID to assign entry to
billablebooleanoptionalMark as billable
descriptionstringoptionalTime entry description
tidstringoptionalTask ID to associate with
clickup_user_get#Retrieve the details of the authenticated ClickUp user account.0 params

Retrieve the details of the authenticated ClickUp user account.

clickup_view_tasks_list#Retrieve all tasks in a specific ClickUp view.2 params

Retrieve all tasks in a specific ClickUp view.

NameTypeRequiredDescription
view_idstringrequiredView ID
pageintegeroptionalPage number (starts at 0)
clickup_webhook_create#Create a new webhook in a ClickUp workspace to monitor specific events. Use '*' for the events field to subscribe to all events.6 params

Create a new webhook in a ClickUp workspace to monitor specific events. Use '*' for the events field to subscribe to all events.

NameTypeRequiredDescription
endpointstringrequiredThe URL that will receive webhook payloads
eventsstringrequiredComma-separated list of events to subscribe to, or '*' for all events
team_idstringrequiredThe workspace (team) ID
list_idintegeroptionalFilter webhook to a specific list ID
space_idintegeroptionalFilter webhook to a specific space ID
task_idstringoptionalFilter webhook to a specific task ID
clickup_webhook_delete#Delete a ClickUp webhook, stopping it from monitoring events. This action cannot be undone.1 param

Delete a ClickUp webhook, stopping it from monitoring events. This action cannot be undone.

NameTypeRequiredDescription
webhook_idstringrequiredThe unique identifier (UUID) of the webhook to delete
clickup_webhook_get_all#Retrieve all webhooks created via the API for a ClickUp workspace. Only returns webhooks created by the authenticated user.1 param

Retrieve all webhooks created via the API for a ClickUp workspace. Only returns webhooks created by the authenticated user.

NameTypeRequiredDescription
team_idstringrequiredThe workspace (team) ID
clickup_webhook_update#Update an existing ClickUp webhook. Change the endpoint URL, subscribed events, or webhook status.4 params

Update an existing ClickUp webhook. Change the endpoint URL, subscribed events, or webhook status.

NameTypeRequiredDescription
endpointstringrequiredNew destination URL for the webhook
eventsstringrequiredEvents to subscribe to, or '*' for all events
statusstringrequiredStatus of the webhook (active or inactive)
webhook_idstringrequiredThe unique identifier (UUID) of the webhook to update
clickup_workspace_members_list#Retrieve all members in a ClickUp Workspace.1 param

Retrieve all members in a ClickUp Workspace.

NameTypeRequiredDescription
team_idstringrequiredWorkspace ID
clickup_workspace_seats_get#Retrieve seat utilization data for a ClickUp Workspace, showing member and guest seat counts.1 param

Retrieve seat utilization data for a ClickUp Workspace, showing member and guest seat counts.

NameTypeRequiredDescription
team_idstringrequiredWorkspace ID
clickup_workspaces_list#Retrieve all ClickUp Workspaces available to the authenticated user.0 params

Retrieve all ClickUp Workspaces available to the authenticated user.