clickup.js

Classes

authorization ⇐ Route
checklist ⇐ Route
comment ⇐ Route
folder ⇐ Route
goal ⇐ Route
group ⇐ Route
key-result ⇐ Route
list ⇐ Route
space ⇐ Route
task ⇐ Route
team ⇐ Route
view ⇐ Route
webhook ⇐ Route

Functions

createToken(options): Create an access token for the given client
user(): Get the details of the authenticated user's ClickUp account
teams(): Get the teams (workspaces) available to the authenticated user
update(checklistId, data): Update a checklist
delete(checklistId): Delete a checklist
addItem(checklistId, data): Create a checklist item
editItem(checklistId, checklistItemId, data): Update a checklist item
removeItem(checklistId, checklistItemId): Delete a checklist item
update(commentId, data): Update the content of a task comment, assign a comment, and mark a comment as resolved.
delete(commentId): Delete a comment
replies(commentId): Get comment thread/replies
addReply(commentId, data): Add a reply comment
get(folderId): Get a folder
update(folderId, data): Update a folder
delete(folderId): Delete a folder
addGuest(folderId, guestId, data, [options]): Add a guest to a folder
removeGuest(folderId, guestId, [options]): Remove a guest's access to a folder
createList(folderId, data): Create a list
lists(folderId, [options]): Get all lists within a folder
createView(folderId, data): Create a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view for a Folder
views(folderId): Get the task and page views available for a Folder.
customFields(folderId): Get all Custom Fields available in a folder
get(goalId): Get a goal
update(goalId, data): Update the goal name, set the due date, replace the description, add or remove owners, and set the Goal color
delete(goalId): Delete a goal from your team
addKeyResult(goalId, data): Add a key result (target)
get([options]): Get all user groups within a team
update(groupId, data): Update a user group
delete(groupId): Delete a user group
update(keyResultId, data): Update a key result (target)
delete(keyResultId): Delete a key result (target)
get(listId): Get a list
update(listId, data): Update a list
delete(listId): Delete a list
addComment(listId, data): Add a comment to a list
comments(listId, [options]): Get all comments added to a list
customFields(listId): Get all Custom Fields available on tasks in a specific list
addGuest(listId, guestId, data, [options]): Share a list with a guest
removeGuest(listId, guestId, options): Remove a guest's access to a list
members(listId): Get all members of a list
createTask(listId, data, [options]): Create a task
tasks(listId, options): Get all tasks in a list
createTaskFromTemplate(listId, templateId, data): Create a task from a template
createView(listId, data): Create a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view for a List
views(listId): Get the task and page views available for a List. Views and required views are separate responses
addTask(listId, taskId): Add task to a list
removeTask(listId, taskId): Remove a task from a list
get(spaceId): Get a space
update(spaceId, data): Update a spaces name, set the space color, and enable ClickApps for a space.
delete(spaceId): Delete a space
createFolder(spaceId, data): Create a folder in a space
folders(spaceId, [options]): Get all folders in a space
createFolderlessList(spaceId, data): Create a folder-less list
folderlessLists(spaceId, [options]): Get all folderless lists in a space
tags(spaceId): Get all tags in a space
addTag(spaceId, data): Create a space tag
editTag(spaceId, tagName, data): Update a space tag
removeTag(spaceId, tagName, data): Delete a space tag
createView(spaceId, data): Create a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view for a Space
views(spaceId): Get the task and page views available for a Space
customFields(spaceId): Get all Custom Fields available in a space
get(taskId, [options]): Get a task
update(taskId, data, [options]): Update a task
delete(taskId, [options]): Delete a task
addAttachment(taskId, attachment, [options]): Upload a file to a task as an attachment.
addComment(taskId, data, [options]): Add a comment to as task
comments(taskId, [options]): Get all task comments
AddChecklist(taskId, data, [options]): Add a checklist in a task
addCustomFieldValue(taskId, fieldId, data, [options]): Add data to a custom field on a task
removeCustomFieldValue(taskId, fieldId, [options]): Remove a custom field value on a task
addDependency(taskId, data, [options]): Create a dependency for a task i.e. set a task as waiting on or blocking another task.
removeDependency(taskId, [options]): Delete a dependency for a task
addTaskLink(taskId, linksTo, [options]): Link two task together
removeTaskLink(taskId, linksTo, [options]): Delete a task link
addGuest(taskId, guestId, data, [options]): Share a task with a guest
removeGuest(taskId, guestId, [options]): Remove a guest's access to a task
members(taskId): Get all members who have access to a task
addTag(taskId, tagName, [options]): Add a tag to a task
removeTag(taskId, tagName, [options]): Remove a tag from a task
addTrackedTime(taskId, data, [options]): Track time for a task (Time Tracking Legacy API)
trackedTime(taskId, [options]): Get tracked time for a task (Time Tracking Legacy API)
editTrackedTime(taskId, intervalId, data, [options]): Edit tracked time for a task (Time Tracking Legacy API)
removeTrackedTime(taskId, intervalId, [options]): Delete tracked time for a task
timeInStatus(taskId, [options]): Get tasks time in status
bulkTimeInStatus(options): Get bulk tasks time in status
get(): Get teams
createGoal(teamId, data): Create a goal
goals(teamId, options): Get all goals for a team
inviteGuest(teamId, data): Invite a guest to a team (workspace)
guest(teamId, guestId): Get information about a team (workspace) guest
editGuest(teamId, guestId, data): Edit a guest in a team (workspace)
removeGuest(teamId, guestId): Remove a guest from a team (workspace)
sharedHierarchy(teamId): Get the tasks, lists, and folders that have been shared with the authenticated user
createSpace(teamId, data): Create a space for a team (workspace)
spaces(teamId, [options]): Get available spaces for a team (workspace)
filteredTasks(teamId, [options]): Get filtered tasks for a team
taskTemplates(teamId, [options]): Get task templates for a team
user(teamId, userId): Get a user for a team. Only available to enterprise teams
inviteUser(teamId, data): Invite a user to a workspace/team. Only available to enterprise teams
editUser(teamId, userId, data): Edit a user for a workspace/team. Only available to enterprise teams
removeUser(teamId, userId): Remove (deactivate) a user from a workspace/team. Only available to enterprise teams
createView(teamId, data): Create a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view at the Everything Level of a Workspace.
views(teamId): Get the task and page views available at the Everything Level of a Workspace.
createWebhook(teamId, data): Create a webhook
webhooks(teamId): Get the webhooks created via the API for a Workspace. This endpoint returns webhooks created by the authenticated user
timeEntries(teamId, [options]): Get time entries within a data range
timeEntry(teamId, timerId, [options]): Get a single time entry
runningTimeEntry(teamId, [options]): Get time entry that's currently tracking time for the authenticated user.
addTimeEntry(teamId, data, [options]): Create a time entry
removeTimeEntryTags(teamId, data): Remove tags from time entries
timeEntryTags(teamId): Get all tags from time entries
addTimeEntryTags(teamId, data): Add a label to time entries
editTimeEntryTag(teamId, data): Rename an time entry label
startTimeEntry(teamId, data, [options]): Start a time entry
stopTimeEntry(teamId): Stop a time entry
removeTimeEntry(teamId, timerId): Delete a time entry
editTimeEntry(teamId, timerId, data, [options]): Update a time entry
timeEntryHistory(teamId, timerId): Get a list of changes made to a time entry
seats(teamId): Retrieve the used, total, and available member and guest seats for a team (workspace).
plan(teamId): Retrieve the current Plan for the specified team (workspace).
customTaskTypes(teamId): Get the custom task types available in a team (workspace).
customRoles(teamId, [options]): Get the custom roles available in a team (workspace).
addUserGroup(teamId, data): Add a team user group.
customFields(teamId): Get all Custom Fields available in a team (workspace)
get(viewId): Get information about a specific task or page view
update(viewId, data): Update a view
delete(viewId): Delete a view
addComment(viewId, data): Add a comment on a view
comments(viewId, [options]): Get all comments from a Chat view
tasks(viewId, [options]): Get all visible tasks in a view
update(webhookId, data): Update a webhook
delete(webhookId): Delete a webhook

authorization ⇐ `Route`

Kind: global class
Extends: Route

checklist ⇐ `Route`

Kind: global class
Extends: Route

comment ⇐ `Route`

Kind: global class
Extends: Route

folder ⇐ `Route`

Kind: global class
Extends: Route

goal ⇐ `Route`

Kind: global class
Extends: Route

group ⇐ `Route`

Kind: global class
Extends: Route

key-result ⇐ `Route`

Kind: global class
Extends: Route

list ⇐ `Route`

Kind: global class
Extends: Route

space ⇐ `Route`

Kind: global class
Extends: Route

task ⇐ `Route`

Kind: global class
Extends: Route

team ⇐ `Route`

Kind: global class
Extends: Route

view ⇐ `Route`

Kind: global class
Extends: Route

webhook ⇐ `Route`

Kind: global class
Extends: Route

createToken(options)

Create an access token for the given client

Kind: global function

Param	Type	Description
options	`object`	The query parameters to pass
options.clientId	`string`	The OAuth app client id
options.clientSecret	`string`	The OAuth app client secret
options.code	`string`	The code given in redirect url

user()

Get the details of the authenticated user's ClickUp account

Kind: global function

teams()

Get the teams (workspaces) available to the authenticated user

Kind: global function

update(checklistId, data)

Update a checklist

Kind: global function
See: https://clickup.com/api/clickupreference/operation/EditChecklist

Param	Type	Description
checklistId	`string`	The checklist id
data	`object`	The checklist data

delete(checklistId)

Delete a checklist

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteChecklist

Param	Type	Description
checklistId	`string`	The checklist id

addItem(checklistId, data)

Create a checklist item

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateChecklistItem

Param	Type	Description
checklistId	`string`	The checklist id
data	`object`	The checklist item data

editItem(checklistId, checklistItemId, data)

Update a checklist item

Kind: global function
See: https://clickup.com/api/clickupreference/operation/EditChecklistItem

Param	Type	Description
checklistId	`string`	The checklist id
checklistItemId	`string`	The checklist item id
data	`object`	The checklist item data

removeItem(checklistId, checklistItemId)

Delete a checklist item

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteChecklistItem

Param	Type	Description
checklistId	`string`	The checklist id
checklistItemId	`string`	The checklist item id

update(commentId, data)

Update the content of a task comment, assign a comment, and mark a comment as resolved.

Kind: global function
See: https://clickup.com/api/clickupreference/operation/UpdateComment

Param	Type	Description
commentId	`number`	The comment id
data	`object`	The comment data

delete(commentId)

Delete a comment

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteComment

Param	Type	Description
commentId	`number`	The comment id

replies(commentId)

Get comment thread/replies

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetThreadedComments

Param	Type	Description
commentId	`number`	The comment id

addReply(commentId, data)

Add a reply comment

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateThreadedComment

Param	Type	Description
commentId	`number`	The comment id
data	`object`	The comment data

get(folderId)

Get a folder

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetFolder

Param	Type	Description
folderId	`string`	The folder id

update(folderId, data)

Update a folder

Kind: global function
See: https://clickup.com/api/clickupreference/operation/UpdateFolder

Param	Type	Description
folderId	`number`	The folder id
data	`object`	The folder data

delete(folderId)

Delete a folder

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteFolder

Param	Type	Description
folderId	`number`	The folder id

addGuest(folderId, guestId, data, [options])

Add a guest to a folder

Kind: global function
See: https://clickup.com/api/clickupreference/operation/AddGuestToFolder

Param	Type	Description
folderId	`number`	The folder id
guestId	`number`	The guest id
data	`object`	The guest data
[options]	`object`	The query parameters to use

removeGuest(folderId, guestId, [options])

Remove a guest's access to a folder

Kind: global function
See: https://clickup.com/api/clickupreference/operation/RemoveGuestFromFolder

Param	Type	Description
folderId	`number`	The folder id
guestId	`number`	The guest id
[options]	`object`	The query parameters to use

createList(folderId, data)

Create a list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateList

Param	Type	Description
folderId	`number`	The folder id
data	`object`	The list data

lists(folderId, [options])

Get all lists within a folder

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetLists

Param	Type	Description
folderId	`number`	The folder id
[options]	`object`	The query parameters to pass
options.archived	`boolean`	If archived lists should be returned or not

createView(folderId, data)

Create a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view for a Folder

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateFolderView

Param	Type	Description
folderId	`number`	The folder id
data	`object`	The view data

views(folderId)

Get the task and page views available for a Folder.

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateSpaceView

Param	Type	Description
folderId	`number`	The folder id

customFields(folderId)

Get all Custom Fields available in a folder

Kind: global function

Param	Type	Description
folderId	`number`	The folder id

get(goalId)

Get a goal

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetGoal

Param	Type	Description
goalId	`string`	The goal id

update(goalId, data)

Update the goal name, set the due date, replace the description, add or remove owners, and set the Goal color

Kind: global function
See: https://clickup.com/api/clickupreference/operation/UpdateGoal

Param	Type	Description
goalId	`string`	The goal id
data	`object`	The goal data

delete(goalId)

Delete a goal from your team

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteGoal

Param	Type	Description
goalId	`string`	The goal id

addKeyResult(goalId, data)

Add a key result (target)

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateKeyResult

Param	Type	Description
goalId	`string`	The goal id
data	`object`	The key result data

get([options])

Get all user groups within a team

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetTeams1

Param	Type	Description
[options]	`object`	The query parameters to use

update(groupId, data)

Update a user group

Kind: global function
See: https://clickup.com/api/clickupreference/operation/UpdateTeam

Param	Type	Description
groupId	`string`	The group id
data	`object`	The group data

delete(groupId)

Delete a user group

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteTeam

Param	Type	Description
groupId	`string`	The group id

update(keyResultId, data)

Update a key result (target)

Kind: global function
See: https://clickup.com/api/clickupreference/operation/EditKeyResult

Param	Type	Description
keyResultId	`string`	The key result id
data	`object`	The key result data

delete(keyResultId)

Delete a key result (target)

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteKeyResult

Param	Type	Description
keyResultId	`string`	The key result id

get(listId)

Get a list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetList

Param	Type	Description
listId	`number`	The list id

update(listId, data)

Update a list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/UpdateList

Param	Type	Description
listId	`string`	The list id
data	`object`	The list data

delete(listId)

Delete a list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteList

Param	Type	Description
listId	`number`	The list id

addComment(listId, data)

Add a comment to a list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateListComment

Param	Type	Description
listId	`string`	The list id
data	`object`	The comment data

comments(listId, [options])

Get all comments added to a list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetListComments

Param	Type	Description
listId	`number`	The list id
[options]	`object`	The query parameters to use

customFields(listId)

Get all Custom Fields available on tasks in a specific list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetAccessibleCustomFields

Param	Type	Description
listId	`number`	The list id

addGuest(listId, guestId, data, [options])

Share a list with a guest

Kind: global function
See: https://clickup.com/api/clickupreference/operation/AddGuestToList

Param	Type	Description
listId	`number`	The list id
guestId	`number`	The guest id
data	`object`	The guest data
[options]	`object`	The query parameters to use

removeGuest(listId, guestId, options)

Remove a guest's access to a list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/RemoveGuestFromList

Param	Type	Description
listId	`number`	The list id
guestId	`number`	The guest id
options	`object`	The query parameters to use

members(listId)

Get all members of a list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetListMembers

Param	Type	Description
listId	`number`	The list id

createTask(listId, data, [options])

Create a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateTask

Param	Type	Description
listId	`number`	The list id
data	`object`	The task data
[options]	`object`	The query parameters to use

tasks(listId, options)

Get all tasks in a list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetTasks

Param	Type	Description
listId	`number`	The list id
options	`object`	The query parameters to pass

createTaskFromTemplate(listId, templateId, data)

Create a task from a template

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateTaskFromTemplate/#tag/Task-Templates/operation/CreateTaskFromTemplat

Param	Type	Description
listId	`number`	The list id
templateId	`string`	The template id
data	`object`	The task data

createView(listId, data)

Create a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view for a List

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateListView

Param	Type	Description
listId	`number`	The list id
data	`object`	The view data

views(listId)

Get the task and page views available for a List. Views and required views are separate responses

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetListViews

Param	Type	Description
listId	`number`	The list id

addTask(listId, taskId)

Add task to a list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/AddTaskToList

Param	Type	Description
listId	`number`	The list id
taskId	`string`	The task id

removeTask(listId, taskId)

Remove a task from a list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/RemoveTaskFromList

Param	Type	Description
listId	`number`	The list id
taskId	`string`	The task id

get(spaceId)

Get a space

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetSpace/

Param	Type	Description
spaceId	`number`	The space id

update(spaceId, data)

Update a spaces name, set the space color, and enable ClickApps for a space.

Kind: global function
See: https://clickup.com/api/clickupreference/operation/UpdateSpace

Param	Type	Description
spaceId	`number`	The space id
data	`object`	The space data

delete(spaceId)

Delete a space

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteSpace

Param	Type	Description
spaceId	`number`	The space id

createFolder(spaceId, data)

Create a folder in a space

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateFolder

Param	Type	Description
spaceId	`number`	The space id
data	`object`	The folder data

folders(spaceId, [options])

Get all folders in a space

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetFolders

Param	Type	Description
spaceId	`number`	The space id
[options]	`object`	The query parameters to pass
options.archived	`boolean`	If archived lists should be returned or not

createFolderlessList(spaceId, data)

Create a folder-less list

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateFolderlessList

Param	Type	Description
spaceId	`number`	The space id
data	`object`	The folder-less list data

folderlessLists(spaceId, [options])

Get all folderless lists in a space

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetFolderlessLists

Param	Type	Description
spaceId	`number`	The space id
[options]	`object`	The query parameters to pass
options.archived	`boolean`	If archived lists should be returned or not

tags(spaceId)

Get all tags in a space

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetSpaceTags

Param	Type	Description
spaceId	`number`	The space id

addTag(spaceId, data)

Create a space tag

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateSpaceTag

Param	Type	Description
spaceId	`number`	The space id
data	`object`	The space tag data

editTag(spaceId, tagName, data)

Update a space tag

Kind: global function
See: https://clickup.com/api/clickupreference/operation/EditSpaceTag

Param	Type	Description
spaceId	`number`	The space id
tagName	`string`	The tag name
data	`object`	The space tag data

removeTag(spaceId, tagName, data)

Delete a space tag

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteSpaceTag

Param	Type	Description
spaceId	`number`	The space id
tagName	`string`	The tag name
data	`object`	The space tag data

createView(spaceId, data)

Create a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view for a Space

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateSpaceView

Param	Type	Description
spaceId	`number`	The space id
data	`object`	The view data

views(spaceId)

Get the task and page views available for a Space

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetSpaceViews

Param	Type	Description
spaceId	`number`	The space id

customFields(spaceId)

Get all Custom Fields available in a space

Kind: global function

Param	Type	Description
spaceId	`number`	The space id

get(taskId, [options])

Get a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetTask

Param	Type	Description
taskId	`string`	The task id
[options]	`object`	The query parameters to use

update(taskId, data, [options])

Update a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/UpdateTask

Param	Type	Description
taskId	`string`	The task id
data	`object`	The task data
[options]	`object`	The query parameters to use

delete(taskId, [options])

Delete a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteTask

Param	Type	Description
taskId	`string`	The task id
[options]	`object`	The query parameters to use

addAttachment(taskId, attachment, [options])

Upload a file to a task as an attachment.

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateTaskAttachment

Param	Type	Description
taskId	`string`	The task id
attachment	`FormData`	The attachments to add
[options]	`object`	The query parameters to use

addComment(taskId, data, [options])

Add a comment to as task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateTaskComment

Param	Type	Description
taskId	`string`	The task id
data	`object`	The comment data
[options]	`object`	The query parameters to use

comments(taskId, [options])

Get all task comments

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetTaskComments

Param	Type	Description
taskId	`string`	The task id
[options]	`object`	The query parameters to use

AddChecklist(taskId, data, [options])

Add a checklist in a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateChecklist

Param	Type	Description
taskId	`string`	The task id
data	`object`	The checklist data
[options]	`object`	The query parameters to use

addCustomFieldValue(taskId, fieldId, data, [options])

Add data to a custom field on a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/SetCustomFieldValue

Param	Type	Description
taskId	`string`	The task id
fieldId	`string`	The uuid of the custom field
data	`object`	The custom field data
[options]	`object`	The query parameters to use

removeCustomFieldValue(taskId, fieldId, [options])

Remove a custom field value on a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/RemoveCustomFieldValue

Param	Type	Description
taskId	`string`	The task id
fieldId	`string`	The uuid of the custom field
[options]	`object`	The query parameters to use

addDependency(taskId, data, [options])

Create a dependency for a task i.e. set a task as waiting on or blocking another task.

Kind: global function
See: https://clickup.com/api/clickupreference/operation/AddDependency

Param	Type	Description
taskId	`string`	The task id
data	`object`	The dependency data
[options]	`object`	The query parameters to use

removeDependency(taskId, [options])

Delete a dependency for a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteDependency

Param	Type	Description
taskId	`string`	The task id
[options]	`object`	The parameter options to pass in

addTaskLink(taskId, linksTo, [options])

Link two task together

Kind: global function
See: https://clickup.com/api/clickupreference/operation/AddTaskLink

Param	Type	Description
taskId	`string`	The task id
linksTo	`string`	The id of the task to link to
[options]	`object`	The query parameters to use

removeTaskLink(taskId, linksTo, [options])

Delete a task link

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteTaskLink

Param	Type	Description
taskId	`string`	The task id
linksTo	`string`	The id of the task to link to
[options]	`object`	The query parameters to use

addGuest(taskId, guestId, data, [options])

Share a task with a guest

Kind: global function
See: https://clickup.com/api/clickupreference/operation/AddGuestToTask

Param	Type	Description
taskId	`string`	The task id
guestId	`number`	The guest id
data	`object`	The guest data
[options]	`object`	The query parameters to use

removeGuest(taskId, guestId, [options])

Remove a guest's access to a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/RemoveGuestFromTask

Param	Type	Description
taskId	`string`	The task id
guestId	`number`	The guest id
[options]	`object`	The query parameters to use

members(taskId)

Get all members who have access to a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetTaskMembers

Param	Type	Description
taskId	`string`	The task id

addTag(taskId, tagName, [options])

Add a tag to a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/AddTagToTask

Param	Type	Description
taskId	`string`	The task id
tagName	`string`	The tag name
[options]	`object`	The query parameters to use

removeTag(taskId, tagName, [options])

Remove a tag from a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/RemoveTagFromTask

Param	Type	Description
taskId	`string`	The task id
tagName	`string`	The tag name
[options]	`object`	The query parameters to use

addTrackedTime(taskId, data, [options])

Track time for a task (Time Tracking Legacy API)

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Tracktime

Param	Type	Description
taskId	`string`	The task id
data	`object`	The time tracking data
[options]	`object`	The query parameters to use

trackedTime(taskId, [options])

Get tracked time for a task (Time Tracking Legacy API)

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Gettrackedtime

Param	Type	Description
taskId	`string`	The task id
[options]	`object`	The query parameters to use

editTrackedTime(taskId, intervalId, data, [options])

Edit tracked time for a task (Time Tracking Legacy API)

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Edittimetracked

Param	Type	Description
taskId	`string`	The task id
intervalId	`string`	The interval id
data	`object`	The time tracking data
[options]	`object`	The query parameters to use

removeTrackedTime(taskId, intervalId, [options])

Delete tracked time for a task

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Deletetimetracked

Param	Type	Description
taskId	`string`	The task id
intervalId	`string`	The interval id
[options]	`object`	The query parameters to use

timeInStatus(taskId, [options])

Get tasks time in status

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetTask'sTimeinStatus

Param	Type	Description
taskId	`string`	The task id
[options]	`object`	The query parameters to use

bulkTimeInStatus(options)

Get bulk tasks time in status

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetBulkTasks'TimeinStatus

Param	Type	Description
options	`object`	The query parameters to use

get()

Get teams

Kind: global function

createGoal(teamId, data)

Create a goal

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateGoal

Param	Type	Description
teamId	`number`	The team id
data	`object`	Goal data

goals(teamId, options)

Get all goals for a team

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetGoals

Param	Type	Description
teamId	`number`	The team id
options	`object`	The query parameters to use

inviteGuest(teamId, data)

Invite a guest to a team (workspace)

Kind: global function
See: https://clickup.com/api/clickupreference/operation/InviteGuestToWorkspace

Param	Type	Description
teamId	`number`	The team id
data	`object`	The guest data

guest(teamId, guestId)

Get information about a team (workspace) guest

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetGuest

Param	Type	Description
teamId	`number`	The team id
guestId	`number`	The guest id

editGuest(teamId, guestId, data)

Edit a guest in a team (workspace)

Kind: global function
See: https://clickup.com/api/clickupreference/operation/EditGuestOnWorkspace

Param	Type	Description
teamId	`number`	The team id
guestId	`number`	The guest id
data	`object`	The guest data

removeGuest(teamId, guestId)

Remove a guest from a team (workspace)

Kind: global function
See: https://clickup.com/api/clickupreference/operation/RemoveGuestFromWorkspace

Param	Type	Description
teamId	`number`	The team id
guestId	`number`	The guest id

sharedHierarchy(teamId)

Get the tasks, lists, and folders that have been shared with the authenticated user

Kind: global function
See: https://clickup.com/api/clickupreference/operation/SharedHierarchy

Param	Type	Description
teamId	`number`	The team id

createSpace(teamId, data)

Create a space for a team (workspace)

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateSpace

Param	Type	Description
teamId	`number`	The team id
data	`object`	The space data

spaces(teamId, [options])

Get available spaces for a team (workspace)

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetSpaces

Param	Type	Description
teamId	`number`	The team id
[options]	`object`	The query parameters to pass
options.archived	`boolean`	If archived lists should be returned or not

filteredTasks(teamId, [options])

Get filtered tasks for a team

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetFilteredTeamTasks

Param	Type	Description
teamId	`number`	The team id
[options]	`object`	The query parameters to pass

taskTemplates(teamId, [options])

Get task templates for a team

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetTaskTemplates

Param	Type	Description
teamId	`number`	The team id
[options]	`object`	The query parameters to pass

user(teamId, userId)

Get a user for a team. Only available to enterprise teams

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetUser

Param	Type	Description
teamId	`number`	The team id
userId	`number`	The user id

inviteUser(teamId, data)

Invite a user to a workspace/team. Only available to enterprise teams

Kind: global function
See: https://clickup.com/api/clickupreference/operation/InviteUserToWorkspace

Param	Type	Description
teamId	`number`	The team id
data	`object`	The user data

editUser(teamId, userId, data)

Edit a user for a workspace/team. Only available to enterprise teams

Kind: global function
See: https://clickup.com/api/clickupreference/operation/EditUserOnWorkspace

Param	Type	Description
teamId	`number`	The team id
userId	`number`	The user id
data	`object`	The user data

removeUser(teamId, userId)

Remove (deactivate) a user from a workspace/team. Only available to enterprise teams

Kind: global function
See: https://clickup.com/api/clickupreference/operation/RemoveUserFromWorkspace

Param	Type	Description
teamId	`number`	The team id
userId	`number`	The team id

createView(teamId, data)

Create a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view at the Everything Level of a Workspace.

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateTeamView

Param	Type	Description
teamId	`number`	The team id
data	`object`	The view data

views(teamId)

Get the task and page views available at the Everything Level of a Workspace.

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetTeamViews

Param	Type	Description
teamId	`number`	The team id

createWebhook(teamId, data)

Create a webhook

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateWebhook

Param	Type	Description
teamId	`number`	The team id
data	`object`	The webhook data

webhooks(teamId)

Get the webhooks created via the API for a Workspace. This endpoint returns webhooks created by the authenticated user

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetWebhooks

Param	Type	Description
teamId	`number`	the team id

timeEntries(teamId, [options])

Get time entries within a data range

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Gettimeentrieswithinadaterange

Param	Type	Description
teamId	`number`	The team id
[options]	`object`	The query parameters to use

timeEntry(teamId, timerId, [options])

Get a single time entry

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Getsingulartimeentry

Param	Type	Description
teamId	`number`	The team id
timerId	`string`	The timer id
[options]	`object`	The query parameters to use

runningTimeEntry(teamId, [options])

Get time entry that's currently tracking time for the authenticated user.

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Getrunningtimeentry

Param	Type	Description
teamId	`number`	The team id
[options]	`object`	The query parameters to use

addTimeEntry(teamId, data, [options])

Create a time entry

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Createatimeentry

Param	Type	Description
teamId	`number`	The team id
data	`object`	The time entry data
[options]	`object`	The query parameters to use

removeTimeEntryTags(teamId, data)

Remove tags from time entries

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Removetagsfromtimeentries

Param	Type	Description
teamId	`number`	The team id
data	`object`	The time entries data

timeEntryTags(teamId)

Get all tags from time entries

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Getalltagsfromtimeentries

Param	Type	Description
teamId	`number`	The team id

addTimeEntryTags(teamId, data)

Add a label to time entries

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Addtagsfromtimeentries

Param	Type	Description
teamId	`number`	The team id
data	`object`	The time entries and tag data

editTimeEntryTag(teamId, data)

Rename an time entry label

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Changetagnamesfromtimeentries

Param	Type	Description
teamId	`number`	The team id
data	`object`	The tag data

startTimeEntry(teamId, data, [options])

Start a time entry

Kind: global function
See: https://clickup.com/api/clickupreference/operation/StartatimeEntry

Param	Type	Description
teamId	`number`	The team id
data	`object`	The time entry data
[options]	`object`	The query parameters to use

stopTimeEntry(teamId)

Stop a time entry

Kind: global function
See: https://clickup.com/api/clickupreference/operation/StopatimeEntry

Param	Type	Description
teamId	`number`	The team id

removeTimeEntry(teamId, timerId)

Delete a time entry

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteatimeEntry

Param	Type	Description
teamId	`number`	The team id
timerId	`number`	The timer id

editTimeEntry(teamId, timerId, data, [options])

Update a time entry

Kind: global function
See: https://clickup.com/api/clickupreference/operation/UpdateatimeEntry

Param	Type	Description
teamId	`number`	The team id
timerId	`number`	The timer id
data	`object`	The time entry data
[options]	`object`	The query parameters to use

timeEntryHistory(teamId, timerId)

Get a list of changes made to a time entry

Kind: global function
See: https://clickup.com/api/clickupreference/operation/Gettimeentryhistory

Param	Type	Description
teamId	`number`	The team id
timerId	`string`	The timer id

seats(teamId)

Retrieve the used, total, and available member and guest seats for a team (workspace).

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetWorkspaceseats

Param	Type	Description
teamId	`string`	The team id

plan(teamId)

Retrieve the current Plan for the specified team (workspace).

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetWorkspaceplan

Param	Type	Description
teamId	`string`	The team id

customTaskTypes(teamId)

Get the custom task types available in a team (workspace).

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetCustomItems

Param	Type	Description
teamId	`string`	The team id

customRoles(teamId, [options])

Get the custom roles available in a team (workspace).

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetCustomRoles

Param	Type	Description
teamId	`string`	The team id
[options]	`object`	The query parameters to use

addUserGroup(teamId, data)

Add a team user group.

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateTeam

Param	Type	Description
teamId	`number`	The team id
data	`object`	The team data

customFields(teamId)

Get all Custom Fields available in a team (workspace)

Kind: global function

Param	Type	Description
teamId	`number`	The team id

get(viewId)

Get information about a specific task or page view

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetView

Param	Type	Description
viewId	`string`	The view id

update(viewId, data)

Update a view

Kind: global function
See: https://clickup.com/api/clickupreference/operation/UpdateView

Param	Type	Description
viewId	`string`	The view id
data	`object`	The view data

delete(viewId)

Delete a view

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteView

Param	Type	Description
viewId	`string`	The view id

addComment(viewId, data)

Add a comment on a view

Kind: global function
See: https://clickup.com/api/clickupreference/operation/CreateChatViewComment

Param	Type	Description
viewId	`string`	The view id
data	`object`	The comment data

comments(viewId, [options])

Get all comments from a Chat view

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetChatViewComments

Param	Type	Description
viewId	`string`	The view id
[options]	`object`	The query parameters to pass

tasks(viewId, [options])

Get all visible tasks in a view

Kind: global function
See: https://clickup.com/api/clickupreference/operation/GetViewTasks

Param	Type	Description
viewId	`string`	The view id
[options]	`object`	The query parameters to pass

update(webhookId, data)

Update a webhook

Kind: global function
See: https://clickup.com/api/clickupreference/operation/UpdateWebhook

Param	Type	Description
webhookId	`string`	The webhook id
data	`object`	The webhook data

delete(webhookId)

Delete a webhook

Kind: global function
See: https://clickup.com/api/clickupreference/operation/DeleteWebhook

Param	Type	Description
webhookId	`string`	The webhook id

Classes ​

Functions ​

authorization ⇐ Route ​

checklist ⇐ Route ​

comment ⇐ Route ​

folder ⇐ Route ​

goal ⇐ Route ​

group ⇐ Route ​

key-result ⇐ Route ​

list ⇐ Route ​

space ⇐ Route ​

task ⇐ Route ​

team ⇐ Route ​

view ⇐ Route ​

webhook ⇐ Route ​

createToken(options) ​

user() ​

teams() ​

update(checklistId, data) ​

delete(checklistId) ​

addItem(checklistId, data) ​

editItem(checklistId, checklistItemId, data) ​

removeItem(checklistId, checklistItemId) ​

update(commentId, data) ​

delete(commentId) ​

replies(commentId) ​

addReply(commentId, data) ​

get(folderId) ​

update(folderId, data) ​

delete(folderId) ​

addGuest(folderId, guestId, data, [options]) ​

removeGuest(folderId, guestId, [options]) ​

createList(folderId, data) ​

lists(folderId, [options]) ​

createView(folderId, data) ​

views(folderId) ​

customFields(folderId) ​

get(goalId) ​

update(goalId, data) ​

delete(goalId) ​

addKeyResult(goalId, data) ​

get([options]) ​

update(groupId, data) ​

delete(groupId) ​

update(keyResultId, data) ​

delete(keyResultId) ​

get(listId) ​

update(listId, data) ​

delete(listId) ​

addComment(listId, data) ​

comments(listId, [options]) ​

customFields(listId) ​

addGuest(listId, guestId, data, [options]) ​

removeGuest(listId, guestId, options) ​

members(listId) ​

createTask(listId, data, [options]) ​

tasks(listId, options) ​

createTaskFromTemplate(listId, templateId, data) ​

createView(listId, data) ​

views(listId) ​

addTask(listId, taskId) ​

removeTask(listId, taskId) ​

get(spaceId) ​

update(spaceId, data) ​

delete(spaceId) ​

createFolder(spaceId, data) ​

folders(spaceId, [options]) ​

createFolderlessList(spaceId, data) ​

folderlessLists(spaceId, [options]) ​

tags(spaceId) ​

addTag(spaceId, data) ​

editTag(spaceId, tagName, data) ​

removeTag(spaceId, tagName, data) ​

createView(spaceId, data) ​

views(spaceId) ​

customFields(spaceId) ​

get(taskId, [options]) ​

update(taskId, data, [options]) ​

delete(taskId, [options]) ​

addAttachment(taskId, attachment, [options]) ​

Classes

Functions

authorization ⇐ `Route`

checklist ⇐ `Route`

comment ⇐ `Route`

folder ⇐ `Route`

goal ⇐ `Route`

group ⇐ `Route`

key-result ⇐ `Route`

list ⇐ `Route`

space ⇐ `Route`

task ⇐ `Route`

team ⇐ `Route`

view ⇐ `Route`

webhook ⇐ `Route`

createToken(options)

user()

teams()

update(checklistId, data)

delete(checklistId)

addItem(checklistId, data)

editItem(checklistId, checklistItemId, data)

removeItem(checklistId, checklistItemId)

update(commentId, data)

delete(commentId)

replies(commentId)

addReply(commentId, data)

get(folderId)

update(folderId, data)

delete(folderId)

addGuest(folderId, guestId, data, [options])

removeGuest(folderId, guestId, [options])

createList(folderId, data)

lists(folderId, [options])

createView(folderId, data)

views(folderId)

customFields(folderId)

get(goalId)

update(goalId, data)

delete(goalId)

addKeyResult(goalId, data)

get([options])

update(groupId, data)

delete(groupId)

update(keyResultId, data)

delete(keyResultId)

get(listId)

update(listId, data)

delete(listId)

addComment(listId, data)

comments(listId, [options])

customFields(listId)

addGuest(listId, guestId, data, [options])

removeGuest(listId, guestId, options)

members(listId)

createTask(listId, data, [options])

tasks(listId, options)

createTaskFromTemplate(listId, templateId, data)

createView(listId, data)

views(listId)

addTask(listId, taskId)

removeTask(listId, taskId)

get(spaceId)

update(spaceId, data)

delete(spaceId)

createFolder(spaceId, data)

folders(spaceId, [options])

createFolderlessList(spaceId, data)

folderlessLists(spaceId, [options])

tags(spaceId)

addTag(spaceId, data)

editTag(spaceId, tagName, data)

removeTag(spaceId, tagName, data)

createView(spaceId, data)

views(spaceId)

customFields(spaceId)

get(taskId, [options])

update(taskId, data, [options])

delete(taskId, [options])

addAttachment(taskId, attachment, [options])