ClickUp

ClickUp module for RobinPath.

Package: @robinpath/clickup | Category: Project Management | Type: Integration

Authentication

clickup.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the clickup module when you need to:

• listWorkspaces -- Use clickup.listWorkspaces to perform this operation
• listSpaces -- Use clickup.listSpaces to perform this operation
• getSpace -- Use clickup.getSpace to perform this operation
• createSpace -- Use clickup.createSpace to perform this operation
• listFolders -- Use clickup.listFolders to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure clickup credentials.	object
listWorkspaces	listWorkspaces	object
listSpaces	listSpaces	object
getSpace	getSpace	object
createSpace	createSpace	object
listFolders	listFolders	object
createFolder	createFolder	object
listLists	listLists	object
createList	createList	object
listTasks	listTasks	object
getTask	getTask	object
createTask	createTask	object
updateTask	updateTask	object
deleteTask	deleteTask	object
addComment	addComment	object
listComments	listComments	object
listMembers	listMembers	object
getTimeEntries	getTimeEntries	object
createTimeEntry	createTimeEntry	object
listTags	listTags	object
addTagToTask	addTagToTask	object
listGoals	listGoals	object
createGoal	createGoal	object

Functions

setCredentials

Configure clickup credentials.

Module: clickup | Returns: object -- API response.

clickup.setCredentials

Parameter	Type	Required	Description
apiToken	string	Yes	apiToken

---

listWorkspaces

listWorkspaces

Module: clickup | Returns: object -- API response.

clickup.listWorkspaces

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listSpaces

listSpaces

Module: clickup | Returns: object -- API response.

clickup.listSpaces

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getSpace

getSpace

Module: clickup | Returns: object -- API response.

clickup.getSpace

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createSpace

createSpace

Module: clickup | Returns: object -- API response.

clickup.createSpace

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listFolders

listFolders

Module: clickup | Returns: object -- API response.

clickup.listFolders

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createFolder

createFolder

Module: clickup | Returns: object -- API response.

clickup.createFolder

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listLists

listLists

Module: clickup | Returns: object -- API response.

clickup.listLists

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createList

createList

Module: clickup | Returns: object -- API response.

clickup.createList

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listTasks

listTasks

Module: clickup | Returns: object -- API response.

clickup.listTasks

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getTask

getTask

Module: clickup | Returns: object -- API response.

clickup.getTask

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createTask

createTask

Module: clickup | Returns: object -- API response.

clickup.createTask

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateTask

updateTask

Module: clickup | Returns: object -- API response.

clickup.updateTask

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteTask

deleteTask

Module: clickup | Returns: object -- API response.

clickup.deleteTask

Parameter	Type	Required	Description
input	string	No	Input parameter

---

addComment

addComment

Module: clickup | Returns: object -- API response.

clickup.addComment

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listComments

listComments

Module: clickup | Returns: object -- API response.

clickup.listComments

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listMembers

listMembers

Module: clickup | Returns: object -- API response.

clickup.listMembers

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getTimeEntries

getTimeEntries

Module: clickup | Returns: object -- API response.

clickup.getTimeEntries

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createTimeEntry

createTimeEntry

Module: clickup | Returns: object -- API response.

clickup.createTimeEntry

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listTags

listTags

Module: clickup | Returns: object -- API response.

clickup.listTags

Parameter	Type	Required	Description
input	string	No	Input parameter

---

addTagToTask

addTagToTask

Module: clickup | Returns: object -- API response.

clickup.addTagToTask

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listGoals

listGoals

Module: clickup | Returns: object -- API response.

clickup.listGoals

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createGoal

createGoal

Module: clickup | Returns: object -- API response.

clickup.createGoal

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Clickup API error (${res.status}): ${t}	Check the error message for details
clickup.setCredentials requires apiToken.	Check the error message for details
clickup.updateTask requires an ID.	Check the error message for details
clickup.deleteTask requires an ID.	Check the error message for details
Clickup: "..." not configured. Call clickup.setCredentials first.	Check the error message for details

@desc "List workspaces and validate result"
do
  set $result as clickup.listWorkspaces
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Workspaces

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  clickup.setCredentials $token
enddo

@desc "List workspaces and iterate results"
do
  set $result as clickup.listWorkspaces
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createSpace

Create a new resource and capture the result.

@desc "Setup authentication"
do
  clickup.setCredentials $token
enddo

@desc "Create space"
do
  set $result as clickup.createSpace
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  clickup.setCredentials $token
enddo

@desc "Create space and update task"
do
  set $created as clickup.createSpace
  # Update the created item
  clickup.updateTask
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  clickup.setCredentials $token
enddo

@desc "List workspaces and create space"
do
  set $existing as clickup.listWorkspaces
  if $existing == null
    clickup.createSpace
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step ClickUp workflow

Chain multiple clickup operations together.

@desc "Setup authentication"
do
  clickup.setCredentials $token
enddo

@desc "List workspaces, list spaces, and more"
do
  set $r_listWorkspaces as clickup.listWorkspaces
  set $r_listSpaces as clickup.listSpaces
  set $r_getSpace as clickup.getSpace
  print "All operations complete"
enddo

6. Safe listWorkspaces with validation

Check results before proceeding.

@desc "Setup authentication"
do
  clickup.setCredentials $token
enddo

@desc "List workspaces and validate result"
do
  set $result as clickup.listWorkspaces
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• asana -- Asana module for complementary functionality
• jira -- Jira module for complementary functionality
• linear -- Linear module for complementary functionality
• monday -- Monday.com module for complementary functionality
• todoist -- Todoist module for complementary functionality