ClickUp

ClickUp work management: browse workspaces, spaces, folders and lists; list, read, create and update tasks; add comments; read and log time entries.

12 actions API key 8 read4 write Calls api.clickup.com

Connect

TypeScript

const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "clickup" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();

Permissions requested

This toolkit uses a single credential and requests no scopes.

Actions

Add task commentwriteclickup.add_commentAdd a comment to a task, optionally assigning the comment to a user.

Input	Type		Description
`task_id`	string	Required	Task id
`comment_text`	string	Required	Comment text
`assignee`	integer	Optional	User id to assign the comment to
`notify_all`	boolean	Optional	Notify everyone on the task, including the creator

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.add_comment",
  input: {
    "task_id": "<task_id>",
    "comment_text": "<comment_text>"
  },
});

Create taskwriteclickup.create_taskCreate a task in a List. Dates are Unix milliseconds. Assignees are user ids.

Input	Type		Description
`list_id`	string	Required	List id
`name`	string	Required	Task name
`description`	string	Optional	Task description
`assignees`	array of integer	Optional	User ids to assign
`status`	string	Optional	Status name, must exist in the List
`priority`	integer	Optional	1 urgent, 2 high, 3 normal, 4 low
`due_date`	integer	Optional	Due date, Unix milliseconds
`tags`	array of string	Optional	Tag names

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.create_task",
  input: {
    "list_id": "<list_id>",
    "name": "<name>"
  },
});

Create time entrywriteclickup.create_time_entryLog a time entry on a task: start time and duration in Unix milliseconds.

Input	Type		Description
`team_id`	string	Required	Workspace id
`tid`	string	Optional	Task id the time is logged on
`start`	integer	Required	Start, Unix milliseconds
`duration`	integer	Required	Duration in milliseconds
`description`	string	Optional	What was worked on
`billable`	boolean	Optional	Mark as billable

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.create_time_entry",
  input: {
    "team_id": "<team_id>",
    "start": 1,
    "duration": 1
  },
});

Get taskreadclickup.get_taskRead one task by id: name, status, priority, assignees, due date, list and URL.

Input	Type		Description
`task_id`	string	Required	Task id, e.g. 9hx
`include_subtasks`	boolean	Optional	Include subtasks

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.get_task",
  input: {
    "task_id": "<task_id>"
  },
});

List folderless listsreadclickup.list_folderless_listsList the Lists that sit directly in a Space, outside any Folder.

Input	Type		Description
`space_id`	string	Required	Space id from list_spaces
`archived`	boolean	Optional	true to list archived lists

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.list_folderless_lists",
  input: {
    "space_id": "<space_id>"
  },
});

List foldersreadclickup.list_foldersList the Folders in a Space.

Input	Type		Description
`space_id`	string	Required	Space id from list_spaces
`archived`	boolean	Optional	true to list archived folders

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.list_folders",
  input: {
    "space_id": "<space_id>"
  },
});

List lists in a folderreadclickup.list_listsList the Lists inside a Folder. Use list_folderless_lists for Lists that sit directly in a Space.

Input	Type		Description
`folder_id`	string	Required	Folder id from list_folders
`archived`	boolean	Optional	true to list archived lists

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.list_lists",
  input: {
    "folder_id": "<folder_id>"
  },
});

List spacesreadclickup.list_spacesList the Spaces in a Workspace.

Input	Type		Description
`team_id`	string	Required	Workspace id from list_workspaces
`archived`	boolean	Optional	true to list archived spaces

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.list_spaces",
  input: {
    "team_id": "<team_id>"
  },
});

List tasks in a listreadclickup.list_tasksList tasks in a List (100 per page), filtered by status or assignee. Closed and sub tasks are excluded unless asked for.

Input	Type		Description
`list_id`	string	Required	List id
`status`	string	Optional	Only tasks with this status name, e.g. in progress
`assignee`	string	Optional	Only tasks assigned to this user id
`include_closed`	boolean	Optional	Include closed tasks
`subtasks`	boolean	Optional	Include subtasks
`order_by`	string	Optional	id, created, updated or due_date
`page`	integer	Optional	Page number starting at 0

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.list_tasks",
  input: {
    "list_id": "<list_id>"
  },
});

List time entriesreadclickup.list_time_entriesList time entries in a date range (default last 30 days, your own entries unless assignee is given). A negative duration means a timer is running.

Input	Type		Description
`team_id`	string	Required	Workspace id
`start_date`	integer	Optional	Range start, Unix milliseconds
`end_date`	integer	Optional	Range end, Unix milliseconds
`assignee`	string	Optional	User id (comma-separated for several)
`task_id`	string	Optional	Only this task

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.list_time_entries",
  input: {
    "team_id": "<team_id>"
  },
});

List workspacesreadclickup.list_workspacesList the ClickUp Workspaces (called teams in the API) the token can access. Their ids are the team_id for other actions.

No input.

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.list_workspaces",
  input: {},
});

Update taskwriteclickup.update_taskChange a task's name, description, status, priority or due date. Only the fields you pass change.

Input	Type		Description
`task_id`	string	Required	Task id
`name`	string	Optional	New name
`description`	string	Optional	New description
`status`	string	Optional	New status name, must exist in the List
`priority`	integer	Optional	1 urgent, 2 high, 3 normal, 4 low
`due_date`	integer	Optional	New due date, Unix milliseconds
`archived`	boolean	Optional	true to archive the task

TypeScript

await setu.execute({
  userId: "user_1",
  action: "clickup.update_task",
  input: {
    "task_id": "<task_id>"
  },
});