Overview Add ClickUp to any ModuleX agent or workflow. ClickUp project management integration via the v2 REST API. Pure HTTP. 23 actions across workspaces, spaces, folders, lists, tasks, comments, tags, and team members.
Categories : Project & Task Management · Project Management · Productivity · Communication & Collaboration · Auth : API Key · Actions : 23
Authentication API Key Authentication Authenticate using your ClickUp Personal API Token
Required Credentials Field Description Required Format ClickUp API Key Your ClickUp Personal API Token from Settings > Apps Yes pk_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Available Actions
get_teams — List all authorized teams (workspaces)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "teams" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Teams" , "type" : "array" }, "count" : { "default" : 0 , "title" : "Count" , "type" : "integer" } }, "required" : [ "success" ], "title" : "GetTeamsOutput" , "type" : "object" }
get_spaces — List spaces in a team
Parameters Include archived spaces (Default: false)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "spaces" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Spaces" , "type" : "array" }, "count" : { "default" : 0 , "title" : "Count" , "type" : "integer" }, "team_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Team Id" } }, "required" : [ "success" ], "title" : "GetSpacesOutput" , "type" : "object" }
get_space — Get a specific space
Parameters Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "result" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Result" } }, "required" : [ "success" ], "title" : "GetSpaceOutput" , "type" : "object" }
create_space — Create a new space in a team
Parameters Allow multiple assignees (Default: true)
Optional features (due_dates, time_tracking, …)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "result" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Result" } }, "required" : [ "success" ], "title" : "CreateSpaceOutput" , "type" : "object" }
get_folders — List folders in a space
Parameters Include archived folders (Default: false)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "folders" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Folders" , "type" : "array" }, "count" : { "default" : 0 , "title" : "Count" , "type" : "integer" }, "space_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Space Id" } }, "required" : [ "success" ], "title" : "GetFoldersOutput" , "type" : "object" }
get_folder — Get a specific folder
Parameters Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "result" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Result" } }, "required" : [ "success" ], "title" : "GetFolderOutput" , "type" : "object" }
create_folder — Create a folder in a space
Parameters Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "result" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Result" } }, "required" : [ "success" ], "title" : "CreateFolderOutput" , "type" : "object" }
delete_folder — Delete a folder
Parameters Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "deleted" : { "default" : false , "title" : "Deleted" , "type" : "boolean" }, "folder_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Folder Id" } }, "required" : [ "success" ], "title" : "DeleteFolderOutput" , "type" : "object" }
get_lists — List lists in a folder OR folderless lists in a space (exactly one of folder_id/space_id required)
Parameters Include archived (Default: false)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "lists" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Lists" , "type" : "array" }, "count" : { "default" : 0 , "title" : "Count" , "type" : "integer" }, "folder_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Folder Id" }, "space_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Space Id" } }, "required" : [ "success" ], "title" : "GetListsOutput" , "type" : "object" }
get_list — Get a specific list
Parameters Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "result" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Result" } }, "required" : [ "success" ], "title" : "GetListOutput" , "type" : "object" }
create_list — Create a list in a folder OR folderless list in a space
Parameters Priority (1=Urgent..4=Low)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "result" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Result" } }, "required" : [ "success" ], "title" : "CreateListOutput" , "type" : "object" }
get_tasks — List tasks in a list with filters + pagination
get_task — Get a specific task
Parameters If true, task_id is a custom task ID (e.g. ‘ABC-123’) (Default: false)
Required when custom_task_ids=true
Include subtasks in response (Default: false)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "result" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Result" } }, "required" : [ "success" ], "title" : "GetTaskOutput" , "type" : "object" }
create_task — Create a task in a list
Parameters Whether due_date includes time (Default: false)
Whether start_date includes time (Default: false)
Parent task ID (for subtasks)
Notify all assignees (Default: true)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "result" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Result" } }, "required" : [ "success" ], "title" : "CreateTaskOutput" , "type" : "object" }
update_task — Update fields on an existing task
Parameters If true, task_id is a custom task ID (e.g. ‘ABC-123’) (Default: false)
Required when custom_task_ids=true
Updated priority (1=Urgent..4=Low)
Updated due date (epoch ms)
Whether due_date includes time
Updated start date (epoch ms)
Whether start_date includes time
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "result" : { "anyOf" : [ { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Result" } }, "required" : [ "success" ], "title" : "UpdateTaskOutput" , "type" : "object" }
delete_task — Delete a task permanently
Parameters If true, task_id is a custom task ID (e.g. ‘ABC-123’) (Default: false)
Required when custom_task_ids=true
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "deleted" : { "default" : false , "title" : "Deleted" , "type" : "boolean" }, "task_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Task Id" } }, "required" : [ "success" ], "title" : "DeleteTaskOutput" , "type" : "object" }
get_task_comments — Get comments on a task
create_task_comment — Add a comment to a task
search_tasks — Search tasks across a team with filters. ``query`` is applied as a client-side substring filter on name + description (ClickUp has no full-text search API).
Parameters Include closed tasks (Default: false)
Page number (0-indexed) (Default: 0)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "tasks" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Tasks" , "type" : "array" }, "count" : { "default" : 0 , "title" : "Count" , "type" : "integer" }, "team_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Team Id" } }, "required" : [ "success" ], "title" : "SearchTasksOutput" , "type" : "object" }
get_space_tags — List all tags in a space
add_tag_to_task — Attach a tag to a task by name
Parameters If true, task_id is a custom task ID (e.g. ‘ABC-123’) (Default: false)
Required when custom_task_ids=true
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "added" : { "default" : false , "title" : "Added" , "type" : "boolean" }, "task_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Task Id" }, "tag_name" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Tag Name" } }, "required" : [ "success" ], "title" : "AddTagToTaskOutput" , "type" : "object" }
remove_tag_from_task — Detach a tag from a task by name
Parameters If true, task_id is a custom task ID (e.g. ‘ABC-123’) (Default: false)
Required when custom_task_ids=true
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "removed" : { "default" : false , "title" : "Removed" , "type" : "boolean" }, "task_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Task Id" }, "tag_name" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Tag Name" } }, "required" : [ "success" ], "title" : "RemoveTagFromTaskOutput" , "type" : "object" }
get_team_members — List members of a team. Implementation N+1: fetches all teams via GET /team and filters client-side by team_id.
Parameters Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "members" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Members" , "type" : "array" }, "count" : { "default" : 0 , "title" : "Count" , "type" : "integer" }, "team_id" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Team Id" } }, "required" : [ "success" ], "title" : "GetTeamMembersOutput" , "type" : "object" }
Links 
