Click Up¶

Node: clickUp · Full type: n8n-nodes-base.clickUp · Version: 1

Credentials¶

clickUpApi (alias: @click) / clickUpOAuth2Api (alias: @click)

CREDENTIAL @click = clickUpApi "My Click Up"

Operations¶

Resource: `checklist`¶

`create`¶

Parameter	Type	Default	Details
`task`	string	""	required
`name`	string	""	required

`delete`¶

Parameter	Type	Default	Details
`checklist`	string	""	required

`update`¶

Parameter	Type	Default	Details
`checklist`	string	""	required
`updateFields`	collection	{}	keys: `name`, `position`

Resource: `checklistItem`¶

`create`¶

Parameter	Type	Default	Details
`checklist`	string	""	required
`name`	string	""	required
`additionalFields`	collection	{}	keys: `assignee`

`delete`¶

Parameter	Type	Default	Details
`checklist`	string	""	required
`checklistItem`	string	""	required

`update`¶

Parameter	Type	Default	Details
`checklist`	string	""	required
`checklistItem`	string	""	required
`updateFields`	collection	{}	keys: `assignee`, `name`, `parent`, `resolved`

Resource: `comment`¶

`create`¶

Parameter	Type	Default	Details
`commentOn`	options	""	`list`, `task`, `view`
`id`	string	""	required
`commentText`	string	""
`additionalFields`	collection	{}	keys: `assignee`, `notifyAll`

`delete`¶

Parameter	Type	Default	Details
`comment`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`commentsOn`	options	""	`list`, `task`, `view`
`id`	string	""	required
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`comment`	string	""	required
`updateFields`	collection	{}	keys: `assignee`, `commentText`, `resolved`

Resource: `folder`¶

`create`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`name`	string	""	required

`delete`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folder`	options	""	required

`get`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folder`	options	""	required

`getAll`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`limit`	number	50
`filters`	collection	{}	keys: `archived`

`update`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folder`	options	""	required
`updateFields`	collection	{}	keys: `name`

Resource: `goal`¶

`create`¶

Parameter	Type	Default	Details
`team`	options	""	required
`name`	string	""	required
`additionalFields`	collection	{}	keys: `color`, `description`, `dueDate`, `multipleOwners`, `owners`

`delete`¶

Parameter	Type	Default	Details
`goal`	string	""	required

`get`¶

Parameter	Type	Default	Details
`goal`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`team`	options	""	required
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`goal`	string	""	required
`updateFields`	collection	{}	keys: `addOwners`, `color`, `description`, `dueDate`, `name`, `removeOwners`

Resource: `goalKeyResult`¶

`create`¶

Parameter	Type	Default	Details
`goal`	string	""	required
`name`	string	""	required
`type`	options	""	required; `automatic`, `boolean`, `currency`, `number`, `percentage`
`additionalFields`	collection	{}	keys: `listIds`, `owners`, `stepsStart`, `stepsEnd`, `taskIds`, `unit`

`delete`¶

Parameter	Type	Default	Details
`keyResult`	string	""	required

`update`¶

Parameter	Type	Default	Details
`keyResult`	string	""	required
`updateFields`	collection	{}	keys: `name`, `note`, `stepsCurrent`, `stepsEnd`, `stepsStart`, `unit`

Resource: `list`¶

`create`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folderless`	boolean	false	required
`folder`	options	""	required
`name`	string	""	required
`additionalFields`	collection	{}	keys: `assignee`, `content`, `dueDate`, `dueDateTime`, `priority`, `status`

`customFields`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folderless`	boolean	false	required
`folder`	options	""	required
`list`	options	""	required
`list`	options	""	required

`delete`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folderless`	boolean	false	required
`folder`	options	""	required
`list`	string	""	required

`get`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folderless`	boolean	false	required
`folder`	options	""	required
`list`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folderless`	boolean	false	required
`folder`	options	""	required
`limit`	number	50
`filters`	collection	{}	keys: `archived`

`member`¶

Parameter	Type	Default	Details
`id`	string	""	required
`returnAll`	boolean	true
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folderless`	boolean	false	required
`folder`	options	""	required
`list`	string	""	required
`updateFields`	collection	{}	keys: `assignee`, `content`, `dueDate`, `dueDateTime`, `name`, `priority`, ...

Resource: `spaceTag`¶

`create`¶

Parameter	Type	Default	Details
`space`	string	""	required
`name`	string	""	required
`foregroundColor`	color	"#000000"	required
`backgroundColor`	color	"#000000"	required

`delete`¶

Parameter	Type	Default	Details
`space`	string	""	required
`name`	options	""	required

`getAll`¶

Parameter	Type	Default	Details
`space`	string	""	required
`returnAll`	boolean	true
`limit`	number	50

`update`¶

Parameter	Type	Default	Details
`space`	string	""	required
`name`	options	""	required
`newName`	string	""	required
`foregroundColor`	color	"#000000"	required
`backgroundColor`	color	"#000000"	required

Resource: `task`¶

`create`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folderless`	boolean	false	required
`folder`	options	""	required
`list`	options	""	required
`list`	options	""	required
`name`	string	""	required
`additionalFields`	collection	{}	keys: `assignees`, `customFieldsJson`, `content`, `dueDate`, `dueDateTime`, `markdownContent`, ...

`delete`¶

Parameter	Type	Default	Details
`id`	string	""	required

`get`¶

Parameter	Type	Default	Details
`id`	string	""	required
`includeSubtasks`	boolean	false
`includeMarkdownDescription`	boolean	false

`getAll`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folderless`	boolean	false	required
`folder`	options	""	required
`list`	options	""	required
`list`	options	""	required
`returnAll`	boolean	true
`limit`	number	50
`filters`	collection	{}	keys: `archived`, `assignees`, `customFieldsUi`, `dateCreatedGt`, `dateCreatedLt`, `dateUpdatedGt`, ...

`member`¶

Parameter	Type	Default	Details
`id`	string	""	required
`returnAll`	boolean	true
`limit`	number	50

`setCustomField`¶

Parameter	Type	Default	Details
`task`	string	""	required
`field`	string	""	required
`jsonParse`	boolean	false
`value`	string	""	required

`update`¶

Parameter	Type	Default	Details
`id`	string	""	required
`updateFields`	collection	{}	keys: `addAssignees`, `content`, `dueDate`, `dueDateTime`, `markdownContent`, `name`, ...

Resource: `taskDependency`¶

`create`¶

Parameter	Type	Default	Details
`task`	string	""	required
`dependsOnTask`	string	""	required
`task`	string	""	required
`dependsOnTask`	string	""	required

`delete`¶

Parameter	Type	Default	Details
`task`	string	""	required
`dependsOnTask`	string	""	required
`task`	string	""	required
`dependsOnTask`	string	""	required

Resource: `taskList`¶

`add`¶

Parameter	Type	Default	Details
`taskId`	string	""	required
`listId`	string	""	required

`remove`¶

Parameter	Type	Default	Details
`taskId`	string	""	required
`listId`	string	""	required

Resource: `taskTag`¶

`add`¶

Parameter	Type	Default	Details
`taskId`	string	""	required
`tagName`	string	""	required
`additionalFields`	collection	{}	keys: `custom_task_ids`, `team_id`

`remove`¶

Parameter	Type	Default	Details
`taskId`	string	""	required
`tagName`	string	""	required
`additionalFields`	collection	{}	keys: `custom_task_ids`, `team_id`

Resource: `timeEntry`¶

`create`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folderless`	boolean	false	required
`folder`	options	""	required
`list`	options	""	required
`list`	options	""	required
`start`	dateTime	""	required
`duration`	number	0	required
`task`	options	""
`additionalFields`	collection	{}	keys: `assignee`, `billable`, `description`, `tags`

`delete`¶

Parameter	Type	Default	Details
`team`	options	""	required
`timeEntry`	string	""	required

`get`¶

Parameter	Type	Default	Details
`team`	options	""	required
`running`	boolean	false
`timeEntry`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`team`	options	""	required
`returnAll`	boolean	false
`limit`	number	5
`filters`	collection	{}	keys: `end_date`, `start_date`

`start`¶

Parameter	Type	Default	Details
`team`	options	""	required
`task`	string	""	required
`additionalFields`	collection	{}	keys: `billable`, `description`

`stop`¶

Parameter	Type	Default	Details
`team`	options	""	required

`update`¶

Parameter	Type	Default	Details
`team`	options	""	required
`space`	options	""	required
`folderless`	boolean	false	required
`folder`	options	""	required
`list`	options	""	required
`list`	options	""	required
`archived`	boolean	false	required
`timeEntry`	string	""	required
`updateFields`	collection	{}	keys: `assignee`, `billable`, `description`, `duration`, `start`, `tags`, ...

Resource: `timeEntryTag`¶

`add`¶

Parameter	Type	Default	Details
`team`	options	""	required
`timeEntryIds`	string	""	required
`tagsUi`	fixedCollection	{}	groups: `tagsValues`

`getAll`¶

Parameter	Type	Default	Details
`team`	options	""	required
`returnAll`	boolean	false
`limit`	number	5

`remove`¶

Parameter	Type	Default	Details
`team`	options	""	required
`timeEntryIds`	string	""	required
`tagNames`	multiOptions	[]	required

Common Parameters¶

Parameter	Type	Default	Details
`authentication`	options	"accessToken"	`accessToken`, `oAuth2`

Parameter Details¶

updateFields children:

Parameter	Type	Default	Details
`name`	string	""
`position`	number	0

additionalFields children:

Parameter	Type	Default	Details
`assignee`	string	""

filters children:

Parameter	Type	Default	Details
`archived`	boolean	false

tagsUi children:

tagsValues group:

Parameter	Type	Default
`name`	string	""
`tag_bg`	color	"#ff0000"
`tag_fg`	color	"#ff0000"

Example¶

NODE "clickUp" @click AS "Click Up" {
  resource: "checklist",
  operation: "get",
  task: {{ $json.task }},
  name: {{ $json.name }},
  checklist: {{ $json.checklist }}
}

Click Up¶

Credentials¶

Operations¶

Resource: checklist¶

create¶

delete¶

update¶

Resource: checklistItem¶

create¶

delete¶

update¶

Resource: comment¶

create¶

delete¶

getAll¶

update¶

Resource: folder¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: goal¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: goalKeyResult¶

create¶

delete¶

update¶

Resource: list¶

create¶

customFields¶

delete¶

get¶

getAll¶

member¶

update¶

Resource: spaceTag¶

create¶

delete¶

getAll¶

update¶

Resource: task¶

create¶

delete¶

get¶

getAll¶

member¶

setCustomField¶

update¶

Resource: taskDependency¶

create¶

delete¶

Resource: taskList¶

add¶

remove¶

Resource: taskTag¶

add¶

remove¶

Resource: timeEntry¶

create¶

delete¶

get¶

getAll¶

start¶

stop¶

update¶

Resource: timeEntryTag¶

add¶

getAll¶

remove¶

Common Parameters¶

Parameter Details¶

Example¶

Resource: `checklist`¶

`create`¶

`delete`¶

`update`¶

Resource: `checklistItem`¶

`create`¶

`delete`¶

`update`¶

Resource: `comment`¶

`create`¶

`delete`¶

`getAll`¶

`update`¶

Resource: `folder`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `goal`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `goalKeyResult`¶

`create`¶

`delete`¶

`update`¶

Resource: `list`¶

`create`¶

`customFields`¶

`delete`¶

`get`¶

`getAll`¶

`member`¶

`update`¶

Resource: `spaceTag`¶

`create`¶

`delete`¶

`getAll`¶

`update`¶

Resource: `task`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`member`¶

`setCustomField`¶

`update`¶

Resource: `taskDependency`¶

`create`¶

`delete`¶

Resource: `taskList`¶

`add`¶

`remove`¶

Resource: `taskTag`¶

`add`¶

`remove`¶

Resource: `timeEntry`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`start`¶

`stop`¶

`update`¶

Resource: `timeEntryTag`¶

`add`¶

`getAll`¶

`remove`¶