From 9d6eb106176e9fb06d070aae1cc49a80acd5e289 Mon Sep 17 00:00:00 2001 From: jottakka Date: Tue, 28 Oct 2025 16:07:27 -0300 Subject: [PATCH] [MOAR][Clickup] Clickup Starter Toolkit (#656) Co-authored-by: Francisco Liberal --- docker/toolkits.txt | 2 + toolkits/clickup_api/.pre-commit-config.yaml | 18 + toolkits/clickup_api/Makefile | 54 + toolkits/clickup_api/README.md | 26 + toolkits/clickup_api/clickup_api/__init__.py | 0 .../clickup_api/clickup_api/moar/Clickup.json | 24465 ++++++++++++ .../clickup_api/clickup_api/moar/openapi.json | 32740 ++++++++++++++++ .../clickup_api/clickup_api/tools/__init__.py | 7749 ++++ .../clickup_api/tools/request_body_schemas.py | 34 + .../wrapper_tools/AddChatViewComment.json | 171 + .../AddChecklistItemClickup.json | 171 + .../wrapper_tools/AddChecklistToTask.json | 204 + .../wrapper_tools/AddCommentToList.json | 204 + .../AddFolderlessListToSpace.json | 369 + .../wrapper_tools/AddGuestToFolder.json | 204 + .../wrapper_tools/AddGuestToList.json | 204 + .../wrapper_tools/AddSpaceTaskTag.json | 204 + .../wrapper_tools/AddSpaceView.json | 284 + .../wrapper_tools/AddTagToTask.json | 237 + .../wrapper_tools/AddTagToTimeEntry.json | 172 + .../wrapper_tools/AddTargetToGoal.json | 369 + .../wrapper_tools/AddTaskComment.json | 303 + .../wrapper_tools/AddTaskToClickupList.json | 138 + .../wrapper_tools/AddViewToClickupList.json | 284 + .../wrapper_tools/AddViewToFolder.json | 284 + .../ClickupLegacyTimeTracking.json | 270 + .../ConfigureWorkspaceGuest.json | 336 + .../wrapper_tools/CreateClickupList.json | 369 + .../CreateFolderFromTemplate.json | 695 + .../wrapper_tools/CreateFolderInSpace.json | 138 + .../CreateListFromFolderTemplate.json | 205 + .../wrapper_tools/CreateListFromTemplate.json | 695 + .../wrapper_tools/CreateNewClickupTask.json | 476 + .../wrapper_tools/CreateSpaceInWorkspace.json | 188 + .../wrapper_tools/CreateTaskFromTemplate.json | 171 + .../wrapper_tools/CreateTeamView.json | 284 + .../wrapper_tools/CreateThreadedComment.json | 138 + .../wrapper_tools/CreateTimeEntry.json | 400 + .../wrapper_tools/CreateUserGroup.json | 204 + .../wrapper_tools/CreateWorkspaceGoal.json | 303 + .../wrapper_tools/DeleteChecklist.json | 105 + .../clickup_api/wrapper_tools/DeleteGoal.json | 138 + .../wrapper_tools/DeleteGoalTarget.json | 105 + .../wrapper_tools/DeleteSpaceTag.json | 189 + .../clickup_api/wrapper_tools/DeleteTask.json | 204 + .../DeleteTaskChecklistItem.json | 138 + .../wrapper_tools/DeleteTaskComment.json | 105 + .../wrapper_tools/DeleteTimeEntry.json | 171 + .../wrapper_tools/DeleteUserGroup.json | 105 + .../clickup_api/wrapper_tools/DeleteView.json | 105 + .../wrapper_tools/DeleteWebhook.json | 105 + .../wrapper_tools/DeleteWorkspaceFolder.json | 105 + .../wrapper_tools/DeleteWorkspaceList.json | 138 + .../wrapper_tools/DeleteWorkspaceSpace.json | 105 + .../wrapper_tools/EditChecklist.json | 171 + .../wrapper_tools/EditLegacyTimeEntry.json | 303 + .../wrapper_tools/GetAuthorizedTeams.json | 70 + .../wrapper_tools/GetClickupAccessToken.json | 155 + .../wrapper_tools/GetClickupUserDetails.json | 70 + .../GetCurrentRunningTimeEntry.json | 171 + .../wrapper_tools/GetFilteredTeamTasks.json | 864 + .../wrapper_tools/GetFolderCustomFields.json | 138 + .../wrapper_tools/GetFolderViews.json | 105 + .../wrapper_tools/GetFolderlessLists.json | 138 + .../wrapper_tools/GetGoalDetails.json | 105 + .../wrapper_tools/GetGuestInformation.json | 138 + .../wrapper_tools/GetListComments.json | 171 + .../wrapper_tools/GetListMembers.json | 105 + .../wrapper_tools/GetListTasks.json | 864 + .../wrapper_tools/GetListViews.json | 105 + .../wrapper_tools/GetSpaceCustomFields.json | 138 + .../wrapper_tools/GetSpaceFolders.json | 138 + .../wrapper_tools/GetSpaceTags.json | 138 + .../wrapper_tools/GetSpaceViews.json | 105 + .../wrapper_tools/GetTaskComments.json | 237 + .../wrapper_tools/GetTaskMembers.json | 105 + .../wrapper_tools/GetTaskTimeInStatus.json | 204 + .../wrapper_tools/GetTeamViews.json | 105 + .../GetTimeEntriesInDateRange.json | 600 + .../wrapper_tools/GetTimeEntryTags.json | 138 + .../wrapper_tools/GetTrackedTimeForTask.json | 204 + .../GetUserGroupsInWorkspace.json | 138 + .../wrapper_tools/GetVisibleTasksInView.json | 138 + .../GetWorkspaceCustomRoles.json | 138 + .../GetWorkspaceCustomTaskTypes.json | 105 + .../wrapper_tools/GetWorkspacePlan.json | 105 + .../GetWorkspaceSeatDetails.json | 105 + .../wrapper_tools/GetWorkspaceSpaces.json | 105 + .../wrapper_tools/GetWorkspaceUserInfo.json | 171 + .../wrapper_tools/GetWorkspaceWebhooks.json | 105 + .../wrapper_tools/InviteGuestToWorkspace.json | 336 + .../wrapper_tools/InviteUserToWorkspace.json | 204 + .../wrapper_tools/LinkTasksClickup.json | 204 + .../wrapper_tools/MergeTasksInClickup.json | 138 + .../wrapper_tools/RemoveCustomFieldValue.json | 204 + .../wrapper_tools/RemoveGuestFromFolder.json | 171 + .../wrapper_tools/RemoveGuestFromList.json | 171 + .../wrapper_tools/RemoveGuestFromTask.json | 237 + .../RemoveGuestFromWorkspace.json | 138 + .../wrapper_tools/RemoveTagFromTask.json | 237 + .../RemoveTagsFromTimeEntries.json | 172 + .../wrapper_tools/RemoveTaskDependency.json | 237 + .../RemoveTaskFromAdditionalList.json | 138 + .../wrapper_tools/RemoveTaskLink.json | 204 + .../wrapper_tools/RemoveTimeEntry.json | 237 + .../RemoveUserFromWorkspace.json | 138 + .../wrapper_tools/RenameClickupFolder.json | 138 + .../wrapper_tools/RenameTimeEntryLabel.json | 237 + .../RetrieveAvailableSpaces.json | 138 + .../wrapper_tools/SetTaskDependency.json | 237 + .../wrapper_tools/SetupClickupWebhook.json | 303 + .../wrapper_tools/ShareTaskWithGuest.json | 270 + .../wrapper_tools/StartTimerClickup.json | 288 + .../wrapper_tools/StopTimerEntry.json | 138 + .../wrapper_tools/TaskStatusDuration.json | 204 + .../wrapper_tools/UpdateChecklistItem.json | 270 + .../wrapper_tools/UpdateClickupList.json | 402 + .../wrapper_tools/UpdateClickupSpace.json | 592 + .../UpdateClickupWebhookEvents.json | 204 + .../wrapper_tools/UpdateGoalDetails.json | 303 + .../wrapper_tools/UpdateKeyResultTarget.json | 171 + .../wrapper_tools/UpdateTaskComment.json | 237 + .../wrapper_tools/UpdateTaskCustomField.json | 237 + .../wrapper_tools/UpdateTaskInClickup.json | 580 + .../wrapper_tools/UpdateTaskTag.json | 237 + .../wrapper_tools/UpdateTimeEntry.json | 367 + .../wrapper_tools/UpdateUserGroup.json | 237 + .../UpdateUserWorkspaceDetails.json | 237 + .../wrapper_tools/UpdateViewSettings.json | 764 + .../wrapper_tools/ViewChatComments.json | 171 + .../wrapper_tools/ViewFolderLists.json | 105 + .../wrapper_tools/ViewListCustomFields.json | 138 + .../wrapper_tools/ViewListDetails.json | 105 + .../wrapper_tools/ViewListsInFolder.json | 138 + .../wrapper_tools/ViewSharedHierarchy.json | 105 + .../wrapper_tools/ViewTaskDetails.json | 270 + .../wrapper_tools/ViewTaskOrPageInfo.json | 105 + .../wrapper_tools/ViewTaskTemplates.json | 171 + .../wrapper_tools/ViewThreadedComments.json | 105 + .../wrapper_tools/ViewTimeEntry.json | 303 + .../wrapper_tools/ViewTimeEntryChanges.json | 171 + .../ViewWorkspaceCustomFields.json | 138 + .../wrapper_tools/ViewWorkspaceGoals.json | 138 + toolkits/clickup_api/pyproject.toml | 60 + toolkits/clickup_api/tests/__init__.py | 0 toolkits/pylon_api/pyproject.toml | 2 +- 146 files changed, 94656 insertions(+), 1 deletion(-) create mode 100644 toolkits/clickup_api/.pre-commit-config.yaml create mode 100644 toolkits/clickup_api/Makefile create mode 100644 toolkits/clickup_api/README.md create mode 100644 toolkits/clickup_api/clickup_api/__init__.py create mode 100644 toolkits/clickup_api/clickup_api/moar/Clickup.json create mode 100644 toolkits/clickup_api/clickup_api/moar/openapi.json create mode 100644 toolkits/clickup_api/clickup_api/tools/__init__.py create mode 100644 toolkits/clickup_api/clickup_api/tools/request_body_schemas.py create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddChatViewComment.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddChecklistItemClickup.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddChecklistToTask.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddCommentToList.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddFolderlessListToSpace.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddGuestToFolder.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddGuestToList.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddSpaceTaskTag.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddSpaceView.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddTagToTask.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddTagToTimeEntry.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddTargetToGoal.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddTaskComment.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddTaskToClickupList.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddViewToClickupList.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/AddViewToFolder.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ClickupLegacyTimeTracking.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ConfigureWorkspaceGuest.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateClickupList.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateFolderFromTemplate.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateFolderInSpace.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateListFromFolderTemplate.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateListFromTemplate.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateNewClickupTask.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateSpaceInWorkspace.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateTaskFromTemplate.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateTeamView.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateThreadedComment.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateTimeEntry.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateUserGroup.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/CreateWorkspaceGoal.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteChecklist.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteGoal.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteGoalTarget.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteSpaceTag.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTask.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTaskChecklistItem.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTaskComment.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTimeEntry.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteUserGroup.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteView.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWebhook.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceFolder.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceList.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceSpace.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/EditChecklist.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/EditLegacyTimeEntry.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetAuthorizedTeams.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetClickupAccessToken.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetClickupUserDetails.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetCurrentRunningTimeEntry.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetFilteredTeamTasks.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderCustomFields.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderViews.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderlessLists.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetGoalDetails.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetGuestInformation.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetListComments.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetListMembers.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetListTasks.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetListViews.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceCustomFields.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceFolders.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceTags.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceViews.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskComments.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskMembers.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskTimeInStatus.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetTeamViews.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetTimeEntriesInDateRange.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetTimeEntryTags.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetTrackedTimeForTask.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetUserGroupsInWorkspace.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetVisibleTasksInView.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceCustomRoles.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceCustomTaskTypes.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspacePlan.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceSeatDetails.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceSpaces.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceUserInfo.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceWebhooks.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/InviteGuestToWorkspace.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/InviteUserToWorkspace.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/LinkTasksClickup.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/MergeTasksInClickup.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveCustomFieldValue.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromFolder.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromList.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromTask.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromWorkspace.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTagFromTask.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTagsFromTimeEntries.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskDependency.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskFromAdditionalList.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskLink.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTimeEntry.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RemoveUserFromWorkspace.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RenameClickupFolder.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RenameTimeEntryLabel.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/RetrieveAvailableSpaces.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/SetTaskDependency.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/SetupClickupWebhook.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ShareTaskWithGuest.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/StartTimerClickup.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/StopTimerEntry.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/TaskStatusDuration.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateChecklistItem.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupList.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupSpace.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupWebhookEvents.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateGoalDetails.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateKeyResultTarget.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskComment.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskCustomField.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskInClickup.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskTag.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTimeEntry.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateUserGroup.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateUserWorkspaceDetails.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/UpdateViewSettings.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewChatComments.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewFolderLists.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewListCustomFields.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewListDetails.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewListsInFolder.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewSharedHierarchy.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskDetails.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskOrPageInfo.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskTemplates.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewThreadedComments.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewTimeEntry.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewTimeEntryChanges.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewWorkspaceCustomFields.json create mode 100644 toolkits/clickup_api/clickup_api/wrapper_tools/ViewWorkspaceGoals.json create mode 100644 toolkits/clickup_api/pyproject.toml create mode 100644 toolkits/clickup_api/tests/__init__.py diff --git a/docker/toolkits.txt b/docker/toolkits.txt index f2797a04..8eb7d9d4 100644 --- a/docker/toolkits.txt +++ b/docker/toolkits.txt @@ -3,6 +3,7 @@ arcade-arcade-engine-api arcade-box-api arcade-brightdata arcade-calendly-api +arcade-clickup-api arcade-cursor-agents-api arcade-datadog-api arcade-figma-api @@ -10,6 +11,7 @@ arcade-freshservice-api arcade-linkedin arcade-math arcade-miro-api +arcade-pylon-api arcade-posthog-api arcade-slack-api arcade-stripe-api diff --git a/toolkits/clickup_api/.pre-commit-config.yaml b/toolkits/clickup_api/.pre-commit-config.yaml new file mode 100644 index 00000000..36fad116 --- /dev/null +++ b/toolkits/clickup_api/.pre-commit-config.yaml @@ -0,0 +1,18 @@ +files: ^.*/clickup_api/.* +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: "v4.4.0" + hooks: + - id: check-case-conflict + - id: check-merge-conflict + - id: check-toml + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.6.7 + hooks: + - id: ruff + args: [--fix] + - id: ruff-format diff --git a/toolkits/clickup_api/Makefile b/toolkits/clickup_api/Makefile new file mode 100644 index 00000000..86da492a --- /dev/null +++ b/toolkits/clickup_api/Makefile @@ -0,0 +1,54 @@ +.PHONY: help + +help: + @echo "🛠️ github Commands:\n" + @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' + +.PHONY: install +install: ## Install the uv environment and install all packages with dependencies + @echo "🚀 Creating virtual environment and installing all packages using uv" + @uv sync --active --all-extras --no-sources + @if [ -f .pre-commit-config.yaml ]; then uv run --no-sources pre-commit install; fi + @echo "✅ All packages and dependencies installed via uv" + +.PHONY: install-local +install-local: ## Install the uv environment and install all packages with dependencies with local Arcade sources + @echo "🚀 Creating virtual environment and installing all packages using uv" + @uv sync --active --all-extras + @if [ -f .pre-commit-config.yaml ]; then uv run pre-commit install; fi + @echo "✅ All packages and dependencies installed via uv" +.PHONY: build +build: clean-build ## Build wheel file using poetry + @echo "🚀 Creating wheel file" + uv build + +.PHONY: clean-build +clean-build: ## clean build artifacts + @echo "🗑️ Cleaning dist directory" + rm -rf dist + +.PHONY: test +test: ## Test the code with pytest + @echo "🚀 Testing code: Running pytest" + @uv run --no-sources pytest -W ignore -v --cov --cov-config=pyproject.toml --cov-report=xml + +.PHONY: coverage +coverage: ## Generate coverage report + @echo "coverage report" + @uv run --no-sources coverage report + @echo "Generating coverage report" + @uv run --no-sources coverage html + +.PHONY: bump-version +bump-version: ## Bump the version in the pyproject.toml file by a patch version + @echo "🚀 Bumping version in pyproject.toml" + uv version --no-sources --bump patch + +.PHONY: check +check: ## Run code quality tools. + @if [ -f .pre-commit-config.yaml ]; then\ + echo "🚀 Linting code: Running pre-commit";\ + uv run --no-sources pre-commit run -a;\ + fi + @echo "🚀 Static type checking: Running mypy" + @uv run --no-sources mypy --config-file=pyproject.toml diff --git a/toolkits/clickup_api/README.md b/toolkits/clickup_api/README.md new file mode 100644 index 00000000..bfb20394 --- /dev/null +++ b/toolkits/clickup_api/README.md @@ -0,0 +1,26 @@ +
+ +
+ +
+ Python version + License + PyPI version +
+ + +
+
+ +# Arcade clickup_api Toolkit +Tools that enable LLMs to interact directly with the clickup API. +## Features + +- The clickup_api toolkit does not have any features yet. + +## Development + +Read the docs on how to create a toolkit [here](https://docs.arcade.dev/home/build-tools/create-a-toolkit) diff --git a/toolkits/clickup_api/clickup_api/__init__.py b/toolkits/clickup_api/clickup_api/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/toolkits/clickup_api/clickup_api/moar/Clickup.json b/toolkits/clickup_api/clickup_api/moar/Clickup.json new file mode 100644 index 00000000..6e2f78e1 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/moar/Clickup.json @@ -0,0 +1,24465 @@ +{ + "name": "Clickup", + "spec_source": "openapi_spec", + "token_for_http_testing": "", + "package_name": "clickup_api", + "package_dir_path": "/Users/franciscojuniodelimaliberal/git/Team/arcade-mcp/toolkits/clickup_api/clickup_api", + "project_dir_path": "/Users/franciscojuniodelimaliberal/git/Team/arcade-mcp/toolkits/clickup_api", + "arcade_new_cmd_executed": true, + "api_endpoint_selection_customized": false, + "api_endpoint_for_http_testing": "", + "authorization_type": "oauth", + "auth_provider_id": "arcade-clickup", + "where_to_provide_token": "header", + "token_key_name": "Authorization", + "token_value": "Bearer {authorization}", + "secrets": [], + "global_base_url": "https://api.clickup.com/api", + "global_headers": {}, + "edit_operations": [], + "uuid": "f25282de-7ce1-487c-886a-229332172a7a", + "api_endpoints": [ + { + "name": "CreateTaskAttachment", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": false, + "should_skip": true, + "skip_reason": "Only file-related content types available: multipart/form-data", + "wrapper_tool": null, + "method": "POST", + "path": "/v2/task/{task_id}/attachment", + "tags": [ + "Attachments" + ], + "summary": "Create Task Attachment", + "description": "Upload a file to a task as an attachment. Files stored in the cloud cannot be used in this API request.\\\n \\\n***Note:** This request uses multipart/form-data as the content type.*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by its custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetAccessToken", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_clickup_access_token", + "description": { + "tagline": "Obtain an OAuth access token for ClickUp API authentication.", + "detailed": "Use this tool to obtain an OAuth access token for authenticating applications with the ClickUp API. This tool is not for personal API tokens and does not support the 'Try It' feature in browser-based API documentation." + }, + "return_annotation": "Access token for authenticating with ClickUp API.", + "arguments": [ + { + "name": "oauth_credentials", + "alternative_names": [ + "authentication_details", + "oauth_parameters" + ], + "description": "JSON object containing 'client_id', 'client_secret', and 'code' for OAuth access.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/oauth/token", + "tags": [ + "Authorization" + ], + "summary": "Get Access Token", + "description": "These are the routes for authing the API and going through the [OAuth flow](doc:authentication).\\\n \\\nApplications utilizing a personal API token don't use this endpoint.\\\n \\\n***Note:** OAuth tokens are not supported when using the [**Try It** feature](doc:trytheapi) of our Reference docs. You can't try this endpoint from your web browser.*\n", + "requires_security": false, + "oauth_scopes": [], + "security_schemes": [], + "parameters": { + "query": [], + "path": [], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "client_id": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "OAuth app client id" + }, + "client_secret": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "OAuth app client secret" + }, + "code": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Code given in redirect url" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "GetAccessTokenrequest", + "properties": { + "client_id": { + "type": "string", + "description": "OAuth app client id" + }, + "client_secret": { + "type": "string", + "description": "OAuth app client secret" + }, + "code": { + "type": "string", + "description": "Code given in redirect url" + } + }, + "required": [ + "client_id", + "client_secret", + "code" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"GetAccessTokenrequest\",\n \"required\": [\n \"client_id\",\n \"client_secret\",\n \"code\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"client_id\": {\n \"type\": \"string\",\n \"description\": \"OAuth app client id\"\n },\n \"client_secret\": {\n \"type\": \"string\",\n \"description\": \"OAuth app client secret\"\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \"Code given in redirect url\"\n }\n },\n \"examples\": [\n {\n \"client_id\": \"your_client_id\",\n \"client_secret\": \"your_client_secret\",\n \"code\": \"authorization_code\"\n }\n ]\n },\n \"example\": {\n \"client_id\": \"your_client_id\",\n \"client_secret\": \"your_client_secret\",\n \"code\": \"authorization_code\"\n }\n },\n \"application/x-www-form-urlencoded\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1oauth~1token/post/requestBody/content/application~1json/schema\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1oauth~1token/post/requestBody/content/application~1json/schema\"\n },\n \"example\": {\n \"client_id\": \"your_client_id\",\n \"client_secret\": \"your_client_secret\",\n \"code\": \"authorization_code\"\n }\n }\n }\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "GetAuthorizedUser", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_clickup_user_details", + "description": { + "tagline": "Get details of the authenticated ClickUp user's account.", + "detailed": "" + }, + "return_annotation": "Details of the authenticated ClickUp user account.", + "arguments": [] + }, + "method": "GET", + "path": "/v2/user", + "tags": [ + "Authorization" + ], + "summary": "Get Authorized User", + "description": "View the details of the authenticated user's ClickUp account.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetAuthorizedTeams", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_authorized_teams", + "description": { + "tagline": "Retrieve the workspaces for the authenticated user.", + "detailed": "Use this tool to get a list of workspaces (teams) available to the user who is currently authenticated. It provides an overview of the user's accessible workspaces in ClickUp." + }, + "return_annotation": "List of workspaces available to the user.", + "arguments": [] + }, + "method": "GET", + "path": "/v2/team", + "tags": [ + "Workspaces" + ], + "summary": "Get Authorized Workspaces", + "description": "View the Workspaces available to the authenticated user.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateChecklist", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_checklist_to_task", + "description": { + "tagline": "Add a new checklist to a task in ClickUp.", + "detailed": "Use this tool to add a checklist to a specific task in ClickUp by providing the task ID." + }, + "return_annotation": "Confirms the addition of a checklist to a task.", + "arguments": [ + { + "name": "task_identifier", + "alternative_names": [ + "task_id_reference", + "unique_task_identifier" + ], + "description": "A unique identifier for the task to which the checklist will be added. It can be a custom or default task ID.", + "endpoint_argument_name": "task_id" + }, + { + "name": "checklist_name", + "alternative_names": [ + "checklist_title", + "checklist_label" + ], + "description": "The name or title of the checklist to be added to the task. It should be a descriptive string identifying the purpose or contents of the checklist.", + "endpoint_argument_name": "name" + }, + { + "name": "workspace_id_for_custom_task", + "alternative_names": [ + "team_identifier_for_custom_task", + "workspace_id" + ], + "description": "Provide the Workspace ID when 'custom_task_ids' is set to true. It's necessary to reference tasks by custom IDs.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_id_reference", + "use_custom_ids" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "POST", + "path": "/v2/task/{task_id}/checklist", + "tags": [ + "Task Checklists" + ], + "summary": "Create Checklist", + "description": "Add a new checklist to a task.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateChecklistrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Checklist\"\n }\n ]\n },\n \"example\": {\n \"name\": \"Checklist\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "EditChecklist", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "edit_checklist", + "description": { + "tagline": "Rename or reorder a task checklist in ClickUp.", + "detailed": "Use this tool to rename a checklist or change its order within a task in ClickUp. It is suitable when you need to update the checklist name or adjust its position in relation to other checklists in a specific task." + }, + "return_annotation": "Confirmation of checklist update or reordering.", + "arguments": [ + { + "name": "checklist_id", + "alternative_names": [ + "checklist_uuid", + "checklist_identifier" + ], + "description": "The unique identifier (UUID) of the checklist to be edited or reordered.", + "endpoint_argument_name": "checklist_id" + }, + { + "name": "checklist_name", + "alternative_names": [ + "new_checklist_name", + "updated_checklist_name" + ], + "description": "The new name for the checklist. Leave empty if you do not wish to rename.", + "endpoint_argument_name": "name" + }, + { + "name": "checklist_position", + "alternative_names": [ + "task_checklist_position", + "checklist_order_position" + ], + "description": "Specify the order in which the checklist should appear on a task. Use 0 to place it at the top.", + "endpoint_argument_name": "position" + } + ] + }, + "method": "PUT", + "path": "/v2/checklist/{checklist_id}", + "tags": [ + "Task Checklists" + ], + "summary": "Edit Checklist", + "description": "Rename a task checklist, or reorder a checklist so it appears above or below other checklists on a task. ", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "checklist_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "position", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Position refers to the order of appearance of checklists on a task.\\\n \\\nTo set a checklist to appear at the top of the checklists section of a task, use `\"position\": 0`." + }, + "description": "Position refers to the order of appearance of checklists on a task.\\\n \\\nTo set a checklist to appear at the top of the checklists section of a task, use `\"position\": 0`.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer", + "description": "Position refers to the order of appearance of checklists on a task.\\\n \\\nTo set a checklist to appear at the top of the checklists section of a task, use `\"position\": 0`." + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditChecklistrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"position\": {\n \"description\": \"Position refers to the order of appearance of checklists on a task.\\\\\\n \\\\\\nTo set a checklist to appear at the top of the checklists section of a task, use `\\\"position\\\": 0`.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Checklist\",\n \"position\": 1\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Checklist\",\n \"position\": 1\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "DeleteChecklist", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_checklist", + "description": { + "tagline": "Deletes a checklist from a task in ClickUp.", + "detailed": "Use this tool to delete a specific checklist from a task in ClickUp by providing the checklist ID. Ideal for when you need to manage or reorganize task checklists." + }, + "return_annotation": "Confirmation of checklist deletion.", + "arguments": [ + { + "name": "checklist_id", + "alternative_names": [ + "checklist_uuid", + "checklist_unique_id" + ], + "description": "The unique identifier for the checklist to be deleted. It should be in UUID format.", + "endpoint_argument_name": "checklist_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/checklist/{checklist_id}", + "tags": [ + "Task Checklists" + ], + "summary": "Delete Checklist", + "description": "Delete a checklist from a task.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "checklist_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateChecklistItem", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_checklist_item_clickup", + "description": { + "tagline": "Add an item to a checklist in ClickUp tasks.", + "detailed": "Use this tool to add a new line item to an existing checklist within a task in ClickUp. This can be useful for task management and ensuring all steps are documented within a checklist." + }, + "return_annotation": "Confirmation of the checklist item being added.", + "arguments": [ + { + "name": "checklist_identifier", + "alternative_names": [ + "checklist_uuid", + "checklist_key" + ], + "description": "A unique identifier for the checklist. Must be in UUID format.", + "endpoint_argument_name": "checklist_id" + }, + { + "name": "checklist_item_name", + "alternative_names": [ + "item_name", + "task_item_name" + ], + "description": "The name of the checklist item to be added. This should clearly describe the task or item to be completed.", + "endpoint_argument_name": "name" + }, + { + "name": "assignee_user_id", + "alternative_names": [ + "assigned_user_id", + "task_assignee_id" + ], + "description": "The unique ID of the user assigned to the checklist item. This should be an integer value representing the user's ID.", + "endpoint_argument_name": "assignee" + } + ] + }, + "method": "POST", + "path": "/v2/checklist/{checklist_id}/checklist_item", + "tags": [ + "Task Checklists" + ], + "summary": "Create Checklist Item", + "description": "Add a line item to a task checklist.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "checklist_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "assignee", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateChecklistItemrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"assignee\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Checklist Item\",\n \"assignee\": 183\n }\n ]\n },\n \"example\": {\n \"name\": \"Checklist Item\",\n \"assignee\": 183\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "EditChecklistItem", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_checklist_item", + "description": { + "tagline": "Modify or update a specific task checklist item.", + "detailed": "This tool updates an individual line item in a task checklist. It can rename the item, set the assignee, mark it as resolved, or nest it under another item." + }, + "return_annotation": "Details of the updated checklist item.", + "arguments": [ + { + "name": "checklist_unique_identifier", + "alternative_names": [ + "checklist_uuid", + "checklist_id_value" + ], + "description": "The UUID of the checklist to update. Example: b8a8-48d8-a0c6-b4200788a683.", + "endpoint_argument_name": "checklist_id" + }, + { + "name": "checklist_item_uuid", + "alternative_names": [ + "task_checklist_uuid", + "line_item_uuid" + ], + "description": "The UUID for the specific checklist item to be updated.", + "endpoint_argument_name": "checklist_item_id" + }, + { + "name": "checklist_item_name", + "alternative_names": [ + "item_name", + "task_name" + ], + "description": "The new name for the checklist item. Provide a string to rename the item.", + "endpoint_argument_name": "name" + }, + { + "name": "assign_item_to_user", + "alternative_names": [ + "set_checklist_item_assignee", + "update_checklist_item_responsible" + ], + "description": "The user ID to which the checklist item will be assigned. This should be a string representing a valid user identifier in ClickUp.", + "endpoint_argument_name": "assignee" + }, + { + "name": "parent_checklist_item_id", + "alternative_names": [ + "nest_under_item_id", + "parent_item_id" + ], + "description": "Include another item's `checklist_item_id` to nest this item under it.", + "endpoint_argument_name": "parent" + }, + { + "name": "mark_as_resolved", + "alternative_names": [ + "set_as_resolved", + "resolve_checklist_item" + ], + "description": "Boolean to mark the checklist item as resolved (true) or unresolved (false).", + "endpoint_argument_name": "resolved" + } + ] + }, + "method": "PUT", + "path": "/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}", + "tags": [ + "Task Checklists" + ], + "summary": "Edit Checklist Item", + "description": "Update an individual line item in a task checklist. \\\n \\\nYou can rename it, set the assignee, mark it as resolved, or nest it under another checklist item.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "checklist_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "checklist_item_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)" + }, + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "assignee", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": [ + "string", + "null" + ] + }, + "schema_required": false + }, + { + "name": "resolved", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "parent", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To nest a checklist item under another checklist item, include the other item's `checklist_item_id`." + }, + "description": "To nest a checklist item under another checklist item, include the other item's `checklist_item_id`.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": [ + "string", + "null" + ], + "description": "To nest a checklist item under another checklist item, include the other item's `checklist_item_id`." + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditChecklistItemrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"assignee\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"resolved\": {\n \"type\": \"boolean\"\n },\n \"parent\": {\n \"description\": \"To nest a checklist item under another checklist item, include the other item's `checklist_item_id`.\",\n \"type\": [\n \"string\",\n \"null\"\n ]\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Checklist Item\",\n \"assignee\": null,\n \"resolved\": true,\n \"parent\": null\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Checklist Item\",\n \"assignee\": null,\n \"resolved\": true,\n \"parent\": null\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "DeleteChecklistItem", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_task_checklist_item", + "description": { + "tagline": "Delete an item from a task checklist in ClickUp.", + "detailed": "Use this tool to delete a specific line item from a checklist associated with a task. Ideal for managing and updating task checklists by removing unnecessary or completed items." + }, + "return_annotation": "Confirmation of checklist item deletion.", + "arguments": [ + { + "name": "checklist_identifier", + "alternative_names": [ + "checklist_id_code", + "uuid_checklist_id" + ], + "description": "The unique identifier (UUID) for the checklist. Used to specify the checklist from which the item will be deleted.", + "endpoint_argument_name": "checklist_id" + }, + { + "name": "checklist_item_uuid", + "alternative_names": [ + "checklist_item_identifier", + "checklist_item_id" + ], + "description": "The unique identifier (UUID) of the checklist item to be deleted.", + "endpoint_argument_name": "checklist_item_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}", + "tags": [ + "Task Checklists" + ], + "summary": "Delete Checklist Item", + "description": "Delete a line item from a task checklist.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "checklist_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "checklist_item_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)" + }, + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetTaskComments", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_task_comments", + "description": { + "tagline": "Retrieve comments from a specified task in ClickUp.", + "detailed": "Use this tool to view comments on a specific task within ClickUp. If no 'start' and 'start_id' parameters are provided, it will return the latest 25 comments. Provide 'start' and 'start_id' to paginate through older comments." + }, + "return_annotation": "Returns the comments of a specified task.", + "arguments": [ + { + "name": "task_identifier", + "alternative_names": [ + "task_id_param", + "task_reference" + ], + "description": "Specify the unique identifier of the task whose comments you want to retrieve.", + "endpoint_argument_name": "task_id" + }, + { + "name": "workspace_id_for_custom_task", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "Provide the Workspace ID when using a custom task ID (requires `custom_task_ids` to be true).", + "endpoint_argument_name": "team_id" + }, + { + "name": "comment_date_unix_time_ms", + "alternative_names": [ + "unix_time_comment_date", + "comment_timestamp_ms" + ], + "description": "Specify the date of a task comment using Unix time in milliseconds for pagination.", + "endpoint_argument_name": "start" + }, + { + "name": "comment_start_id", + "alternative_names": [ + "comment_id_start", + "starting_comment_id" + ], + "description": "The ID of the earliest comment to start retrieving from, used for pagination.", + "endpoint_argument_name": "start_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_task_ids", + "custom_task_id_reference" + ], + "description": "Set to `true` if you want to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "GET", + "path": "/v2/task/{task_id}/comment", + "tags": [ + "Comments" + ], + "summary": "Get Task Comments", + "description": "View task comments. \\\n \\\nIf you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\\\n \\\nUse the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "start", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the `date` of a task comment using Unix time in milliseconds." + }, + "description": "Enter the `date` of a task comment using Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "start_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the Comment `id` of a task comment." + }, + "description": "Enter the Comment `id` of a task comment.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateTaskComment", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_task_comment", + "description": { + "tagline": "Add a new comment to a specific task on ClickUp.", + "detailed": "This tool allows users to add a new comment to a specified task on ClickUp. It should be called when there's a need to comment on a task, offering a way to communicate updates, feedback, or any relevant information directly related to the task in question." + }, + "return_annotation": "Confirmation of the comment being successfully added.", + "arguments": [ + { + "name": "specific_task_id", + "alternative_names": [ + "task_identifier", + "task_reference_id" + ], + "description": "The ID of the task to add the comment to. Required for identifying the target task.", + "endpoint_argument_name": "task_id" + }, + { + "name": "comment_content", + "alternative_names": [ + "task_comment_text", + "comment_body" + ], + "description": "The text of the comment to be added to the task. It should contain any updates, feedback, or relevant information.", + "endpoint_argument_name": "comment_text" + }, + { + "name": "send_notifications_to_all", + "alternative_names": [ + "alert_all_commenters", + "notify_everyone" + ], + "description": "If true, notifications will be sent to everyone, including the creator of the comment.", + "endpoint_argument_name": "notify_all" + }, + { + "name": "workspace_id_for_custom_task", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "Provide the Workspace ID when referencing a task by its custom task ID (set `custom_task_ids` to true).", + "endpoint_argument_name": "team_id" + }, + { + "name": "comment_assignee_id", + "alternative_names": [ + "task_comment_assignee_id", + "comment_assignee" + ], + "description": "An integer representing the user ID of the assignee for the comment on the task.", + "endpoint_argument_name": "assignee" + }, + { + "name": "assignee_group", + "alternative_names": [ + "task_assignee_group", + "comment_assignee_group" + ], + "description": "Specifies a group of users (as a comma-separated string) to be assigned to the comment. Ensure the group is relevant to the task.", + "endpoint_argument_name": "group_assignee" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_task_ids", + "custom_ids_enabled" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "POST", + "path": "/v2/task/{task_id}/comment", + "tags": [ + "Comments" + ], + "summary": "Create Task Comment", + "description": "Add a new comment to a task.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "comment_text", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "assignee", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "group_assignee", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "" + }, + "schema_required": false + }, + { + "name": "notify_all", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean", + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateTaskCommentrequest\",\n \"required\": [\n \"comment_text\",\n \"notify_all\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"comment_text\": {\n \"type\": \"string\"\n },\n \"assignee\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"group_assignee\": {\n \"type\": \"string\",\n \"contentEncoding\": \"int32\",\n \"description\": \"\"\n },\n \"notify_all\": {\n \"description\": \"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.\",\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"comment_text\": \"Task comment content\",\n \"assignee\": 183,\n \"group_assignee\": \"d01f92f-48ca-446d-88a1-0beb0e8f5f14\",\n \"notify_all\": true\n }\n ]\n },\n \"example\": {\n \"comment_text\": \"Task comment content\",\n \"assignee\": 183,\n \"group_assignee\": \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\",\n \"notify_all\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "GetChatViewComments", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_chat_comments", + "description": { + "tagline": "Retrieve the most recent comments from a Chat view.", + "detailed": "This tool fetches comments from a Chat view in ClickUp. It returns the 25 most recent comments if no parameters are provided. To access older comments, use `start` and `start_id` parameters." + }, + "return_annotation": "Returns the most recent comments from a Chat view.", + "arguments": [ + { + "name": "chat_view_id", + "alternative_names": [ + "view_identifier", + "chat_id" + ], + "description": "The unique identifier for the Chat view to retrieve comments from. It should be a string, typically '105'.", + "endpoint_argument_name": "view_id" + }, + { + "name": "comment_start_date_unix_ms", + "alternative_names": [ + "initial_comment_date_unix_ms", + "oldest_comment_date_unix_ms" + ], + "description": "The start date of a Chat view comment in Unix time (milliseconds) to fetch older comments.", + "endpoint_argument_name": "start" + }, + { + "name": "start_comment_id", + "alternative_names": [ + "initial_comment_id", + "chat_comment_id" + ], + "description": "The comment ID to start retrieving older comments from in the Chat view. Use this to fetch comments beyond the most recent 25.", + "endpoint_argument_name": "start_id" + } + ] + }, + "method": "GET", + "path": "/v2/view/{view_id}/comment", + "tags": [ + "Comments" + ], + "summary": "Get Chat View Comments", + "description": "View comments from a Chat view. \\\n \\\nIf you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\\\n \\\nUse the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "start", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the `date` of a Chat view comment using Unix time in milliseconds." + }, + "description": "Enter the `date` of a Chat view comment using Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "start_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the Comment `id` of a Chat view comment." + }, + "description": "Enter the Comment `id` of a Chat view comment.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "view_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "description": "105 (string)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateChatViewComment", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_chat_view_comment", + "description": { + "tagline": "Add a new comment to a Chat view.", + "detailed": "Use this tool to add a comment to a Chat view in ClickUp. This can be used to facilitate discussion and share information in a specific View context." + }, + "return_annotation": "Confirmation of comment addition.", + "arguments": [ + { + "name": "view_id", + "alternative_names": [ + "chat_view_id", + "comment_view_id" + ], + "description": "The ID of the Chat view where the comment will be added. Expected as a string.", + "endpoint_argument_name": "view_id" + }, + { + "name": "comment_text", + "alternative_names": [ + "comment_body", + "message_content" + ], + "description": "The text content of the comment to be added to the Chat view.", + "endpoint_argument_name": "comment_text" + }, + { + "name": "send_notifications_to_all", + "alternative_names": [ + "notify_everyone", + "alert_all_users" + ], + "description": "Set to true to send notifications to everyone, including the comment creator.", + "endpoint_argument_name": "notify_all" + } + ] + }, + "method": "POST", + "path": "/v2/view/{view_id}/comment", + "tags": [ + "Comments" + ], + "summary": "Create Chat View Comment", + "description": "Add a new comment to a Chat view.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "view_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "description": "105 (string)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "comment_text", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "notify_all", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean", + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateChatViewCommentrequest\",\n \"required\": [\n \"comment_text\",\n \"notify_all\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"comment_text\": {\n \"type\": \"string\"\n },\n \"notify_all\": {\n \"description\": \"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.\",\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"comment_text\": \"View comment content\",\n \"notify_all\": true\n }\n ]\n },\n \"example\": {\n \"comment_text\": \"View comment content\",\n \"notify_all\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "GetListComments", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_list_comments", + "description": { + "tagline": "View comments from a specific ClickUp list.", + "detailed": "Use this tool to retrieve the most recent comments from a specified ClickUp list. It returns up to 25 comments by default. To fetch older comments, utilize the optional parameters `start` and `start_id`." + }, + "return_annotation": "Returns a list of comments from a specified ClickUp list.", + "arguments": [ + { + "name": "list_id", + "alternative_names": [ + "list_identifier", + "clickup_list_id" + ], + "description": "The unique integer identifier of the ClickUp list for which comments are being retrieved.", + "endpoint_argument_name": "list_id" + }, + { + "name": "start_date_unix_millis", + "alternative_names": [ + "start_time_unix_millis", + "start_timestamp_unix_millis" + ], + "description": "Enter the date of a list info comment using Unix time in milliseconds to retrieve comments starting from this timestamp.", + "endpoint_argument_name": "start" + }, + { + "name": "oldest_comment_id", + "alternative_names": [ + "start_comment_id", + "previous_comment_id" + ], + "description": "ID of the oldest comment to start retrieving additional comments from.", + "endpoint_argument_name": "start_id" + } + ] + }, + "method": "GET", + "path": "/v2/list/{list_id}/comment", + "tags": [ + "Comments" + ], + "summary": "Get List Comments", + "description": "View the comments added to a List. \\\n \\\nIf you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\\\n \\\nUse the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "start", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the `date` of a List info comment using Unix time in milliseconds." + }, + "description": "Enter the `date` of a List info comment using Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "start_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the Comment `id` of a List info comment." + }, + "description": "Enter the Comment `id` of a List info comment.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateListComment", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_comment_to_list", + "description": { + "tagline": "Add a comment to a specific list in ClickUp.", + "detailed": "This tool allows you to add a comment to a specified list in ClickUp. Use it when you need to provide additional information or feedback on a list." + }, + "return_annotation": "Confirmation of comment addition to a list.", + "arguments": [ + { + "name": "list_identifier", + "alternative_names": [ + "target_list_id", + "list_reference_id" + ], + "description": "The unique ID of the list where the comment will be added.", + "endpoint_argument_name": "list_id" + }, + { + "name": "comment_text", + "alternative_names": [ + "text_comment", + "list_comment_text" + ], + "description": "The text of the comment to be added to the list. This should contain the message or information you wish to convey.", + "endpoint_argument_name": "comment_text" + }, + { + "name": "assignee_id", + "alternative_names": [ + "assigned_user_id", + "responsible_user_id" + ], + "description": "The ID of the user to whom the comment is assigned. This should be an integer value representing the user's unique identifier.", + "endpoint_argument_name": "assignee" + }, + { + "name": "notify_all", + "alternative_names": [ + "notify_everyone", + "send_notifications_to_all" + ], + "description": "If true, notifications are sent to everyone, including the comment creator.", + "endpoint_argument_name": "notify_all" + } + ] + }, + "method": "POST", + "path": "/v2/list/{list_id}/comment", + "tags": [ + "Comments" + ], + "summary": "Create List Comment", + "description": "Add a comment to a List.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "comment_text", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "assignee", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + }, + { + "name": "notify_all", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean", + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateListCommentrequest\",\n \"required\": [\n \"comment_text\",\n \"assignee\",\n \"notify_all\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"comment_text\": {\n \"type\": \"string\"\n },\n \"assignee\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"notify_all\": {\n \"description\": \"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.\",\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"comment_text\": \"List comment content\",\n \"assignee\": 183,\n \"notify_all\": true\n }\n ]\n },\n \"example\": {\n \"comment_text\": \"List comment content\",\n \"assignee\": 183,\n \"notify_all\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "UpdateComment", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_task_comment", + "description": { + "tagline": "Update a task comment in ClickUp.", + "detailed": "Use this tool to replace a task comment's content, assign it, or mark it as resolved in ClickUp." + }, + "return_annotation": "Details of the updated comment status and content.", + "arguments": [ + { + "name": "comment_identifier", + "alternative_names": [ + "comment_id_number", + "comment_reference" + ], + "description": "The unique identifier of the comment to update. It must be an integer.", + "endpoint_argument_name": "comment_id" + }, + { + "name": "new_comment_content", + "alternative_names": [ + "updated_comment_text", + "comment_body" + ], + "description": "The new content for the task comment. This will replace the existing comment text.", + "endpoint_argument_name": "comment_text" + }, + { + "name": "assignee_user_id", + "alternative_names": [ + "assignment_user_id", + "comment_assignee_id" + ], + "description": "The ID of the user to assign the comment to. This should be a numeric user ID in ClickUp.", + "endpoint_argument_name": "assignee" + }, + { + "name": "mark_comment_as_resolved", + "alternative_names": [ + "resolve_comment_status", + "set_comment_resolved" + ], + "description": "Set to true to mark the comment as resolved; false to leave it unresolved. Accepts a boolean value.", + "endpoint_argument_name": "resolved" + }, + { + "name": "assign_to_group", + "alternative_names": [ + "group_assignment", + "assign_group" + ], + "description": "Assign the comment to a group by providing the group's ID.", + "endpoint_argument_name": "group_assignee" + } + ] + }, + "method": "PUT", + "path": "/v2/comment/{comment_id}", + "tags": [ + "Comments" + ], + "summary": "Update Comment", + "description": "Replace the content of a task commment, assign a comment, and mark a comment as resolved.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "comment_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "comment_text", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "assignee", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + }, + { + "name": "group_assignee", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer", + "description": "" + }, + "schema_required": false + }, + { + "name": "resolved", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean", + "description": "" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateCommentrequest\",\n \"required\": [\n \"comment_text\",\n \"assignee\",\n \"resolved\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"comment_text\": {\n \"type\": \"string\"\n },\n \"assignee\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"group_assignee\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\",\n \"description\": \"\"\n },\n \"resolved\": {\n \"description\": \"\",\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"comment_text\": \"Updated comment content\",\n \"assignee\": 183,\n \"resolved\": true\n }\n ]\n },\n \"example\": {\n \"comment_text\": \"Updated comment content\",\n \"assignee\": 183,\n \"group_assignee\": \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\",\n \"resolved\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "DeleteComment", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_task_comment", + "description": { + "tagline": "Delete a comment from a task.", + "detailed": "Use this tool to delete a specific comment from a task. It should be called when you need to remove a comment based on its unique identifier." + }, + "return_annotation": "Confirmation of comment deletion.", + "arguments": [ + { + "name": "comment_id", + "alternative_names": [ + "comment_identifier", + "task_comment_id" + ], + "description": "The unique integer identifier of the comment to be deleted.", + "endpoint_argument_name": "comment_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/comment/{comment_id}", + "tags": [ + "Comments" + ], + "summary": "Delete Comment", + "description": "Delete a task comment.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "comment_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetThreadedComments", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_threaded_comments", + "description": { + "tagline": "Retrieve threaded replies to a comment.", + "detailed": "This tool allows for the retrieval of threaded comments in a ClickUp task, excluding the parent comment. Use this tool to view discussions or replies linked to a specific comment by providing the comment ID." + }, + "return_annotation": "Threaded comments excluding the parent comment.", + "arguments": [ + { + "name": "thread_comment_id", + "alternative_names": [ + "parent_comment_id", + "original_comment_id" + ], + "description": "The ID of the comment for which threaded replies are to be retrieved. This ID should be an integer and corresponds to the comment in a ClickUp task whose replies you want to view.", + "endpoint_argument_name": "comment_id" + } + ] + }, + "method": "GET", + "path": "/v2/comment/{comment_id}/reply", + "tags": [ + "Comments" + ], + "summary": "Get Threaded Comments", + "description": "View threaded comments. The parent comment is not included in the response.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "comment_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateThreadedComment", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_threaded_comment", + "description": { + "tagline": "Create a threaded comment in a ClickUp task.", + "detailed": "This tool is used to create a threaded comment as a reply to an existing comment in a ClickUp task. It is useful when you want to continue a discussion or provide additional information to a specific comment thread." + }, + "return_annotation": "Information about the created threaded comment.", + "arguments": [ + { + "name": "parent_comment_id", + "alternative_names": [ + "thread_comment_id", + "reply_to_comment_id" + ], + "description": "The ID of the parent comment to which the threaded reply will be attached. It should be an integer.", + "endpoint_argument_name": "comment_id" + }, + { + "name": "threaded_comment_content", + "alternative_names": [ + "reply_content", + "comment_body" + ], + "description": "This is the content of the threaded comment to be added. Provide the text that forms the body of the reply.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/comment/{comment_id}/reply", + "tags": [ + "Comments" + ], + "summary": "Create Threaded Comment", + "description": "Create a threaded comment.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "comment_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1comment/post/requestBody/content/application~1json/schema", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/post/requestBody/content/application~1json/schema" + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1comment/post/requestBody/content/application~1json/schema\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1task~1%7Btask_id%7D~1comment/post/requestBody/content/application~1json/schema\"\n },\n \"example\": {\n \"comment_text\": \"Task comment content\",\n \"assignee\": 183,\n \"group_assignee\": \"d01f92f-48ca-446d-88a1-0beb0e8f5f14\",\n \"notify_all\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "GetAccessibleCustomFields", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_list_custom_fields", + "description": { + "tagline": "Retrieve accessible custom fields for a specific list.", + "detailed": "Use this tool to view the custom fields you have access to in a specific list. This is useful for understanding which custom fields are available for use or modification in your lists." + }, + "return_annotation": "A list of accessible custom fields for a specific list.", + "arguments": [ + { + "name": "list_id", + "alternative_names": [ + "list_identifier", + "specific_list_id" + ], + "description": "The unique identifier of the list to retrieve accessible custom fields for.", + "endpoint_argument_name": "list_id" + }, + { + "name": "content_type", + "alternative_names": [ + "header_content_type", + "http_header_type" + ], + "description": "The MIME type of the request body, typically set to 'application/json'.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "GET", + "path": "/v2/list/{list_id}/field", + "tags": [ + "Custom Fields" + ], + "summary": "Get List Custom Fields", + "description": "View the Custom Fields you have access to in a specific List.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "getFolderAvailableFields", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_folder_custom_fields", + "description": { + "tagline": "Retrieve accessible custom fields from a folder in ClickUp.", + "detailed": "This tool retrieves the custom fields that are accessible at the folder level in ClickUp. It's useful when you need to know what folder-level custom fields are available for a specific folder. Custom fields created at the list level aren't included." + }, + "return_annotation": "Returns available custom fields for a specified folder.", + "arguments": [ + { + "name": "folder_id", + "alternative_names": [ + "folder_identifier", + "folder_ref" + ], + "description": "The unique identifier of the folder to retrieve custom fields from. Must be an integer corresponding to a specific folder in ClickUp.", + "endpoint_argument_name": "folder_id" + }, + { + "name": "content_type", + "alternative_names": [ + "content_type_header", + "content_type_value" + ], + "description": "The MIME type of the content being sent. Typically, use 'application/json'.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "GET", + "path": "/v2/folder/{folder_id}/field", + "tags": [ + "Custom Fields" + ], + "summary": "Get Folder Custom Fields", + "description": "View the Custom Fields you have access to in a Folder. Get Folder Custom Fields only returns Custom Fields created at the Folder level. Custom Fields created at the List level are not included.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "getSpaceAvailableFields", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_space_custom_fields", + "description": { + "tagline": "Retrieve custom fields accessible in a specific ClickUp space.", + "detailed": "This tool retrieves the custom fields available to you in a specified ClickUp space. It returns only the custom fields created at the space level, excluding those at the folder and list levels." + }, + "return_annotation": "List of custom fields available in a specific space.", + "arguments": [ + { + "name": "space_identifier", + "alternative_names": [ + "space_id_value", + "unique_space_id" + ], + "description": "The unique identifier for the ClickUp space from which to fetch available custom fields. It should be an integer.", + "endpoint_argument_name": "space_id" + }, + { + "name": "content_type_header", + "alternative_names": [ + "content_type", + "http_content_type" + ], + "description": "The MIME type for the request header, typically 'application/json'.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "GET", + "path": "/v2/space/{space_id}/field", + "tags": [ + "Custom Fields" + ], + "summary": "Get Space Custom Fields", + "description": "View the Custom Fields you have access to in a specific Space. Get Space Custom Fields only returns Custom Fields created at the Space level. Custom Fields created at the Folder and List level are not included.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "getTeamAvailableFields", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_workspace_custom_fields", + "description": { + "tagline": "Retrieve Workspace-level Custom Fields in ClickUp.", + "detailed": "Use this tool to view custom fields accessible at the workspace level in ClickUp. It doesn't include fields from Space, Folder, or List levels." + }, + "return_annotation": "List of custom fields available in the specified workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "workspace_identifier", + "ws_id" + ], + "description": "The ID of the Workspace to retrieve custom fields for. This identifies which Workspace's fields you want to view.", + "endpoint_argument_name": "team_id" + }, + { + "name": "content_type_header", + "alternative_names": [ + "content_type", + "header_content_type" + ], + "description": "The MIME type of the content. Typically set to 'application/json' for JSON data.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/field", + "tags": [ + "Custom Fields" + ], + "summary": "Get Workspace Custom Fields", + "description": "View the Custom Fields you have access to in a specific Workspace. Get Workspace Custom Fields only returns Custom Fields created at the Workspace level. Custom Fields created at the Space, Folder, and List level are not included.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "SetCustomFieldValue", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_task_custom_field", + "description": { + "tagline": "Update a custom field value for a specific task in ClickUp.", + "detailed": "Use this tool to add data to a custom field on a task. Requires the `task_id` of the task and the `field_id` of the custom field. Retrieve `field_id` using the 'Get Accessible Custom Fields' or 'Get Task' endpoints." + }, + "return_annotation": "Updates a custom field value for a task.", + "arguments": [ + { + "name": "task_id", + "alternative_names": [ + "task_identifier", + "task_reference_id" + ], + "description": "The ID of the task to be updated with new custom field data.", + "endpoint_argument_name": "task_id" + }, + { + "name": "custom_field_uuid", + "alternative_names": [ + "field_identifier", + "custom_field_id" + ], + "description": "The UUID of the custom field to update for a specific task.", + "endpoint_argument_name": "field_id" + }, + { + "name": "custom_field_value_data", + "alternative_names": [ + "custom_field_data", + "field_value_payload" + ], + "description": "A JSON object containing the data to set for the custom field on the task.", + "endpoint_argument_name": "requestBody" + }, + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "Provide the Workspace ID when referencing a task by its Custom Task ID (`custom_task_ids` must be true).", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_id_reference", + "alternative_names": [ + "enable_custom_task_id_usage", + "set_custom_id_reference" + ], + "description": "Set to `true` to reference a task using its Custom Task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "POST", + "path": "/v2/task/{task_id}/field/{field_id}", + "tags": [ + "Custom Fields" + ], + "summary": "Set Custom Field Value", + "description": "Add data to a Custom field on a task. \\\n \\\nYou'll need to know the `task_id` of the task you want to update, and the universal unique identifier (UUID) `field_id` of the Custom Field you want to set. \\\n \\\nYou can use [Get Accessible Custom Fields](ref:getaccessiblecustomfields) or the [Get Task](ref:gettask) endpoint to find the `field_id`.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its Custom Task ID, this value must be `true`." + }, + "description": "If you want to reference a task by its Custom Task ID, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the task ID of the task you want to update." + }, + "description": "Enter the task ID of the task you want to update.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "field_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the universal unique identifier (UUID) of the Custom Field you want to set." + }, + "description": "Enter the universal unique identifier (UUID) of the Custom Field you want to set.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "SetCustomFieldValuerequest", + "properties": {}, + "anyOf": [ + { + "type": "object", + "title": "URL Custom Field", + "description": "The `value` must be a string with a valid URL.", + "properties": { + "value": { + "type": "string", + "example": "https://clickup.com/api" + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Dropdown Custom Field", + "description": "Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.", + "properties": { + "value": { + "type": "string", + "example": "uuid1234" + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Email Custom Field", + "description": "The `value` must be a string with a valid email address.", + "properties": { + "value": { + "type": "string", + "example": "user@company.com" + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Phone Custom Field", + "description": "The `value` must be a string with a valid country code.", + "properties": { + "value": { + "type": "string", + "example": "+1 123 456 7890" + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Date Custom Field", + "description": "The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.", + "properties": { + "value": { + "type": "integer", + "format": "int32", + "example": 1667367645000 + }, + "value_options": { + "type": "object", + "properties": { + "time": { + "type": "boolean", + "example": true + } + }, + "required": [ + "time" + ] + } + } + }, + { + "type": "object", + "title": "Short or Long Text Custom Field", + "description": "Enter a string of text.", + "properties": { + "value": { + "type": "string", + "example": "This is short or long text in a Custom Field." + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Number Custom Field", + "description": "Enter a number.", + "properties": { + "value": { + "type": "number", + "example": -28 + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Money Custom Field", + "description": "You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "properties": { + "value": { + "type": "number", + "example": 8000 + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Task Relationship Custom Field", + "description": "Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship.", + "properties": { + "value": { + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "string" + } + }, + "rem": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "People Custom Field", + "description": "Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams)", + "properties": { + "value": { + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "number" + } + }, + "rem": { + "type": "array", + "items": { + "type": "number" + } + } + } + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Emoji (Rating) Custom Field", + "description": "Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "properties": { + "value": { + "type": "integer", + "format": "int32", + "example": 4 + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Manual Progress Custom Field", + "description": "Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "properties": { + "value": { + "type": "object", + "properties": { + "current": { + "type": "number", + "example": 20 + } + }, + "required": [ + "current" + ] + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Label Custom Field", + "description": "Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "properties": { + "value": { + "type": "array", + "items": { + "type": "string", + "example": [ + "uuid1234", + "uuid9876" + ] + } + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Location Custom Field", + "description": "Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)", + "properties": { + "value": { + "type": "object", + "properties": { + "location": { + "type": "object", + "properties": { + "lat": { + "type": "number" + }, + "lng": { + "type": "number" + } + } + }, + "formatted_address": { + "type": "string" + } + } + } + }, + "required": [ + "value" + ] + }, + { + "type": "object", + "title": "Button Custom Field", + "description": "Set a button Custom Field to `true` to \"click\" it. This will trigger the button's action as if it was clicked in the UI.", + "properties": { + "value": { + "type": "boolean", + "example": true + } + }, + "required": [ + "value" + ] + } + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"SetCustomFieldValuerequest\",\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"title\": \"URL Custom Field\",\n \"description\": \"The `value` must be a string with a valid URL.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"example\": \"https://clickup.com/api\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Dropdown Custom Field\",\n \"description\": \"Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"example\": \"uuid1234\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Email Custom Field\",\n \"description\": \"The `value` must be a string with a valid email address.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"example\": \"user@company.com\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Phone Custom Field\",\n \"description\": \"The `value` must be a string with a valid country code.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"example\": \"+1 123 456 7890\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Date Custom Field\",\n \"description\": \"The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.\",\n \"properties\": {\n \"value\": {\n \"type\": \"integer\",\n \"format\": \"int32\",\n \"example\": 1667367645000\n },\n \"value_options\": {\n \"type\": \"object\",\n \"required\": [\n \"time\"\n ],\n \"properties\": {\n \"time\": {\n \"type\": \"boolean\",\n \"example\": true\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Short or Long Text Custom Field\",\n \"description\": \"Enter a string of text.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"example\": \"This is short or long text in a Custom Field.\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Number Custom Field\",\n \"description\": \"Enter a number.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"number\",\n \"example\": -28\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Money Custom Field\",\n \"description\": \"You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"number\",\n \"example\": 8000\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Task Relationship Custom Field\",\n \"description\": \"Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"People Custom Field\",\n \"description\": \"Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Emoji (Rating) Custom Field\",\n \"description\": \"Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"integer\",\n \"format\": \"int32\",\n \"example\": 4\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Manual Progress Custom Field\",\n \"description\": \"Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"object\",\n \"required\": [\n \"current\"\n ],\n \"properties\": {\n \"current\": {\n \"type\": \"number\",\n \"example\": 20\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Label Custom Field\",\n \"description\": \"Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"example\": [\n \"uuid1234\",\n \"uuid9876\"\n ]\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Location Custom Field\",\n \"description\": \"Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"object\",\n \"properties\": {\n \"lat\": {\n \"type\": \"number\"\n },\n \"lng\": {\n \"type\": \"number\"\n }\n }\n },\n \"formatted_address\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Button Custom Field\",\n \"description\": \"Set a button Custom Field to `true` to \\\"click\\\" it. This will trigger the button's action as if it was clicked in the UI.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"boolean\",\n \"example\": true\n }\n }\n }\n ]\n },\n \"examples\": {\n \"URL Custom Field\": {\n \"value\": {\n \"value\": \"https://clickup.com/api\"\n }\n },\n \"Dropdown Custom Field\": {\n \"value\": {\n \"value\": \"uuid1234\"\n }\n },\n \"Email Custom Field\": {\n \"value\": {\n \"value\": \"user@company.com\"\n }\n },\n \"Phone Custom Field\": {\n \"value\": {\n \"value\": \"+1 201 555 0123\"\n }\n },\n \"Date Custom Field\": {\n \"value\": {\n \"value\": 1667367645000,\n \"value_options\": {\n \"time\": true\n }\n }\n },\n \"Short or Long Text Custom Field\": {\n \"value\": {\n \"value\": \"This is short or long text in a Custom Field.\"\n }\n },\n \"Number Custom Field\": {\n \"value\": {\n \"value\": -28\n }\n },\n \"Money Custom Field\": {\n \"value\": {\n \"value\": 8000\n }\n },\n \"Task Relationship Custom Field\": {\n \"value\": {\n \"value\": {\n \"add\": [\n \"abcd1234\",\n \"efghi5678\"\n ],\n \"rem\": [\n \"jklm9876\",\n \"yuiop5678\"\n ]\n }\n }\n },\n \"People Custom Field\": {\n \"value\": {\n \"value\": {\n \"add\": [\n 123,\n 456\n ],\n \"rem\": [\n 987,\n 765\n ]\n }\n }\n },\n \"Emoji (Rating) Custom Field\": {\n \"value\": {\n \"value\": 4\n }\n },\n \"Manual Progress Custom Field\": {\n \"value\": {\n \"value\": {\n \"current\": 20\n }\n }\n },\n \"Label Custom Field\": {\n \"value\": {\n \"value\": [\n \"uuid1234\",\n \"uuid9876\"\n ]\n }\n },\n \"Location Custom Field\": {\n \"value\": {\n \"value\": {\n \"location\": {\n \"lat\": -28.016667,\n \"lng\": 153.4\n },\n \"formatted_address\": \"Gold Coast QLD, Australia\"\n }\n }\n },\n \"Button Custom Field\": {\n \"value\": {\n \"value\": true\n }\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "RemoveCustomFieldValue", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_custom_field_value", + "description": { + "tagline": "Remove a custom field value from a ClickUp task.", + "detailed": "Use this tool to remove the data from a custom field on a ClickUp task without deleting the field option itself." + }, + "return_annotation": "Confirmation of custom field value removal from a task.", + "arguments": [ + { + "name": "task_identifier", + "alternative_names": [ + "task_id_value", + "task_unique_id" + ], + "description": "The unique identifier of the task from which you want to remove the custom field value.", + "endpoint_argument_name": "task_id" + }, + { + "name": "custom_field_id", + "alternative_names": [ + "field_identifier", + "field_uuid" + ], + "description": "UUID of the custom field to be removed from the task. Example: b8a8-48d8-a0c6-b4200788a683", + "endpoint_argument_name": "field_id" + }, + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "organization_id" + ], + "description": "Provide the Workspace ID when referencing a task by custom task id.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "reference_by_custom_id", + "custom_id_flag" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "DELETE", + "path": "/v2/task/{task_id}/field/{field_id}", + "tags": [ + "Custom Fields" + ], + "summary": "Remove Custom Field Value", + "description": "Remove the data from a Custom Field on a task. This does not delete the option from the Custom Field.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "field_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "AddDependency", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "set_task_dependency", + "description": { + "tagline": "Set a task as waiting on or blocking another task.", + "detailed": "Use this tool to establish a dependency between tasks in ClickUp, either setting a task as waiting on another or as blocking one." + }, + "return_annotation": "Confirmation of task dependency addition.", + "arguments": [ + { + "name": "task_id_of_dependency", + "alternative_names": [ + "dependent_task_id", + "waiting_or_blocking_task_id" + ], + "description": "The ID of the task that is waiting on or blocking another task.", + "endpoint_argument_name": "task_id" + }, + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "Provide the Workspace ID when `custom_task_ids` is true. Necessary for task identification.", + "endpoint_argument_name": "team_id" + }, + { + "name": "depends_on_task_id", + "alternative_names": [ + "dependent_task_id", + "blocked_by_task_id" + ], + "description": "Specify the task ID that this task depends on or is blocked by. It should be a valid task ID in ClickUp.", + "endpoint_argument_name": "depends_on" + }, + { + "name": "dependent_task_id", + "alternative_names": [ + "dependent_id", + "dependent_task" + ], + "description": "The ID of the task that the specified task depends on or is blocking. This establishes the task dependency relationship.", + "endpoint_argument_name": "depedency_of" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_task_references", + "custom_task_identification" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "POST", + "path": "/v2/task/{task_id}/dependency", + "tags": [ + "Task Relationships" + ], + "summary": "Add Dependency", + "description": "Set a task as waiting on or blocking another task.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is the task which is waiting on or blocking another task." + }, + "description": "This is the task which is waiting on or blocking another task.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "depends_on", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "depedency_of", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"Use the `depends_on` parameter in the request body to specify the task that must be completed before the task in the path parameter.\\\\\\n \\\\\\nUse the `dependency_of` parameter in the request body to specify the task that's waiting for the task in the path parameter to be completed.\\\\\\n \\\\\\nYou can only use one per request.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"AddDependencyrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"depends_on\": {\n \"type\": \"string\"\n },\n \"depedency_of\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"depends_on\": \"9hw\"\n }\n ]\n },\n \"example\": {\n \"depends_on\": \"9hw\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "DeleteDependency", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_task_dependency", + "description": { + "tagline": "Remove a dependency relationship between tasks.", + "detailed": "This tool is used to remove the dependency relationship between two or more tasks in ClickUp. Call this when two tasks that are currently dependent on one another need to be independent." + }, + "return_annotation": "Confirmation of task dependency removal.", + "arguments": [ + { + "name": "depends_on_task_id", + "alternative_names": [ + "task_id_dependent", + "dependency_task_id" + ], + "description": "The ID of the task that another task depends on. Provide a valid task ID to specify the dependent task.", + "endpoint_argument_name": "depends_on" + }, + { + "name": "dependent_task_id", + "alternative_names": [ + "dependency_target_id", + "dependent_task_identifier" + ], + "description": "The task ID that is dependent on another. Provide a valid task ID as a string.", + "endpoint_argument_name": "dependency_of" + }, + { + "name": "task_id_to_remove_dependency", + "alternative_names": [ + "target_task_id", + "task_dependency_id" + ], + "description": "Specify the task ID from which the dependency is to be removed. This is required to identify the task involved in the dependency relationship.", + "endpoint_argument_name": "task_id" + }, + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "Provide the Workspace ID when using custom task IDs by setting `custom_task_ids` to `true`.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "reference_by_custom_id", + "enable_custom_ids" + ], + "description": "Set to true if referencing tasks by their custom task IDs is desired.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "DELETE", + "path": "/v2/task/{task_id}/dependency", + "tags": [ + "Task Relationships" + ], + "summary": "Delete Dependency", + "description": "Remove the dependency relationship between two or more tasks.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "depends_on", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "dependency_of", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "AddTaskLink", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "link_tasks_clickup", + "description": { + "tagline": "Link two ClickUp tasks together.", + "detailed": "This tool allows you to link two tasks in ClickUp via the Task Links feature in the right-hand sidebar of a task. It should be called when you need to associate tasks directly, but does not support linking to other types of objects." + }, + "return_annotation": "Confirmation of tasks being linked successfully.", + "arguments": [ + { + "name": "source_task_id", + "alternative_names": [ + "initiate_task_id", + "start_task_id" + ], + "description": "The ID of the task from which the link will be initiated.", + "endpoint_argument_name": "task_id" + }, + { + "name": "task_to_link_to", + "alternative_names": [ + "target_task_id", + "related_task_id" + ], + "description": "The ID of the task to link to the initiating task.", + "endpoint_argument_name": "links_to" + }, + { + "name": "workspace_id_for_custom_task", + "alternative_names": [ + "workspace_id", + "team_identifier" + ], + "description": "Provide the Workspace ID if referencing a task by custom task id (when custom_task_ids is true).", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "reference_by_custom_id", + "enable_custom_ids" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "POST", + "path": "/v2/task/{task_id}/link/{links_to}", + "tags": [ + "Task Relationships" + ], + "summary": "Add Task Link", + "description": "This is the equivalent of the feature _Task Links_ in the right-hand sidebar of a Task. It allows you to link two tasks together. General links or links to other objects than tasks are not supported.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The task to initiate the link from." + }, + "description": "The task to initiate the link from.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "links_to", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The task to link to." + }, + "description": "The task to link to.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "DeleteTaskLink", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_task_link", + "description": { + "tagline": "Remove the link between two tasks.", + "detailed": "Use this tool to delete an existing link between two tasks in ClickUp. It is helpful when you need to unlink tasks that are no longer related." + }, + "return_annotation": "Confirmation of task link removal.", + "arguments": [ + { + "name": "primary_task_id", + "alternative_names": [ + "main_task_id", + "base_task_id" + ], + "description": "The ID of the primary task from which to remove the link. This is required to identify the task.", + "endpoint_argument_name": "task_id" + }, + { + "name": "linked_task_id", + "alternative_names": [ + "target_task_id", + "linked_to_task_id" + ], + "description": "The task ID of the task to which the original task is linked. This specifies the connection to be removed.", + "endpoint_argument_name": "links_to" + }, + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "Provide the Workspace ID when `custom_task_ids` is set to `true`.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "reference_by_custom_id", + "enable_custom_task_id" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "DELETE", + "path": "/v2/task/{task_id}/link/{links_to}", + "tags": [ + "Task Relationships" + ], + "summary": "Delete Task Link", + "description": "Remove the link between two tasks.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "links_to", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetFolders", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_space_folders", + "description": { + "tagline": "Retrieve a list of folders from a specified space.", + "detailed": "Use this tool to view folders within a specific space in ClickUp. It is useful when you need to access or manage the folders in a particular workspace." + }, + "return_annotation": "A list of folders within a specified space.", + "arguments": [ + { + "name": "space_id", + "alternative_names": [ + "workspace_id", + "location_id" + ], + "description": "The unique identifier of the space from which to retrieve folders. This is required to specify which space's folders are being requested.", + "endpoint_argument_name": "space_id" + }, + { + "name": "include_archived_folders", + "alternative_names": [ + "show_archived_folders", + "display_archived_folders" + ], + "description": "Set to true to include archived folders in the results.", + "endpoint_argument_name": "archived" + } + ] + }, + "method": "GET", + "path": "/v2/space/{space_id}/folder", + "tags": [ + "Folders" + ], + "summary": "Get Folders", + "description": "View the Folders in a Space.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "archived", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateFolder", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_folder_in_space", + "description": { + "tagline": "Add a new Folder to a Space in ClickUp.", + "detailed": "This tool allows you to create a new folder within a specified space in ClickUp. Use it when you need to organize tasks or projects into a new folder under an existing space." + }, + "return_annotation": "Details of the newly created folder within a space.", + "arguments": [ + { + "name": "space_id", + "alternative_names": [ + "workspace_id", + "region_id" + ], + "description": "The unique identifier for the ClickUp Space where the folder will be created. It should be an integer.", + "endpoint_argument_name": "space_id" + }, + { + "name": "folder_name", + "alternative_names": [ + "new_folder_name", + "folder_title" + ], + "description": "The name of the new folder to be created in the specified space. It should be a string representing the folder's title.", + "endpoint_argument_name": "name" + } + ] + }, + "method": "POST", + "path": "/v2/space/{space_id}/folder", + "tags": [ + "Folders" + ], + "summary": "Create Folder", + "description": "Add a new Folder to a Space.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateFolderrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Folder Name\"\n }\n ]\n },\n \"example\": {\n \"name\": \"New Folder Name\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "GetFolder", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_folder_lists", + "description": { + "tagline": "Retrieve lists contained in a specified folder.", + "detailed": "Call this tool to access all the lists that are organized under a specific folder in ClickUp by providing the folder ID." + }, + "return_annotation": "Lists within a specified folder.", + "arguments": [ + { + "name": "folder_id", + "alternative_names": [ + "folder_identifier", + "folder_key" + ], + "description": "The unique identifier for the folder whose lists you want to retrieve. This must be an integer.", + "endpoint_argument_name": "folder_id" + } + ] + }, + "method": "GET", + "path": "/v2/folder/{folder_id}", + "tags": [ + "Folders" + ], + "summary": "Get Folder", + "description": "View the Lists within a Folder.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "UpdateFolder", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "rename_clickup_folder", + "description": { + "tagline": "Rename a folder in ClickUp.", + "detailed": "Use this tool to update the name of a folder in ClickUp by specifying the folder ID and the new name." + }, + "return_annotation": "Confirmation of the folder rename action.", + "arguments": [ + { + "name": "folder_id_clickup", + "alternative_names": [ + "clickup_folder_identifier", + "id_for_clickup_folder" + ], + "description": "The unique identifier for the ClickUp folder you wish to rename.", + "endpoint_argument_name": "folder_id" + }, + { + "name": "new_folder_name", + "alternative_names": [ + "folder_name", + "updated_folder_name" + ], + "description": "Specify the new name for the folder. This is the name that the folder will be renamed to in ClickUp.", + "endpoint_argument_name": "name" + } + ] + }, + "method": "PUT", + "path": "/v2/folder/{folder_id}", + "tags": [ + "Folders" + ], + "summary": "Update Folder", + "description": "Rename a Folder.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateFolderrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Folder Name\"\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Folder Name\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "DeleteFolder", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_workspace_folder", + "description": { + "tagline": "Delete a folder from your ClickUp workspace.", + "detailed": "Use this tool to permanently delete a specific folder from your ClickUp workspace. Ensure you have the correct folder ID before performing this action." + }, + "return_annotation": "Confirmation of folder deletion.", + "arguments": [ + { + "name": "folder_id", + "alternative_names": [ + "workspace_folder_id", + "clickup_folder_id" + ], + "description": "The unique ID of the folder to be deleted from your ClickUp workspace. Ensure this ID is correct to avoid unintended deletions.", + "endpoint_argument_name": "folder_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/folder/{folder_id}", + "tags": [ + "Folders" + ], + "summary": "Delete Folder", + "description": "Delete a Folder from your Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetGoals", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_workspace_goals", + "description": { + "tagline": "View the Goals available in a Workspace.", + "detailed": "This tool retrieves the goals available in a specific workspace on ClickUp. It should be used when you need to access or display information about the goals associated with a given workspace." + }, + "return_annotation": "A list of goals available in a workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "workspace_identifier", + "team_identifier" + ], + "description": "The unique identifier for the workspace to view its goals.", + "endpoint_argument_name": "team_id" + }, + { + "name": "include_completed_goals", + "alternative_names": [ + "show_completed_goals", + "list_completed_goals" + ], + "description": "Indicate whether to include completed goals in the results. Set to true to include completed goals, or false to exclude them.", + "endpoint_argument_name": "include_completed" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/goal", + "tags": [ + "Goals" + ], + "summary": "Get Goals", + "description": "View the Goals available in a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "include_completed", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateGoal", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_workspace_goal", + "description": { + "tagline": "Add a new goal to a specified workspace.", + "detailed": "This tool allows you to create a new goal in a specific workspace by providing the necessary details. Use it to set objectives and track progress within teams." + }, + "return_annotation": "Response indicating the success and details of the created goal.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the workspace where the goal will be added. This is a numeric value.", + "endpoint_argument_name": "team_id" + }, + { + "name": "goal_name", + "alternative_names": [ + "goal_title", + "goal_label" + ], + "description": "The name or title of the goal to be added to the workspace.", + "endpoint_argument_name": "name" + }, + { + "name": "due_date_timestamp", + "alternative_names": [ + "goal_due_date", + "deadline_timestamp" + ], + "description": "The due date for the goal as a Unix timestamp in milliseconds. Represents when the goal should be completed.", + "endpoint_argument_name": "due_date" + }, + { + "name": "goal_description", + "alternative_names": [ + "goal_details", + "objective_description" + ], + "description": "A brief explanation of the goal to be added, providing context and details.", + "endpoint_argument_name": "description" + }, + { + "name": "goal_owners", + "alternative_names": [ + "goal_user_ids", + "goal_participants" + ], + "description": "Array of user IDs for those assigned to own the goal, allowing multiple owners.", + "endpoint_argument_name": "owners" + }, + { + "name": "goal_color", + "alternative_names": [ + "goal_color_code", + "goal_theme_color" + ], + "description": "The color code for the goal. Expected to be a string representing a color, such as a hex code like '#FF5733'.", + "endpoint_argument_name": "color" + }, + { + "name": "allow_multiple_owners", + "alternative_names": [ + "enable_multiple_owners", + "set_multiple_owners" + ], + "description": "Set to true to allow a goal to have multiple owners, or false for a single owner.", + "endpoint_argument_name": "multiple_owners" + } + ] + }, + "method": "POST", + "path": "/v2/team/{team_id}/goal", + "tags": [ + "Goals" + ], + "summary": "Create Goal", + "description": "Add a new Goal to a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "due_date", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + }, + { + "name": "description", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "multiple_owners", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": true + }, + { + "name": "owners", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of user IDs." + }, + "description": "Array of user IDs.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "description": "Array of user IDs.", + "items": { + "type": "integer" + } + }, + "schema_required": true + }, + { + "name": "color", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateGoalrequest\",\n \"required\": [\n \"name\",\n \"due_date\",\n \"description\",\n \"multiple_owners\",\n \"owners\",\n \"color\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"multiple_owners\": {\n \"type\": \"boolean\"\n },\n \"owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"Array of user IDs.\"\n },\n \"color\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Goal Name\",\n \"due_date\": 1568036964079,\n \"description\": \"Goal Description\",\n \"multiple_owners\": true,\n \"owners\": [\n 183\n ],\n \"color\": \"#32a852\"\n }\n ]\n },\n \"example\": {\n \"name\": \"Goal Name\",\n \"due_date\": 1568036964079,\n \"description\": \"Goal Description\",\n \"multiple_owners\": true,\n \"owners\": [\n 183\n ],\n \"color\": \"#32a852\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "GetGoal", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_goal_details", + "description": { + "tagline": "Retrieve detailed information about a specific goal including its targets.", + "detailed": "" + }, + "return_annotation": "Details of a specific goal and its targets.", + "arguments": [ + { + "name": "goal_identifier", + "alternative_names": [ + "goal_uuid", + "goal_id_number" + ], + "description": "The unique identifier (UUID) for the goal to retrieve details and targets.", + "endpoint_argument_name": "goal_id" + } + ] + }, + "method": "GET", + "path": "/v2/goal/{goal_id}", + "tags": [ + "Goals" + ], + "summary": "Get Goal", + "description": "View the details of a Goal including its Targets.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "goal_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "UpdateGoal", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_goal_details", + "description": { + "tagline": "Update goal details such as name, due date, and owners.", + "detailed": "Use this tool to rename a goal, set its due date, update its description, manage owners, or change its color in ClickUp." + }, + "return_annotation": "The updated details of the specified goal.", + "arguments": [ + { + "name": "goal_id", + "alternative_names": [ + "goal_identifier", + "target_goal_id" + ], + "description": "The unique identifier for the goal to be updated. This is a UUID.", + "endpoint_argument_name": "goal_id" + }, + { + "name": "goal_name", + "alternative_names": [ + "goal_title", + "new_goal_name" + ], + "description": "The new name for the goal. This will replace the current goal name.", + "endpoint_argument_name": "name" + }, + { + "name": "goal_due_date", + "alternative_names": [ + "due_date_for_goal", + "goal_target_date" + ], + "description": "An integer representing the new due date for the goal, usually in Unix timestamp format.", + "endpoint_argument_name": "due_date" + }, + { + "name": "goal_description", + "alternative_names": [ + "goal_details", + "goal_summary" + ], + "description": "The new description for the goal. This should provide an overview or details of the goal's purpose.", + "endpoint_argument_name": "description" + }, + { + "name": "remove_owners_user_ids", + "alternative_names": [ + "delete_owners_user_ids", + "exclude_owners_ids" + ], + "description": "Array of user IDs to be removed as owners of the goal.", + "endpoint_argument_name": "rem_owners" + }, + { + "name": "new_owners_to_add", + "alternative_names": [ + "additional_owners", + "extra_owners" + ], + "description": "List of user IDs to add as new owners for the goal.", + "endpoint_argument_name": "add_owners" + }, + { + "name": "goal_color", + "alternative_names": [ + "goal_theme_color", + "objective_color" + ], + "description": "Set the color of the goal. Accepts a string representing the color, such as a hex code.", + "endpoint_argument_name": "color" + } + ] + }, + "method": "PUT", + "path": "/v2/goal/{goal_id}", + "tags": [ + "Goals" + ], + "summary": "Update Goal", + "description": "Rename a Goal, set the due date, replace the description, add or remove owners, and set the Goal color.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "goal_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "due_date", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + }, + { + "name": "description", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "rem_owners", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of user IDs." + }, + "description": "Array of user IDs.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "description": "Array of user IDs.", + "items": { + "type": "integer" + } + }, + "schema_required": true + }, + { + "name": "add_owners", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of user IDs." + }, + "description": "Array of user IDs.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "description": "Array of user IDs.", + "items": { + "type": "integer" + } + }, + "schema_required": true + }, + { + "name": "color", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateGoalrequest\",\n \"required\": [\n \"name\",\n \"due_date\",\n \"description\",\n \"rem_owners\",\n \"add_owners\",\n \"color\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"rem_owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"Array of user IDs.\"\n },\n \"add_owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"Array of user IDs.\"\n },\n \"color\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Goal Name\",\n \"due_date\": 1568036964079,\n \"description\": \"Updated Goal Description\",\n \"rem_owners\": [\n 183\n ],\n \"add_owners\": [\n 184\n ],\n \"color\": \"#32a852\"\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Goal Name\",\n \"due_date\": 1568036964079,\n \"description\": \"Updated Goal Description\",\n \"rem_owners\": [\n 183\n ],\n \"add_owners\": [\n 184\n ],\n \"color\": \"#32a852\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "DeleteGoal", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_goal", + "description": { + "tagline": "Deletes a goal from your workspace in ClickUp.", + "detailed": "Use this tool to remove a specified goal from your ClickUp workspace by providing the goal ID." + }, + "return_annotation": "Confirmation of goal deletion and status.", + "arguments": [ + { + "name": "goal_identifier", + "alternative_names": [ + "goal_id_number", + "goal_unique_id" + ], + "description": "The unique identifier for the goal to be deleted. It must be a valid UUID.", + "endpoint_argument_name": "goal_id" + }, + { + "name": "content_type_header", + "alternative_names": [ + "content_type", + "mime_type_header" + ], + "description": "Specify the Content-Type header. Typically set to 'application/json'.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "DELETE", + "path": "/v2/goal/{goal_id}", + "tags": [ + "Goals" + ], + "summary": "Delete Goal", + "description": "Remove a Goal from your Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "goal_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateKeyResult", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_target_to_goal", + "description": { + "tagline": "Add a target to a specific goal in ClickUp.", + "detailed": "Use this tool to add a key result target to an existing goal in ClickUp, enhancing goal tracking and achievement." + }, + "return_annotation": "Confirmation of the target addition to the goal.", + "arguments": [ + { + "name": "goal_identifier", + "alternative_names": [ + "goal_id_value", + "target_goal_id" + ], + "description": "The unique identifier (UUID) of the goal to which the target will be added.", + "endpoint_argument_name": "goal_id" + }, + { + "name": "target_name", + "alternative_names": [ + "goal_target_name", + "key_result_name" + ], + "description": "Specify the name for the target being added to the goal. It should be a descriptive label for easy identification.", + "endpoint_argument_name": "name" + }, + { + "name": "target_owners_ids", + "alternative_names": [ + "goal_target_owners", + "key_result_owners" + ], + "description": "An array of user IDs representing the owners of the key result target.", + "endpoint_argument_name": "owners" + }, + { + "name": "target_type", + "alternative_names": [ + "key_result_type", + "goal_target_type" + ], + "description": "Specify the type of target (key result) as one of the following: `number`, `currency`, `boolean`, `percentage`, or `automatic`.", + "endpoint_argument_name": "type" + }, + { + "name": "initial_value_steps", + "alternative_names": [ + "starting_steps_value", + "beginning_steps_count" + ], + "description": "Specify the starting value for the target's progress steps, as an integer.", + "endpoint_argument_name": "steps_start" + }, + { + "name": "target_steps_end", + "alternative_names": [ + "end_value", + "final_target_steps" + ], + "description": "Specify the final value for the target steps. It indicates the goal completion threshold.", + "endpoint_argument_name": "steps_end" + }, + { + "name": "target_unit", + "alternative_names": [ + "measurement_unit", + "goal_unit" + ], + "description": "Specify the unit for the target if using types like number, currency, or percentage.", + "endpoint_argument_name": "unit" + }, + { + "name": "linked_task_ids", + "alternative_names": [ + "task_identifiers", + "task_reference_ids" + ], + "description": "An array of task IDs to associate the target with tasks.", + "endpoint_argument_name": "task_ids" + }, + { + "name": "list_ids", + "alternative_names": [ + "linked_list_ids", + "associated_list_ids" + ], + "description": "Array of List IDs to associate the target with multiple Lists.", + "endpoint_argument_name": "list_ids" + } + ] + }, + "method": "POST", + "path": "/v2/goal/{goal_id}/key_result", + "tags": [ + "Goals" + ], + "summary": "Create Key Result", + "description": "Add a Target to a Goal.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "goal_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "owners", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "description": "", + "items": { + "type": "integer" + } + }, + "schema_required": true + }, + { + "name": "type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`." + }, + "description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`." + }, + "schema_required": true + }, + { + "name": "steps_start", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + }, + { + "name": "steps_end", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + }, + { + "name": "unit", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "task_ids", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter an array of task IDs to link this target with one or more tasks." + }, + "description": "Enter an array of task IDs to link this target with one or more tasks.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "description": "Enter an array of task IDs to link this target with one or more tasks.", + "items": { + "type": "string" + } + }, + "schema_required": true + }, + { + "name": "list_ids", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter an array of List IDs to link this target with one or more Lists." + }, + "description": "Enter an array of List IDs to link this target with one or more Lists.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "description": "Enter an array of List IDs to link this target with one or more Lists.", + "items": { + "type": "string" + } + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateKeyResultrequest\",\n \"required\": [\n \"name\",\n \"owners\",\n \"type\",\n \"steps_start\",\n \"steps_end\",\n \"unit\",\n \"task_ids\",\n \"list_ids\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"type\": {\n \"description\": \"Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`.\",\n \"type\": \"string\"\n },\n \"steps_start\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"steps_end\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"unit\": {\n \"type\": \"string\"\n },\n \"task_ids\": {\n \"description\": \"Enter an array of task IDs to link this target with one or more tasks.\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"list_ids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Enter an array of List IDs to link this target with one or more Lists.\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Target Name\",\n \"owners\": [\n 183\n ],\n \"type\": \"number\",\n \"steps_start\": 0,\n \"steps_end\": 10,\n \"unit\": \"km\",\n \"task_ids\": [],\n \"list_ids\": []\n }\n ]\n },\n \"example\": {\n \"name\": \"New Key Result Name\",\n \"owners\": [\n 183\n ],\n \"type\": \"number\",\n \"steps_start\": 0,\n \"steps_end\": 10,\n \"unit\": \"km\",\n \"task_ids\": [],\n \"list_ids\": []\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "EditKeyResult", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_key_result_target", + "description": { + "tagline": "Update the target of a specific key result.", + "detailed": "Use this tool to update the target value of a specified key result. It should be called when there's a need to modify the target associated with a key result in ClickUp." + }, + "return_annotation": "Returns confirmation of the target update operation.", + "arguments": [ + { + "name": "key_result_identifier", + "alternative_names": [ + "key_result_uuid", + "key_result_reference" + ], + "description": "Unique identifier for the key result to be updated, provided as a UUID.", + "endpoint_argument_name": "key_result_id" + }, + { + "name": "current_steps_value", + "alternative_names": [ + "steps_current_value", + "current_steps_count" + ], + "description": "The current number of steps completed for the key result target. Provide an integer value.", + "endpoint_argument_name": "steps_current" + }, + { + "name": "note_update_description", + "alternative_names": [ + "key_result_note", + "update_note_content" + ], + "description": "Text for the note associated with the key result. Use to add or update content related to the key result.", + "endpoint_argument_name": "note" + } + ] + }, + "method": "PUT", + "path": "/v2/key_result/{key_result_id}", + "tags": [ + "Goals" + ], + "summary": "Edit Key Result", + "description": "Update a Target.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "key_result_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "8480-49bc-8c57-e569747efe93 (uuid)" + }, + "description": "8480-49bc-8c57-e569747efe93 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "steps_current", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + }, + { + "name": "note", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"All properties available in the Create Key Result endpoint may also be used along with the additional properties below.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditKeyResultrequest\",\n \"required\": [\n \"steps_current\",\n \"note\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"steps_current\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"note\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"steps_current\": 5,\n \"note\": \"Target achieved\"\n }\n ]\n },\n \"example\": {\n \"steps_current\": 5,\n \"note\": \"Target achieved\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "DeleteKeyResult", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_goal_target", + "description": { + "tagline": "Delete a target from a goal in ClickUp.", + "detailed": "Use this tool to delete a key result (target) from a goal in ClickUp when a specific target needs to be removed." + }, + "return_annotation": "Confirmation of target deletion from a goal.", + "arguments": [ + { + "name": "goal_target_id", + "alternative_names": [ + "key_result_identifier", + "goal_result_id" + ], + "description": "The unique identifier (UUID) of the key result to delete from the goal in ClickUp.", + "endpoint_argument_name": "key_result_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/key_result/{key_result_id}", + "tags": [ + "Goals" + ], + "summary": "Delete Key Result", + "description": "Delete a target from a Goal.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "key_result_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "8480-49bc-8c57-e569747efe93 (uuid)" + }, + "description": "8480-49bc-8c57-e569747efe93 (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "InviteGuestToWorkspace", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "invite_guest_to_workspace", + "description": { + "tagline": "Invite a guest to join a ClickUp workspace.", + "detailed": "This tool is used to invite a guest to a ClickUp workspace on an Enterprise Plan. Ensure the guest has access to specific items in the workspace using additional endpoints." + }, + "return_annotation": "Confirmation of guest invitation to a workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The integer ID of the Workspace to which the guest will be invited.", + "endpoint_argument_name": "team_id" + }, + { + "name": "guest_email", + "alternative_names": [ + "invitee_email", + "workspace_guest_email" + ], + "description": "The email address of the guest to be invited to the workspace. Ensure it is correctly formatted.", + "endpoint_argument_name": "email" + }, + { + "name": "custom_role_id", + "alternative_names": [ + "role_id", + "user_role_id" + ], + "description": "The ID of the custom role to assign to the guest. Must be an integer value.", + "endpoint_argument_name": "custom_role_id" + }, + { + "name": "allow_tag_editing", + "alternative_names": [ + "enable_tag_editing", + "tag_edit_permission" + ], + "description": "Set to true if the guest should be allowed to edit tags in the workspace.", + "endpoint_argument_name": "can_edit_tags" + }, + { + "name": "allow_view_time_spent", + "alternative_names": [ + "permit_time_spent_view", + "enable_time_spent_visibility" + ], + "description": "Allow the guest to view time spent in the workspace. Accepts a boolean value: true to allow, false to deny.", + "endpoint_argument_name": "can_see_time_spent" + }, + { + "name": "can_view_estimated_times", + "alternative_names": [ + "enable_estimated_time_view", + "allow_estimated_times_access" + ], + "description": "Set to true to allow the guest to view estimated times for tasks.", + "endpoint_argument_name": "can_see_time_estimated" + }, + { + "name": "allow_guest_to_create_views", + "alternative_names": [ + "permit_view_creation_for_guest", + "enable_guest_view_creation" + ], + "description": "Indicates if the guest can create views in the workspace. Accepts a boolean value.", + "endpoint_argument_name": "can_create_views" + }, + { + "name": "can_view_points_estimated", + "alternative_names": [ + "allow_points_view", + "enable_points_visibility" + ], + "description": "Set to true to allow the guest to view estimated points for tasks.", + "endpoint_argument_name": "can_see_points_estimated" + } + ] + }, + "method": "POST", + "path": "/v2/team/{team_id}/guest", + "tags": [ + "Guests" + ], + "summary": "Invite Guest To Workspace", + "description": "Invite a guest to join a Workspace. To invite a member to your Workspace, use the [Invite User to Workspace](ref:inviteusertoworkspace) endpoint. \\\n \\\nYou'll also need to grant the guest access to specific items using the following endpoints: [Add Guest to Folder](ref:addguesttofolder), [Add Guest to List](ref:addguesttolist), or [Add Guest to Task](ref:addguesttotask). \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "email", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "can_edit_tags", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "can_see_time_spent", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "can_see_time_estimated", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "can_create_views", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "can_see_points_estimated", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "custom_role_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"InviteGuestToWorkspacerequest\",\n \"required\": [\n \"email\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"email\": {\n \"type\": \"string\"\n },\n \"can_edit_tags\": {\n \"type\": \"boolean\"\n },\n \"can_see_time_spent\": {\n \"type\": \"boolean\"\n },\n \"can_see_time_estimated\": {\n \"type\": \"boolean\"\n },\n \"can_create_views\": {\n \"type\": \"boolean\"\n },\n \"can_see_points_estimated\": {\n \"type\": \"boolean\"\n },\n \"custom_role_id\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"email\": \"guest@example.com\",\n \"can_edit_tags\": true,\n \"can_see_time_spent\": true,\n \"can_see_time_estimated\": true,\n \"can_create_views\": true,\n \"can_see_points_estimated\": true,\n \"custom_role_id\": 12345\n }\n ]\n },\n \"example\": {\n \"email\": \"guest@example.com\",\n \"can_edit_tags\": true,\n \"can_see_time_spent\": true,\n \"can_see_time_estimated\": true,\n \"can_create_views\": true,\n \"custom_role_id\": 12345\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "GetGuest", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_guest_information", + "description": { + "tagline": "Retrieve information about a guest in a workspace.", + "detailed": "This tool is used to view details about a guest in a ClickUp workspace. It is available only for Workspaces on the Enterprise Plan. Use it when you need to obtain guest-related information, such as profile or access details." + }, + "return_annotation": "Information about a specific guest.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the ClickUp workspace. This is required for identifying the specific workspace where the guest information is being retrieved.", + "endpoint_argument_name": "team_id" + }, + { + "name": "guest_identifier", + "alternative_names": [ + "guest_id_number", + "visitor_id" + ], + "description": "An integer representing the unique ID of the guest whose information is to be retrieved.", + "endpoint_argument_name": "guest_id" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/guest/{guest_id}", + "tags": [ + "Guests" + ], + "summary": "Get Guest", + "description": "View information about a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "guest_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "EditGuestOnWorkspace", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "configure_workspace_guest", + "description": { + "tagline": "Configure options for a guest in a workspace.", + "detailed": "This tool adjusts settings for a guest in a ClickUp workspace, specifically for teams on the Enterprise Plan." + }, + "return_annotation": "Information about the updated guest configuration.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "project_team_id" + ], + "description": "The unique identifier for the ClickUp workspace where the guest is being configured. This is required for identifying the specific workspace.", + "endpoint_argument_name": "team_id" + }, + { + "name": "guest_identifier", + "alternative_names": [ + "guest_id_number", + "workspace_guest_id" + ], + "description": "The unique identifier for the guest to be configured in the workspace.", + "endpoint_argument_name": "guest_id" + }, + { + "name": "guest_custom_role_id", + "alternative_names": [ + "workspace_guest_role_id", + "custom_role_identifier" + ], + "description": "An integer representing the custom role ID assigned to the guest in the workspace.", + "endpoint_argument_name": "custom_role_id" + }, + { + "name": "allow_viewing_points_estimated", + "alternative_names": [ + "permit_viewing_points_estimated", + "enable_points_estimated_view" + ], + "description": "Specify if the guest can view estimated points in the workspace. True allows viewing; false restricts it.", + "endpoint_argument_name": "can_see_points_estimated" + }, + { + "name": "allow_guest_to_edit_tags", + "alternative_names": [ + "permit_tag_editing_for_guest", + "enable_guest_tag_modification" + ], + "description": "Set to true to allow the guest to edit tags in the workspace; false to disallow.", + "endpoint_argument_name": "can_edit_tags" + }, + { + "name": "allow_viewing_time_spent", + "alternative_names": [ + "enable_time_spent_visibility", + "set_time_spent_access" + ], + "description": "Set to true to allow the guest to view time spent on tasks, false to restrict.", + "endpoint_argument_name": "can_see_time_spent" + }, + { + "name": "can_see_time_estimates", + "alternative_names": [ + "allow_time_estimate_view", + "enable_time_estimate_visibility" + ], + "description": "Determines if the guest can view time estimates. Use true to allow, false to restrict.", + "endpoint_argument_name": "can_see_time_estimated" + }, + { + "name": "allow_view_creation", + "alternative_names": [ + "permit_view_creation", + "enable_view_creation" + ], + "description": "A boolean to specify if the guest can create views. True allows view creation, false denies it.", + "endpoint_argument_name": "can_create_views" + } + ] + }, + "method": "PUT", + "path": "/v2/team/{team_id}/guest/{guest_id}", + "tags": [ + "Guests" + ], + "summary": "Edit Guest On Workspace", + "description": "Configure options for a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "guest_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "can_see_points_estimated", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "can_edit_tags", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "can_see_time_spent", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "can_see_time_estimated", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "can_create_views", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "custom_role_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditGuestOnWorkspacerequest\",\n \"type\": \"object\",\n \"properties\": {\n \"can_see_points_estimated\": {\n \"type\": \"boolean\"\n },\n \"can_edit_tags\": {\n \"type\": \"boolean\"\n },\n \"can_see_time_spent\": {\n \"type\": \"boolean\"\n },\n \"can_see_time_estimated\": {\n \"type\": \"boolean\"\n },\n \"can_create_views\": {\n \"type\": \"boolean\"\n },\n \"custom_role_id\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"can_see_points_estimated\": true,\n \"can_edit_tags\": true,\n \"can_see_time_spent\": true,\n \"can_see_time_estimated\": true,\n \"can_create_views\": true,\n \"custom_role_id\": 12345\n }\n ]\n },\n \"example\": {\n \"can_edit_tags\": true,\n \"can_see_time_spent\": true,\n \"can_see_time_estimated\": true,\n \"can_see_points_estimated\": true,\n \"can_create_views\": true,\n \"custom_role_id\": 12345\n }\n }\n },\n \"required\": false\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "RemoveGuestFromWorkspace", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_guest_from_workspace", + "description": { + "tagline": "Revoke a guest's access to a ClickUp workspace.", + "detailed": "Remove a guest from a ClickUp workspace. Available only for Workspaces on the Enterprise Plan." + }, + "return_annotation": "Confirmation of guest removal from workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The unique ID of the ClickUp workspace from which the guest will be removed. This is an integer.", + "endpoint_argument_name": "team_id" + }, + { + "name": "guest_id", + "alternative_names": [ + "workspace_guest_id", + "external_user_id" + ], + "description": "The unique identifier for the guest to be removed from the workspace. This should be an integer value.", + "endpoint_argument_name": "guest_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/team/{team_id}/guest/{guest_id}", + "tags": [ + "Guests" + ], + "summary": "Remove Guest From Workspace", + "description": "Revoke a guest's access to a Workspace. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "guest_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "AddGuestToTask", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "share_task_with_guest", + "description": { + "tagline": "Share a task with a guest in the ClickUp Workspace.", + "detailed": "This tool shares a specified task with a guest, available only on ClickUp's Enterprise Plan." + }, + "return_annotation": "Confirmation of task sharing with a guest.", + "arguments": [ + { + "name": "task_id", + "alternative_names": [ + "task_identifier", + "task_reference" + ], + "description": "The unique identifier for the task to share with the guest.", + "endpoint_argument_name": "task_id" + }, + { + "name": "guest_id", + "alternative_names": [ + "guest_identifier", + "guest_user_id" + ], + "description": "The unique identifier for the guest to share the task with.", + "endpoint_argument_name": "guest_id" + }, + { + "name": "guest_permission_level", + "alternative_names": [ + "task_guest_permission", + "permission_level_for_guest" + ], + "description": "Defines the level of access for the guest. Options: 'read', 'comment', 'edit', 'create'.", + "endpoint_argument_name": "permission_level" + }, + { + "name": "workspace_id_when_custom_task_ids_enabled", + "alternative_names": [ + "team_id_for_custom_task_ids", + "workspace_id_if_custom_ids_true" + ], + "description": "Provide the Workspace ID when referencing tasks by custom task IDs. Required if `custom_task_ids` is `true`.", + "endpoint_argument_name": "team_id" + }, + { + "name": "include_shared_details", + "alternative_names": [ + "show_shared_details", + "display_shared_items" + ], + "description": "Set to `true` to include details of items shared with the guest. Defaults to `true`.", + "endpoint_argument_name": "include_shared" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "reference_custom_task_ids", + "enable_custom_task_ids" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "POST", + "path": "/v2/task/{task_id}/guest/{guest_id}", + "tags": [ + "Guests" + ], + "summary": "Add Guest To Task", + "description": "Share a task with a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "include_shared", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "guest_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "permission_level", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"AddGuestToTaskrequest\",\n \"required\": [\n \"permission_level\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"permission_level\": {\n \"description\": \"Can be `read` (view only), `comment`, `edit`, or `create` (full).\",\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"permission_level\": \"read\"\n }\n ]\n },\n \"example\": {\n \"permission_level\": \"read\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "RemoveGuestFromTask", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_guest_from_task", + "description": { + "tagline": "Revoke a guest's access to a specific task in ClickUp.", + "detailed": "Use this tool to remove a guest from a task in ClickUp. This action is available only for Workspaces on the Enterprise Plan." + }, + "return_annotation": "Confirmation of guest removal from task.", + "arguments": [ + { + "name": "task_id", + "alternative_names": [ + "task_identifier", + "task_reference_id" + ], + "description": "The unique identifier of the task from which the guest's access should be revoked. This is required to specify the task.", + "endpoint_argument_name": "task_id" + }, + { + "name": "guest_id", + "alternative_names": [ + "guest_identifier", + "guest_user_id" + ], + "description": "The ID of the guest to remove from the task. This is a required integer value.", + "endpoint_argument_name": "guest_id" + }, + { + "name": "workspace_id_for_custom_task", + "alternative_names": [ + "workspace_id_for_task", + "workspace_identifier" + ], + "description": "Provide the Workspace ID when referencing a task by its custom task ID. This is required if 'custom_task_ids' is set to 'true'.", + "endpoint_argument_name": "team_id" + }, + { + "name": "include_shared_details", + "alternative_names": [ + "include_shared_info", + "include_shared_items" + ], + "description": "Set to `true` to include details of items shared with the guest. Default is `true`.", + "endpoint_argument_name": "include_shared" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_task_ids", + "set_custom_task_ids" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "DELETE", + "path": "/v2/task/{task_id}/guest/{guest_id}", + "tags": [ + "Guests" + ], + "summary": "Remove Guest From Task", + "description": "Revoke a guest's access to a task. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "include_shared", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "guest_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "AddGuestToList", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_guest_to_list", + "description": { + "tagline": "Add a guest to a specific list in ClickUp.", + "detailed": "This tool adds a guest to a list within ClickUp, available only for Enterprise Plan workspaces." + }, + "return_annotation": "Confirmation of guest added to the list.", + "arguments": [ + { + "name": "list_id", + "alternative_names": [ + "target_list_id", + "destination_list_id" + ], + "description": "The identifier of the list to which the guest will be added.", + "endpoint_argument_name": "list_id" + }, + { + "name": "guest_id", + "alternative_names": [ + "invitee_id", + "external_user_id" + ], + "description": "The unique identifier for the guest to be added. This should be an integer value.", + "endpoint_argument_name": "guest_id" + }, + { + "name": "guest_permission_level", + "alternative_names": [ + "guest_access_level", + "list_permission_level" + ], + "description": "Permission level for the guest on the list. Options are `read`, `comment`, `edit`, or `create`.", + "endpoint_argument_name": "permission_level" + }, + { + "name": "include_shared_details", + "alternative_names": [ + "exclude_shared_details", + "share_item_details" + ], + "description": "Set to false to exclude shared item details from the guest view; defaults to true to include them.", + "endpoint_argument_name": "include_shared" + } + ] + }, + "method": "POST", + "path": "/v2/list/{list_id}/guest/{guest_id}", + "tags": [ + "Guests" + ], + "summary": "Add Guest To List", + "description": "Share a List with a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "include_shared", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "guest_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "permission_level", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"AddGuestToListrequest\",\n \"required\": [\n \"permission_level\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"permission_level\": {\n \"description\": \"Can be `read` (view only), `comment`, `edit`, or `create` (full).\",\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"permission_level\": \"read\"\n }\n ]\n },\n \"example\": {\n \"permission_level\": \"read\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "RemoveGuestFromList", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_guest_from_list", + "description": { + "tagline": "Revoke a guest's access to a specific list in ClickUp.", + "detailed": "This tool removes a guest's access from a specified list within ClickUp. It is available only for Workspaces on the Enterprise Plan." + }, + "return_annotation": "Confirmation of guest's access removal from the list.", + "arguments": [ + { + "name": "list_identifier", + "alternative_names": [ + "list_id_value", + "list_reference" + ], + "description": "The unique identifier for the list from which the guest's access will be revoked. This must be an integer.", + "endpoint_argument_name": "list_id" + }, + { + "name": "guest_user_id", + "alternative_names": [ + "guest_identifier", + "user_id_of_guest" + ], + "description": "The unique identifier of the guest whose access is to be revoked from the list.", + "endpoint_argument_name": "guest_id" + }, + { + "name": "include_shared_details", + "alternative_names": [ + "include_shared_items", + "share_item_details" + ], + "description": "Set to `true` to include details of items shared with the guest. Default is `true`.", + "endpoint_argument_name": "include_shared" + } + ] + }, + "method": "DELETE", + "path": "/v2/list/{list_id}/guest/{guest_id}", + "tags": [ + "Guests" + ], + "summary": "Remove Guest From List", + "description": "Revoke a guest's access to a List.\\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "include_shared", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "guest_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "AddGuestToFolder", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_guest_to_folder", + "description": { + "tagline": "Share a folder with a guest in ClickUp's Enterprise Plan.", + "detailed": "This tool shares a specific folder with a guest, available only for ClickUp Workspaces on the Enterprise Plan. Use it to collaborate by granting access to specified guests." + }, + "return_annotation": "Information about the shared folder with the guest.", + "arguments": [ + { + "name": "folder_id", + "alternative_names": [ + "folder_identifier", + "id_of_folder" + ], + "description": "The unique integer ID of the folder to be shared with the guest.", + "endpoint_argument_name": "folder_id" + }, + { + "name": "guest_identifier", + "alternative_names": [ + "guest_id_number", + "guest_key" + ], + "description": "The unique identifier for the guest to whom the folder will be shared. This should be an integer representing the guest's ID.", + "endpoint_argument_name": "guest_id" + }, + { + "name": "guest_permission_level", + "alternative_names": [ + "folder_sharing_permission", + "guest_access_level" + ], + "description": "Defines guest's access level: 'read' for view only, 'comment', 'edit', or 'create' for full access.", + "endpoint_argument_name": "permission_level" + }, + { + "name": "include_shared_items", + "alternative_names": [ + "show_shared_items", + "display_shared_items" + ], + "description": "Set to true to include details of items shared with the guest. Default is true.", + "endpoint_argument_name": "include_shared" + } + ] + }, + "method": "POST", + "path": "/v2/folder/{folder_id}/guest/{guest_id}", + "tags": [ + "Guests" + ], + "summary": "Add Guest To Folder", + "description": "Share a Folder with a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "include_shared", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "guest_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "permission_level", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"AddGuestToFolderrequest\",\n \"required\": [\n \"permission_level\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"permission_level\": {\n \"description\": \"Can be `read` (view only), `comment`, `edit`, or `create` (full).\",\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"permission_level\": \"read\"\n }\n ]\n },\n \"example\": {\n \"permission_level\": \"read\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "RemoveGuestFromFolder", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_guest_from_folder", + "description": { + "tagline": "Revoke a guest's access to a specified folder.", + "detailed": "Use this tool to remove a guest's access to a specific folder in ClickUp workspaces on the Enterprise Plan." + }, + "return_annotation": "Confirmation of guest removal from folder.", + "arguments": [ + { + "name": "folder_identifier", + "alternative_names": [ + "folder_id_key", + "folder_unique_id" + ], + "description": "The unique identifier for the folder from which the guest's access should be revoked. This ID is essential to specify the exact folder within the ClickUp workspace.", + "endpoint_argument_name": "folder_id" + }, + { + "name": "guest_identifier", + "alternative_names": [ + "guest_id_number", + "access_guest_id" + ], + "description": "The unique numeric ID of the guest to be removed from the folder. This is required to identify which guest's access is being revoked.", + "endpoint_argument_name": "guest_id" + }, + { + "name": "include_shared_items", + "alternative_names": [ + "show_shared_details", + "display_shared_info" + ], + "description": "Set to true to include details of items shared with the guest. Defaults to true.", + "endpoint_argument_name": "include_shared" + } + ] + }, + "method": "DELETE", + "path": "/v2/folder/{folder_id}/guest/{guest_id}", + "tags": [ + "Guests" + ], + "summary": "Remove Guest From Folder", + "description": "Revoke a guest's access to a Folder. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "include_shared", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "guest_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetLists", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_lists_in_folder", + "description": { + "tagline": "Retrieve lists from a specific folder.", + "detailed": "Use this tool to view all the lists contained within a specified folder by providing the folder ID. It should be called when you need to access or manage lists within a folder within ClickUp." + }, + "return_annotation": "Lists available within a specified folder.", + "arguments": [ + { + "name": "folder_id", + "alternative_names": [ + "folder_identifier", + "id_of_folder" + ], + "description": "The unique identifier for the folder whose lists are to be retrieved. This is required to specify which folder's lists to view.", + "endpoint_argument_name": "folder_id" + }, + { + "name": "include_archived_lists", + "alternative_names": [ + "show_archived_lists", + "display_archived_lists" + ], + "description": "Specify whether to include archived lists. Set to true to include and false to exclude.", + "endpoint_argument_name": "archived" + } + ] + }, + "method": "GET", + "path": "/v2/folder/{folder_id}/list", + "tags": [ + "Lists" + ], + "summary": "Get Lists", + "description": "View the Lists within a Folder.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "archived", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateList", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_clickup_list", + "description": { + "tagline": "Create a new list in a ClickUp folder.", + "detailed": "Use this tool to add a new list to a specified folder in ClickUp. Ideal for organizing tasks or projects within a folder." + }, + "return_annotation": "Confirmation of the new list creation in a folder.", + "arguments": [ + { + "name": "folder_id", + "alternative_names": [ + "target_folder_id", + "destination_folder_id" + ], + "description": "The unique integer identifier for the folder where the new list will be added.", + "endpoint_argument_name": "folder_id" + }, + { + "name": "list_name", + "alternative_names": [ + "list_title", + "name_of_list" + ], + "description": "The name of the new list to be created within the specified ClickUp folder.", + "endpoint_argument_name": "name" + }, + { + "name": "list_description", + "alternative_names": [ + "list_content", + "description_text" + ], + "description": "A plain text description for the list. Use this to provide details about the list's purpose.", + "endpoint_argument_name": "content" + }, + { + "name": "formatted_list_description", + "alternative_names": [ + "markdown_list_content", + "styled_list_description" + ], + "description": "Provide a markdown-formatted description for the List. Use this instead of plain text content.", + "endpoint_argument_name": "markdown_content" + }, + { + "name": "due_date_timestamp", + "alternative_names": [ + "list_due_date", + "deadline_timestamp" + ], + "description": "The due date for the list in Unix timestamp format. Determines when the list should be completed.", + "endpoint_argument_name": "due_date" + }, + { + "name": "list_priority", + "alternative_names": [ + "priority_level", + "task_list_priority" + ], + "description": "An integer value indicating the priority of the list, where a higher number typically means higher priority.", + "endpoint_argument_name": "priority" + }, + { + "name": "list_assignee_user_id", + "alternative_names": [ + "list_responsible_user_id", + "list_assignment_user_id" + ], + "description": "The user ID to assign this list to a specific user. This identifies who will be responsible for the list.", + "endpoint_argument_name": "assignee" + }, + { + "name": "list_color", + "alternative_names": [ + "color_status", + "list_status_color" + ], + "description": "Specifies the color of the List, not related to task statuses.", + "endpoint_argument_name": "status" + }, + { + "name": "include_time_in_due_date", + "alternative_names": [ + "due_date_with_time", + "time_in_due_date" + ], + "description": "Set to true to include a specific time with the due date.", + "endpoint_argument_name": "due_date_time" + } + ] + }, + "method": "POST", + "path": "/v2/folder/{folder_id}/list", + "tags": [ + "Lists" + ], + "summary": "Create List", + "description": "Add a new List to a Folder.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "content", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "markdown_content", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "description": "Use `markdown_content` instead of `content` to format your List description.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "schema_required": false + }, + { + "name": "due_date", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "due_date_time", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "priority", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "assignee", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include a `user_id` to assign this List." + }, + "description": "Include a `user_id` to assign this List.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer", + "description": "Include a `user_id` to assign this List." + }, + "schema_required": false + }, + { + "name": "status", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "description": "**Status** refers to the List color rather than the task Statuses available in the List.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateListrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"content\": {\n \"type\": \"string\"\n },\n \"markdown_content\": {\n \"type\": \"string\",\n \"description\": \"Use `markdown_content` instead of `content` to format your List description.\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"due_date_time\": {\n \"type\": \"boolean\"\n },\n \"priority\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"assignee\": {\n \"description\": \"Include a `user_id` to assign this List.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"status\": {\n \"description\": \"**Status** refers to the List color rather than the task Statuses available in the List.\",\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New List Name\",\n \"content\": \"New List Content\",\n \"markdown_content\": \"# This is markdown\\n ***bold and italicized text***\",\n \"due_date\": 1567780450202,\n \"due_date_time\": false,\n \"priority\": 1,\n \"assignee\": 183,\n \"status\": \"red\"\n }\n ]\n },\n \"example\": {\n \"name\": \"New List Name\",\n \"content\": \"New List Content\",\n \"markdown_content\": \"# This is markdown\\n ***bold and italicized text***\",\n \"due_date\": 1567780450202,\n \"due_date_time\": false,\n \"priority\": 1,\n \"assignee\": 183,\n \"status\": \"red\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "CreateFolderFromTemplate", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_folder_from_template", + "description": { + "tagline": "Creates a new folder from a template in a ClickUp space.", + "detailed": "This tool creates a new folder using a predefined template within a specified ClickUp space. It can also incorporate nested assets like lists and tasks from the template into the new folder. Templates must be added to your Workspace before use. The operation can be executed asynchronously or synchronously." + }, + "return_annotation": "Details of the created folder from the template.", + "arguments": [ + { + "name": "clickup_space_id", + "alternative_names": [ + "space_identifier", + "folder_space_id" + ], + "description": "ID of the ClickUp Space where the folder will be created.", + "endpoint_argument_name": "space_id" + }, + { + "name": "folder_template_id", + "alternative_names": [ + "template_folder_id", + "use_template_id" + ], + "description": "The ID of the folder template to be used for creating a new folder in a ClickUp space. Ensure the template is added to your Workspace.", + "endpoint_argument_name": "template_id" + }, + { + "name": "folder_creation_options", + "alternative_names": [ + "folder_options", + "creation_parameters" + ], + "description": "JSON object containing name and options for creating the folder, including import settings and date remapping.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/space/{space_id}/folder_template/{template_id}", + "tags": [ + "Folders" + ], + "summary": "Create Folder from template", + "description": "Create a new Folder using a Folder template within a Space. This endpoint allows you to create a folder with all its nested assets (lists, tasks, etc.) from a predefined template available in your Workspace. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\nThis request can be run asynchronously or synchronously via the `return_immediately` parameter.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Space where the Folder will be created" + }, + "description": "ID of the Space where the Folder will be created", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "template_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Folder template to use." + }, + "description": "ID of the Folder template to use.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Name of the new Folder" + }, + "options": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "return_immediately": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n" + }, + "content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "List description" + }, + "time_estimate": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include time (hours, minutes and seconds)" + }, + "automation": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import automation options" + }, + "include_views": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import views" + }, + "old_due_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks due dates" + }, + "old_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks start dates" + }, + "old_followers": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks watchers" + }, + "comment_attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks comment attachments" + }, + "recur_settings": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks recurring settings" + }, + "old_tags": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks tags" + }, + "old_statuses": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks status settings" + }, + "subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks subtasks" + }, + "custom_type": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks types" + }, + "old_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks assignees" + }, + "attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks attachments" + }, + "comment": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks comments" + }, + "old_status": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks current statuses" + }, + "external_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks external dependencies" + }, + "internal_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks internal dependencies" + }, + "priority": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks priority" + }, + "custom_fields": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks Custom Fields" + }, + "old_checklists": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks checklists" + }, + "relationships": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks relationships" + }, + "old_subtask_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks subtasks and assignees combination" + }, + "start_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project start date for remapping dates" + }, + "due_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project due date for remapping dates" + }, + "remap_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Remap start dates" + }, + "skip_weekends": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Skip weekends when remapping dates" + }, + "archived": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "1", + "2", + "None" + ], + "properties": null, + "inner_properties": null, + "description": "Include archived tasks (1 or 2 or null)" + } + }, + "inner_properties": null, + "description": "Options for creating the Folder" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the new Folder" + }, + "options": { + "type": "object", + "description": "Options for creating the Folder", + "properties": { + "return_immediately": { + "type": "boolean", + "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n" + }, + "content": { + "type": "string", + "description": "List description" + }, + "time_estimate": { + "type": "boolean", + "description": "Include time (hours, minutes and seconds)" + }, + "automation": { + "type": "boolean", + "description": "Import automation options" + }, + "include_views": { + "type": "boolean", + "description": "Import views" + }, + "old_due_date": { + "type": "boolean", + "description": "Import tasks due dates" + }, + "old_start_date": { + "type": "boolean", + "description": "Import tasks start dates" + }, + "old_followers": { + "type": "boolean", + "description": "Import tasks watchers" + }, + "comment_attachments": { + "type": "boolean", + "description": "Import tasks comment attachments" + }, + "recur_settings": { + "type": "boolean", + "description": "Import tasks recurring settings" + }, + "old_tags": { + "type": "boolean", + "description": "Import tasks tags" + }, + "old_statuses": { + "type": "boolean", + "description": "Import tasks status settings" + }, + "subtasks": { + "type": "boolean", + "description": "Import tasks subtasks" + }, + "custom_type": { + "type": "boolean", + "description": "Import tasks types" + }, + "old_assignees": { + "type": "boolean", + "description": "Import tasks assignees" + }, + "attachments": { + "type": "boolean", + "description": "Import tasks attachments" + }, + "comment": { + "type": "boolean", + "description": "Import tasks comments" + }, + "old_status": { + "type": "boolean", + "description": "Import tasks current statuses" + }, + "external_dependencies": { + "type": "boolean", + "description": "Import tasks external dependencies" + }, + "internal_dependencies": { + "type": "boolean", + "description": "Import tasks internal dependencies" + }, + "priority": { + "type": "boolean", + "description": "Import tasks priority" + }, + "custom_fields": { + "type": "boolean", + "description": "Import tasks Custom Fields" + }, + "old_checklists": { + "type": "boolean", + "description": "Import tasks checklists" + }, + "relationships": { + "type": "boolean", + "description": "Import tasks relationships" + }, + "old_subtask_assignees": { + "type": "boolean", + "description": "Import tasks subtasks and assignees combination" + }, + "start_date": { + "type": "string", + "description": "Project start date for remapping dates", + "format": "date-time" + }, + "due_date": { + "type": "string", + "description": "Project due date for remapping dates", + "format": "date-time" + }, + "remap_start_date": { + "type": "boolean", + "description": "Remap start dates" + }, + "skip_weekends": { + "type": "boolean", + "description": "Skip weekends when remapping dates" + }, + "archived": { + "type": "integer", + "description": "Include archived tasks (1 or 2 or null)", + "enum": [ + 1, + 2, + null + ] + } + } + } + }, + "required": [ + "name" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"name\"\n ],\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the new Folder\"\n },\n \"options\": {\n \"type\": \"object\",\n \"description\": \"Options for creating the Folder\",\n \"properties\": {\n \"return_immediately\": {\n \"type\": \"boolean\",\n \"description\": \"Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\\n\",\n \"default\": true\n },\n \"content\": {\n \"type\": \"string\",\n \"description\": \"List description\"\n },\n \"time_estimate\": {\n \"type\": \"boolean\",\n \"description\": \"Include time (hours, minutes and seconds)\"\n },\n \"automation\": {\n \"type\": \"boolean\",\n \"description\": \"Import automation options\"\n },\n \"include_views\": {\n \"type\": \"boolean\",\n \"description\": \"Import views\"\n },\n \"old_due_date\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks due dates\"\n },\n \"old_start_date\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks start dates\"\n },\n \"old_followers\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks watchers\"\n },\n \"comment_attachments\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks comment attachments\"\n },\n \"recur_settings\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks recurring settings\"\n },\n \"old_tags\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks tags\"\n },\n \"old_statuses\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks status settings\"\n },\n \"subtasks\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks subtasks\"\n },\n \"custom_type\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks types\"\n },\n \"old_assignees\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks assignees\"\n },\n \"attachments\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks attachments\"\n },\n \"comment\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks comments\"\n },\n \"old_status\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks current statuses\"\n },\n \"external_dependencies\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks external dependencies\"\n },\n \"internal_dependencies\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks internal dependencies\"\n },\n \"priority\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks priority\"\n },\n \"custom_fields\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks Custom Fields\"\n },\n \"old_checklists\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks checklists\"\n },\n \"relationships\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks relationships\"\n },\n \"old_subtask_assignees\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks subtasks and assignees combination\"\n },\n \"start_date\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"Project start date for remapping dates\"\n },\n \"due_date\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"Project due date for remapping dates\"\n },\n \"remap_start_date\": {\n \"type\": \"boolean\",\n \"description\": \"Remap start dates\"\n },\n \"skip_weekends\": {\n \"type\": \"boolean\",\n \"description\": \"Skip weekends when remapping dates\"\n },\n \"archived\": {\n \"type\": \"integer\",\n \"enum\": [\n 1,\n 2,\n null\n ],\n \"description\": \"Include archived tasks (1 or 2 or null)\"\n }\n }\n }\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "GetFolderlessLists", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_folderless_lists", + "description": { + "tagline": "View Lists in a Space not located in a Folder.", + "detailed": "Use this tool to retrieve lists within a specified space that are not contained within any folder, providing an organized view of unassigned lists." + }, + "return_annotation": "Lists in a space not located in a folder.", + "arguments": [ + { + "name": "space_identifier", + "alternative_names": [ + "space_id_number", + "space_reference" + ], + "description": "The unique identifier of the space to retrieve the folderless lists from. It should be an integer.", + "endpoint_argument_name": "space_id" + }, + { + "name": "include_archived_lists", + "alternative_names": [ + "show_archived_lists", + "return_archived_lists" + ], + "description": "Specify true to include archived lists, or false to exclude them.", + "endpoint_argument_name": "archived" + } + ] + }, + "method": "GET", + "path": "/v2/space/{space_id}/list", + "tags": [ + "Lists" + ], + "summary": "Get Folderless Lists", + "description": "View the Lists in a Space that aren't located in a Folder.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "archived", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateFolderlessList", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_folderless_list_to_space", + "description": { + "tagline": "Add a new folderless list to a specified space.", + "detailed": "This tool is used to create a new list within a specified space in ClickUp without associating it with a folder. It facilitates the organization of tasks directly within the space." + }, + "return_annotation": "Information about the newly created list.", + "arguments": [ + { + "name": "space_id", + "alternative_names": [ + "space_identifier", + "id_of_space" + ], + "description": "The unique identifier of the space where the list will be added.", + "endpoint_argument_name": "space_id" + }, + { + "name": "list_name", + "alternative_names": [ + "new_list_name", + "space_list_name" + ], + "description": "The name of the new list to be created within the space.", + "endpoint_argument_name": "name" + }, + { + "name": "list_description", + "alternative_names": [ + "description_content", + "details" + ], + "description": "A text description for the new list. Use plain text. For markdown, use `markdown_content`.", + "endpoint_argument_name": "content" + }, + { + "name": "list_markdown_description", + "alternative_names": [ + "markdown_list_content", + "formatted_list_description" + ], + "description": "Markdown formatted description for the list. Use this instead of a plain text description.", + "endpoint_argument_name": "markdown_content" + }, + { + "name": "due_date_timestamp", + "alternative_names": [ + "list_due_date_timestamp", + "timestamp_due_date" + ], + "description": "An integer representing the UNIX timestamp for the list's due date. This defines the deadline for the list.", + "endpoint_argument_name": "due_date" + }, + { + "name": "list_priority_level", + "alternative_names": [ + "priority_level", + "list_urgency_level" + ], + "description": "Set the priority level for the list. It should be an integer value indicating the list's urgency or importance.", + "endpoint_argument_name": "priority" + }, + { + "name": "list_owner_user_id", + "alternative_names": [ + "owner_id", + "user_id" + ], + "description": "The user ID for the list owner to be assigned to the new list.", + "endpoint_argument_name": "assignee" + }, + { + "name": "list_color_status", + "alternative_names": [ + "list_theme_color", + "list_visual_status" + ], + "description": "Specifies the color representing the List. This is for visual identification and does not affect task statuses.", + "endpoint_argument_name": "status" + }, + { + "name": "include_due_time", + "alternative_names": [ + "use_due_time", + "set_due_time" + ], + "description": "Set to true if the due date should include a specific time.", + "endpoint_argument_name": "due_date_time" + } + ] + }, + "method": "POST", + "path": "/v2/space/{space_id}/list", + "tags": [ + "Lists" + ], + "summary": "Create Folderless List", + "description": "Add a new List in a Space.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "content", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "markdown_content", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "description": "Use `markdown_content` instead of `content` to format your List description.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "schema_required": false + }, + { + "name": "due_date", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "due_date_time", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "priority", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "assignee", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include a `user_id` to add a List owner." + }, + "description": "Include a `user_id` to add a List owner.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer", + "description": "Include a `user_id` to add a List owner." + }, + "schema_required": false + }, + { + "name": "status", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "description": "**Status** refers to the List color rather than the task Statuses available in the List.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateFolderlessListrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"content\": {\n \"type\": \"string\"\n },\n \"markdown_content\": {\n \"type\": \"string\",\n \"description\": \"Use `markdown_content` instead of `content` to format your List description.\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"due_date_time\": {\n \"type\": \"boolean\"\n },\n \"priority\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"assignee\": {\n \"description\": \"Include a `user_id` to add a List owner.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"status\": {\n \"description\": \"**Status** refers to the List color rather than the task Statuses available in the List.\",\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New List Name\",\n \"content\": \"New List Content\",\n \"due_date\": 1567780450202,\n \"due_date_time\": false,\n \"priority\": 1,\n \"assignee\": 183,\n \"status\": \"red\"\n }\n ]\n },\n \"example\": {\n \"name\": \"New List Name\",\n \"content\": \"New List Content\",\n \"markdown_content\": \"# This is markdown\\n ***bold and italicized text***\",\n \"due_date\": 1567780450202,\n \"due_date_time\": false,\n \"priority\": 1,\n \"assignee\": 183,\n \"status\": \"red\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "GetList", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_list_details", + "description": { + "tagline": "Retrieve details of a specific list in ClickUp.", + "detailed": "Use this tool to get detailed information about a specific list in ClickUp by providing the list ID. It helps in obtaining metadata and current status of the list." + }, + "return_annotation": "Information about a specific list.", + "arguments": [ + { + "name": "list_id", + "alternative_names": [ + "list_identifier", + "list_number" + ], + "description": "The unique ID of the list to view details. Right-click the list in your ClickUp sidebar, select 'Copy link', and paste the URL's last string.", + "endpoint_argument_name": "list_id" + } + ] + }, + "method": "GET", + "path": "/v2/list/{list_id}", + "tags": [ + "Lists" + ], + "summary": "Get List", + "description": "View information about a List.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The List ID. To find the List ID, right-click the List in your Sidebar, select Copy link, and paste the link in your URL. The last string in the URL is your List ID." + }, + "description": "The List ID. To find the List ID, right-click the List in your Sidebar, select Copy link, and paste the link in your URL. The last string in the URL is your List ID.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "UpdateList", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_clickup_list", + "description": { + "tagline": "Update the details of a ClickUp list.", + "detailed": "Use this tool to rename a ClickUp list, update its description, set a due date or time, change the priority, assign someone, or modify the list color." + }, + "return_annotation": "Updated details of the ClickUp list.", + "arguments": [ + { + "name": "list_identifier", + "alternative_names": [ + "clickup_list_id", + "list_unique_id" + ], + "description": "The unique identifier of the ClickUp list to update. This is a required string field.", + "endpoint_argument_name": "list_id" + }, + { + "name": "list_name", + "alternative_names": [ + "list_title", + "list_label" + ], + "description": "The new name for the ClickUp list. This should be a string value.", + "endpoint_argument_name": "name" + }, + { + "name": "list_description_content", + "alternative_names": [ + "description_content", + "list_content" + ], + "description": "The plain text description to update for the ClickUp list. Use this instead of markdown for simple text updates.", + "endpoint_argument_name": "content" + }, + { + "name": "formatted_list_description", + "alternative_names": [ + "markdown_formatted_list_description", + "md_list_description" + ], + "description": "Formatted description of the list using Markdown syntax instead of plain text.", + "endpoint_argument_name": "markdown_content" + }, + { + "name": "list_due_date", + "alternative_names": [ + "due_date_integer", + "list_deadline" + ], + "description": "Set the list's due date as a Unix timestamp in milliseconds, representing the time the list is due.", + "endpoint_argument_name": "due_date" + }, + { + "name": "list_priority", + "alternative_names": [ + "priority_level", + "list_priority_level" + ], + "description": "Set the list's priority as an integer. Usually, 1 is high, 2 is medium, and 3 is low priority.", + "endpoint_argument_name": "priority" + }, + { + "name": "list_assignee_id", + "alternative_names": [ + "assigned_user_id", + "assignee_user_id" + ], + "description": "The ID of the user to assign to the list. Provide a valid user ID string.", + "endpoint_argument_name": "assignee" + }, + { + "name": "list_color", + "alternative_names": [ + "list_status_color", + "color_status" + ], + "description": "Specify the color of the list. This refers to the List color rather than task statuses.", + "endpoint_argument_name": "status" + }, + { + "name": "include_due_date_time", + "alternative_names": [ + "use_specific_due_time", + "set_due_time" + ], + "description": "Set to true to include a specific time with the due date.", + "endpoint_argument_name": "due_date_time" + }, + { + "name": "remove_list_color", + "alternative_names": [ + "unset_list_color", + "delete_list_color" + ], + "description": "Set to `true` to remove the List color; default is `false`.", + "endpoint_argument_name": "unset_status" + } + ] + }, + "method": "PUT", + "path": "/v2/list/{list_id}", + "tags": [ + "Lists" + ], + "summary": "Update List", + "description": "Rename a List, update the List Info description, set a due date/time, set the List's priority, set an assignee, set or remove the List color.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "content", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "markdown_content", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "description": "Use `markdown_content` instead of `content` to format your List description.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "schema_required": false + }, + { + "name": "due_date", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "due_date_time", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "priority", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "assignee", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "status", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "description": "**Status** refers to the List color rather than the task Statuses available in the List.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "schema_required": false + }, + { + "name": "unset_status", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "By default, this is `false.` To remove the List color use `unset_status: true`." + }, + "description": "By default, this is `false.` To remove the List color use `unset_status: true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean", + "description": "By default, this is `false.` To remove the List color use `unset_status: true`." + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateListrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"content\": {\n \"type\": \"string\"\n },\n \"markdown_content\": {\n \"type\": \"string\",\n \"description\": \"Use `markdown_content` instead of `content` to format your List description.\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"due_date_time\": {\n \"type\": \"boolean\"\n },\n \"priority\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"assignee\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"description\": \"**Status** refers to the List color rather than the task Statuses available in the List.\",\n \"type\": \"string\"\n },\n \"unset_status\": {\n \"description\": \"By default, this is `false.` To remove the List color use `unset_status: true`.\",\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated List Name\",\n \"content\": \"Updated List Content\",\n \"markdown_content\": \"# This is markdown\\n ***bold and italicized text***\",\n \"due_date\": 1567780450202,\n \"due_date_time\": true,\n \"priority\": 2,\n \"assignee\": \"none\",\n \"status\": \"red\",\n \"unset_status\": true\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated List Name\",\n \"content\": \"Updated List Content\",\n \"markdown_content\": \"# This is markdown\\n ***bold and italicized text***\",\n \"due_date\": 1567780450202,\n \"due_date_time\": true,\n \"priority\": 2,\n \"assignee\": \"none\",\n \"status\": \"red\",\n \"unset_status\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "DeleteList", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_workspace_list", + "description": { + "tagline": "Delete a list from your ClickUp workspace.", + "detailed": "Use this tool to remove a specific list from your ClickUp workspace when it's no longer needed." + }, + "return_annotation": "Confirmation of list deletion from the workspace.", + "arguments": [ + { + "name": "workspace_list_id", + "alternative_names": [ + "list_identifier", + "workspace_list_identifier" + ], + "description": "The unique integer ID of the list to be deleted from the ClickUp workspace.", + "endpoint_argument_name": "list_id" + }, + { + "name": "content_type_header", + "alternative_names": [ + "http_content_type", + "content_type_info" + ], + "description": "Specifies the media type of the request. Typically set to 'application/json'.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "DELETE", + "path": "/v2/list/{list_id}", + "tags": [ + "Lists" + ], + "summary": "Delete List", + "description": "Delete a List from your Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "AddTaskToList", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_task_to_clickup_list", + "description": { + "tagline": "Add a task to an additional list in ClickUp.", + "detailed": "This tool adds a specified task to an additional list in ClickUp, requiring the 'Tasks in Multiple List' ClickApp to be enabled. Use this tool to manage tasks across multiple lists efficiently." + }, + "return_annotation": "Confirmation of task addition to list.", + "arguments": [ + { + "name": "target_list_id", + "alternative_names": [ + "destination_list_id", + "secondary_list_id" + ], + "description": "The unique identifier for the target list where the task will be added. This is required to associate the task with the correct list in ClickUp.", + "endpoint_argument_name": "list_id" + }, + { + "name": "task_identifier", + "alternative_names": [ + "task_id", + "task_reference" + ], + "description": "Specify the ID of the task to be added to an additional list in ClickUp.", + "endpoint_argument_name": "task_id" + } + ] + }, + "method": "POST", + "path": "/v2/list/{list_id}/task/{task_id}", + "tags": [ + "Lists" + ], + "summary": "Add Task To List", + "description": "Add a task to an additional List. \\\n \\\n***Note:** This endpoint requires the [Tasks in Multiple List ClickApp](https://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists) to be enabled.*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "RemoveTaskFromList", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_task_from_additional_list", + "description": { + "tagline": "Remove a task from an additional list in ClickUp.", + "detailed": "Use this tool to remove a task from an additional list, not the task's home list. Requires the 'Tasks in Multiple Lists' feature to be enabled in ClickUp." + }, + "return_annotation": "Confirmation of task removal from the additional list.", + "arguments": [ + { + "name": "additional_list_id", + "alternative_names": [ + "remove_list_id", + "secondary_list_id" + ], + "description": "The ID of the additional list from which the task should be removed. This is required for identifying the secondary list, not the task's home list.", + "endpoint_argument_name": "list_id" + }, + { + "name": "task_identifier", + "alternative_names": [ + "task_id_value", + "task_unique_id" + ], + "description": "The unique identifier for the task to be removed from the additional list.", + "endpoint_argument_name": "task_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/list/{list_id}/task/{task_id}", + "tags": [ + "Lists" + ], + "summary": "Remove Task From List", + "description": "Remove a task from an additional List. You can't remove a task from its home List. \\\n \\\n***Note:** This endpoint requires the [Tasks in Multiple List ClickApp](https://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists) to be enabled.*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetTaskMembers", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_task_members", + "description": { + "tagline": "Retrieve members with direct access to a task.", + "detailed": "Use this tool to view the people who have direct access to a specific task in ClickUp. It does not include members with inherited permissions through the hierarchy." + }, + "return_annotation": "List of people with access to a task.", + "arguments": [ + { + "name": "task_identifier", + "alternative_names": [ + "task_unique_id", + "task_reference" + ], + "description": "The unique identifier of the task to retrieve members for. This ID is necessary to specify the task in question.", + "endpoint_argument_name": "task_id" + } + ] + }, + "method": "GET", + "path": "/v2/task/{task_id}/member", + "tags": [ + "Members" + ], + "summary": "Get Task Members", + "description": "View the people who have access to a task. Responses do not include people with inherited Hierarchy permission to the task.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetListMembers", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_list_members", + "description": { + "tagline": "Retrieve members with access to a specific list in ClickUp.", + "detailed": "Use this tool to get the members of a ClickUp workspace who have access to a specified list. It helps in managing and viewing user access to project resources." + }, + "return_annotation": "List of workspace members with access to a specified list.", + "arguments": [ + { + "name": "list_id", + "alternative_names": [ + "list_identifier", + "list_access_id" + ], + "description": "The unique identifier for the list in ClickUp. It is required to fetch the members with access to this list.", + "endpoint_argument_name": "list_id" + } + ] + }, + "method": "GET", + "path": "/v2/list/{list_id}/member", + "tags": [ + "Members" + ], + "summary": "Get List Members", + "description": "Get Workspace members who have access to a List.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetCustomRoles", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_workspace_custom_roles", + "description": { + "tagline": "Retrieve custom roles from a specific workspace.", + "detailed": "This tool is used to retrieve the custom roles available in a specified workspace on ClickUp. It should be called when you need to view or manage roles in a ClickUp workspace." + }, + "return_annotation": "List of custom roles available in the workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The unique identifier for the workspace to retrieve custom roles from.", + "endpoint_argument_name": "team_id" + }, + { + "name": "include_members", + "alternative_names": [ + "with_members", + "show_members" + ], + "description": "Include member details in the response. Set to true to include, false to exclude.", + "endpoint_argument_name": "include_members" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/customroles", + "tags": [ + "Roles" + ], + "summary": "Get Custom Roles", + "description": "View the Custom Roles available in a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "include_members", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "SharedHierarchy", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_shared_hierarchy", + "description": { + "tagline": "View shared tasks, lists, and folders.", + "detailed": "Use this tool to view tasks, lists, and folders shared with the authenticated user in a specified team." + }, + "return_annotation": "Shared tasks, lists, and folders for the user.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_id", + "workspace_identifier" + ], + "description": "The Workspace ID to view shared tasks, lists, and folders.", + "endpoint_argument_name": "team_id" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/shared", + "tags": [ + "Shared Hierarchy" + ], + "summary": "Shared Hierarchy", + "description": "View the tasks, Lists, and Folders that have been shared with the authenticated user.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetSpaces", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "retrieve_available_spaces", + "description": { + "tagline": "View available Spaces in a Workspace.", + "detailed": "The tool retrieves the Spaces within a specified Workspace, providing member info for private Spaces if applicable." + }, + "return_annotation": "List of available spaces in a specific workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_workspace_id", + "workspace_identifier" + ], + "description": "The ID of the workspace to retrieve available spaces from.", + "endpoint_argument_name": "team_id" + }, + { + "name": "include_archived_spaces", + "alternative_names": [ + "show_archived_spaces", + "retrieve_archived_spaces" + ], + "description": "Set to true to include archived Spaces in the results. Otherwise, only active Spaces are returned.", + "endpoint_argument_name": "archived" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/space", + "tags": [ + "Spaces" + ], + "summary": "Get Spaces", + "description": "View the Spaces avialable in a Workspace. You can only get member info in private Spaces.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "archived", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateSpace", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_space_in_workspace", + "description": { + "tagline": "Add a new Space to a Workspace.", + "detailed": "Use this tool to create a new space within a specified workspace on ClickUp. It should be called when a user wants to organize tasks or projects under a new space in their team environment." + }, + "return_annotation": "Details of the newly created space.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the workspace where the new space will be added. It should be an integer value.", + "endpoint_argument_name": "team_id" + }, + { + "name": "new_space_configuration", + "alternative_names": [ + "space_details", + "configuration" + ], + "description": "JSON object with details for the new space, including its name, multiple assignees option, and features.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/team/{team_id}/space", + "tags": [ + "Spaces" + ], + "summary": "Create Space", + "description": "Add a new Space to a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "multiple_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "features": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "CreateSpacerequest", + "properties": { + "name": { + "type": "string" + }, + "multiple_assignees": { + "type": "boolean" + }, + "features": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features" + } + }, + "required": [ + "name", + "multiple_assignees", + "features" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateSpacerequest\",\n \"required\": [\n \"name\",\n \"multiple_assignees\",\n \"features\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"multiple_assignees\": {\n \"type\": \"boolean\"\n },\n \"features\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Space Name\",\n \"multiple_assignees\": true,\n \"features\": {\n \"due_dates\": {\n \"enabled\": true,\n \"start_date\": false,\n \"remap_due_dates\": true,\n \"remap_closed_due_date\": false\n },\n \"time_tracking\": {\n \"enabled\": false\n },\n \"tags\": {\n \"enabled\": true\n },\n \"time_estimates\": {\n \"enabled\": true\n },\n \"checklists\": {\n \"enabled\": true\n },\n \"custom_fields\": {\n \"enabled\": true\n },\n \"remap_dependencies\": {\n \"enabled\": true\n },\n \"dependency_warning\": {\n \"enabled\": true\n },\n \"portfolios\": {\n \"enabled\": true\n }\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New Space Name\",\n \"multiple_assignees\": true,\n \"features\": {\n \"due_dates\": {\n \"enabled\": true,\n \"start_date\": false,\n \"remap_due_dates\": true,\n \"remap_closed_due_date\": false\n },\n \"time_tracking\": {\n \"enabled\": false\n },\n \"tags\": {\n \"enabled\": true\n },\n \"time_estimates\": {\n \"enabled\": true\n },\n \"checklists\": {\n \"enabled\": true\n },\n \"custom_fields\": {\n \"enabled\": true\n },\n \"remap_dependencies\": {\n \"enabled\": true\n },\n \"dependency_warning\": {\n \"enabled\": true\n },\n \"portfolios\": {\n \"enabled\": true\n }\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "GetSpace", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_workspace_spaces", + "description": { + "tagline": "Retrieve available Spaces in a Workspace.", + "detailed": "Use this tool to get information about the Spaces available in a specific Workspace identified by its space ID." + }, + "return_annotation": "Details of available spaces in a workspace.", + "arguments": [ + { + "name": "workspace_space_id", + "alternative_names": [ + "space_identifier", + "space_key" + ], + "description": "The unique identifier for the specific space in the workspace to retrieve details.", + "endpoint_argument_name": "space_id" + } + ] + }, + "method": "GET", + "path": "/v2/space/{space_id}", + "tags": [ + "Spaces" + ], + "summary": "Get Space", + "description": "View the Spaces available in a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "UpdateSpace", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_clickup_space", + "description": { + "tagline": "Update space attributes in ClickUp.", + "detailed": "Use this tool to rename a ClickUp space, change its color, and enable or disable ClickApps for it. Call this when you need to modify the settings of an existing space." + }, + "return_annotation": "Confirmation of space update with details.", + "arguments": [ + { + "name": "space_identifier", + "alternative_names": [ + "space_id_number", + "space_id_value" + ], + "description": "The unique identifier for the ClickUp space to be updated.", + "endpoint_argument_name": "space_id" + }, + { + "name": "space_update_details", + "alternative_names": [ + "space_modification_payload", + "space_attributes_update" + ], + "description": "JSON object containing the new settings for the space. Includes name, color, privacy settings, admin management, multiple assignees, and feature settings.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "PUT", + "path": "/v2/space/{space_id}", + "tags": [ + "Spaces" + ], + "summary": "Update Space", + "description": "Rename, set the Space color, and enable ClickApps for a Space.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "color": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "private": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "admin_can_manage": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "***Note:** Allowing or restricting admins from managing private Spaces using `\"admin_can_manage\"` is an [Enterprise Plan](https://clickup.com/pricing) feature.*" + }, + "multiple_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "features": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "due_dates": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "remap_due_dates": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "remap_closed_due_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "time_tracking": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "time_estimates": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "checklists": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "custom_fields": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "remap_dependencies": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "dependency_warning": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "portfolios": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "UpdateSpacerequest", + "properties": { + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "admin_can_manage": { + "type": "boolean", + "description": "***Note:** Allowing or restricting admins from managing private Spaces using `\"admin_can_manage\"` is an [Enterprise Plan](https://clickup.com/pricing) feature.*" + }, + "multiple_assignees": { + "type": "boolean" + }, + "features": { + "type": "object", + "title": "Features", + "properties": { + "due_dates": { + "type": "object", + "title": "DueDates", + "properties": { + "enabled": { + "type": "boolean" + }, + "start_date": { + "type": "boolean" + }, + "remap_due_dates": { + "type": "boolean" + }, + "remap_closed_due_date": { + "type": "boolean" + } + }, + "required": [ + "enabled", + "start_date", + "remap_due_dates", + "remap_closed_due_date" + ] + }, + "time_tracking": { + "type": "object", + "title": "TimeTracking", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "tags": { + "type": "object", + "title": "Tags", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "time_estimates": { + "type": "object", + "title": "TimeEstimates", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "checklists": { + "type": "object", + "title": "Checklists", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "custom_fields": { + "type": "object", + "title": "CustomFields", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "remap_dependencies": { + "type": "object", + "title": "RemapDependencies", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "dependency_warning": { + "type": "object", + "title": "DependencyWarning", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + }, + "portfolios": { + "type": "object", + "title": "Portfolios", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "required": [ + "enabled" + ] + } + }, + "required": [ + "due_dates", + "time_tracking", + "tags", + "time_estimates", + "checklists", + "custom_fields", + "remap_dependencies", + "dependency_warning", + "portfolios" + ] + } + }, + "required": [ + "name", + "color", + "private", + "admin_can_manage", + "multiple_assignees", + "features" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateSpacerequest\",\n \"required\": [\n \"name\",\n \"color\",\n \"private\",\n \"admin_can_manage\",\n \"multiple_assignees\",\n \"features\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"color\": {\n \"type\": \"string\"\n },\n \"private\": {\n \"type\": \"boolean\"\n },\n \"admin_can_manage\": {\n \"description\": \"***Note:** Allowing or restricting admins from managing private Spaces using `\\\"admin_can_manage\\\"` is an [Enterprise Plan](https://clickup.com/pricing) feature.*\",\n \"type\": \"boolean\"\n },\n \"multiple_assignees\": {\n \"type\": \"boolean\"\n },\n \"features\": {\n \"title\": \"Features\",\n \"required\": [\n \"due_dates\",\n \"time_tracking\",\n \"tags\",\n \"time_estimates\",\n \"checklists\",\n \"custom_fields\",\n \"remap_dependencies\",\n \"dependency_warning\",\n \"portfolios\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"due_dates\": {\n \"title\": \"DueDates\",\n \"required\": [\n \"enabled\",\n \"start_date\",\n \"remap_due_dates\",\n \"remap_closed_due_date\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n },\n \"start_date\": {\n \"type\": \"boolean\"\n },\n \"remap_due_dates\": {\n \"type\": \"boolean\"\n },\n \"remap_closed_due_date\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true,\n \"start_date\": false,\n \"remap_due_dates\": true,\n \"remap_closed_due_date\": false\n }\n ]\n },\n \"time_tracking\": {\n \"title\": \"TimeTracking\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": false\n }\n ]\n },\n \"tags\": {\n \"title\": \"Tags\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"time_estimates\": {\n \"title\": \"TimeEstimates\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"checklists\": {\n \"title\": \"Checklists\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"custom_fields\": {\n \"title\": \"CustomFields\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"remap_dependencies\": {\n \"title\": \"RemapDependencies\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"dependency_warning\": {\n \"title\": \"DependencyWarning\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"portfolios\": {\n \"title\": \"Portfolios\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n }\n },\n \"examples\": [\n {\n \"due_dates\": {\n \"enabled\": true,\n \"start_date\": false,\n \"remap_due_dates\": true,\n \"remap_closed_due_date\": false\n },\n \"time_tracking\": {\n \"enabled\": false\n },\n \"tags\": {\n \"enabled\": true\n },\n \"time_estimates\": {\n \"enabled\": true\n },\n \"checklists\": {\n \"enabled\": true\n },\n \"custom_fields\": {\n \"enabled\": true\n },\n \"remap_dependencies\": {\n \"enabled\": true\n },\n \"dependency_warning\": {\n \"enabled\": true\n },\n \"portfolios\": {\n \"enabled\": true\n }\n }\n ]\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Space Name\",\n \"color\": \"#7B68EE\",\n \"private\": false,\n \"admin_can_manage\": false,\n \"multiple_assignees\": false,\n \"features\": {\n \"due_dates\": {\n \"enabled\": false,\n \"start_date\": false,\n \"remap_due_dates\": false,\n \"remap_closed_due_date\": false\n },\n \"time_tracking\": {\n \"enabled\": false\n },\n \"tags\": {\n \"enabled\": false\n },\n \"time_estimates\": {\n \"enabled\": false\n },\n \"checklists\": {\n \"enabled\": true\n },\n \"custom_fields\": {\n \"enabled\": true\n },\n \"remap_dependencies\": {\n \"enabled\": false\n },\n \"dependency_warning\": {\n \"enabled\": false\n },\n \"portfolios\": {\n \"enabled\": false\n }\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Space Name\",\n \"color\": \"#7B68EE\",\n \"private\": false,\n \"admin_can_manage\": false,\n \"multiple_assignees\": false,\n \"features\": {\n \"due_dates\": {\n \"enabled\": false,\n \"start_date\": false,\n \"remap_due_dates\": false,\n \"remap_closed_due_date\": false\n },\n \"time_tracking\": {\n \"enabled\": false\n },\n \"tags\": {\n \"enabled\": false\n },\n \"time_estimates\": {\n \"enabled\": false\n },\n \"checklists\": {\n \"enabled\": true\n },\n \"custom_fields\": {\n \"enabled\": true\n },\n \"remap_dependencies\": {\n \"enabled\": false\n },\n \"dependency_warning\": {\n \"enabled\": false\n },\n \"portfolios\": {\n \"enabled\": false\n }\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "DeleteSpace", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_workspace_space", + "description": { + "tagline": "Delete a space from your ClickUp workspace.", + "detailed": "Use this tool to delete a specific space in your ClickUp workspace by providing the space ID. It permanently removes the space and all associated data." + }, + "return_annotation": "Confirmation of space deletion from the workspace.", + "arguments": [ + { + "name": "workspace_space_id", + "alternative_names": [ + "space_identifier", + "id_of_space" + ], + "description": "The unique identifier for the space to delete in your ClickUp workspace. Provide the specific space ID to permanently remove the space and its data.", + "endpoint_argument_name": "space_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/space/{space_id}", + "tags": [ + "Spaces" + ], + "summary": "Delete Space", + "description": "Delete a Space from your Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetSpaceTags", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_space_tags", + "description": { + "tagline": "Retrieve task tags for a specified space.", + "detailed": "Use this tool to view the task tags available within a specific space. It helps in identifying and managing tags associated with tasks." + }, + "return_annotation": "List of task tags available in a specified space.", + "arguments": [ + { + "name": "space_identifier", + "alternative_names": [ + "space_id_number", + "space_reference" + ], + "description": "An integer representing the ID of the space for which to retrieve task tags. This ID is required to specify the space.", + "endpoint_argument_name": "space_id" + }, + { + "name": "content_type_header", + "alternative_names": [ + "content_type", + "header_content_type" + ], + "description": "The MIME type of the request. Generally set to 'application/json'.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "GET", + "path": "/v2/space/{space_id}/tag", + "tags": [ + "Tags" + ], + "summary": "Get Space Tags", + "description": "View the task Tags available in a Space.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateSpaceTag", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_space_task_tag", + "description": { + "tagline": "Add a new task tag to a specified space in ClickUp.", + "detailed": "Use this tool to create a new tag for tasks within a specific space in ClickUp. It's useful for organizing tasks by category or priority." + }, + "return_annotation": "Confirmation of the tag creation in the specified space.", + "arguments": [ + { + "name": "space_identifier", + "alternative_names": [ + "space_id_number", + "space_id_value" + ], + "description": "The unique identifier for the space where the tag will be added. It must be an integer.", + "endpoint_argument_name": "space_id" + }, + { + "name": "tag_name", + "alternative_names": [ + "task_tag_name", + "space_tag_name" + ], + "description": "Name of the new tag to be added to the space. It should be a descriptive and concise identifier for categorizing tasks.", + "endpoint_argument_name": "tag.name" + }, + { + "name": "tag_foreground_color", + "alternative_names": [ + "foreground_color", + "tag_fg_color" + ], + "description": "Hex code for the tag's foreground color. It defines the text color of the tag.", + "endpoint_argument_name": "tag.tag_fg" + }, + { + "name": "tag_background_color", + "alternative_names": [ + "tag_bg_color", + "background_color" + ], + "description": "Hex code representing the background color for the tag. It should be a string in the format '#RRGGBB'.", + "endpoint_argument_name": "tag.tag_bg" + } + ] + }, + "method": "POST", + "path": "/v2/space/{space_id}/tag", + "tags": [ + "Tags" + ], + "summary": "Create Space Tag", + "description": "Add a new task Tag to a Space.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "tag.name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "tag.tag_fg", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "tag.tag_bg", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateSpaceTagrequest\",\n \"required\": [\n \"tag\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"tag\": {\n \"title\": \"Tag\",\n \"required\": [\n \"name\",\n \"tag_fg\",\n \"tag_bg\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"tag_fg\": {\n \"type\": \"string\"\n },\n \"tag_bg\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Tag Name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n ]\n }\n },\n \"examples\": [\n {\n \"tag\": {\n \"name\": \"Tag Name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n }\n ]\n },\n \"example\": {\n \"tag\": {\n \"name\": \"Tag Name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "EditSpaceTag", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_task_tag", + "description": { + "tagline": "Update a task tag in a ClickUp space.", + "detailed": "Use this tool to update the details of a task tag within a specified ClickUp space. It is helpful for managing and organizing tasks by modifying existing tags." + }, + "return_annotation": "Confirms the update of a task tag in a ClickUp space.", + "arguments": [ + { + "name": "space_id", + "alternative_names": [ + "space_identifier", + "clickup_space_id" + ], + "description": "The unique identifier of the ClickUp space where the tag will be updated. This is required to specify which space's tag needs modification.", + "endpoint_argument_name": "space_id" + }, + { + "name": "current_tag_name", + "alternative_names": [ + "existing_tag_name", + "old_tag_name" + ], + "description": "The current name of the tag to be updated in the ClickUp space.", + "endpoint_argument_name": "tag_name" + }, + { + "name": "new_tag_name", + "alternative_names": [ + "updated_tag_name", + "modified_tag_name" + ], + "description": "The new name for the task tag to be updated in the ClickUp space. It must be a string representing the desired tag name after the update.", + "endpoint_argument_name": "tag.name" + }, + { + "name": "tag_foreground_color", + "alternative_names": [ + "tag_text_color", + "tag_primary_color" + ], + "description": "The foreground (text) color of the tag in a valid color format (e.g., HEX).", + "endpoint_argument_name": "tag.fg_color" + }, + { + "name": "background_color_of_tag", + "alternative_names": [ + "tag_background_color", + "bg_color_for_tag" + ], + "description": "The background color for the task tag. It should be a valid hex color code (e.g., #FFFFFF).", + "endpoint_argument_name": "tag.bg_color" + } + ] + }, + "method": "PUT", + "path": "/v2/space/{space_id}/tag/{tag_name}", + "tags": [ + "Tags" + ], + "summary": "Edit Space Tag", + "description": "Update a task Tag.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "tag_name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "tag.name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "tag.fg_color", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "tag.bg_color", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditSpaceTagrequest\",\n \"required\": [\n \"tag\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"tag\": {\n \"title\": \"Tag1\",\n \"required\": [\n \"name\",\n \"fg_color\",\n \"bg_color\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"fg_color\": {\n \"type\": \"string\"\n },\n \"bg_color\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Tag\",\n \"fg_color\": \"#ffffff\",\n \"bg_color\": \"#ffffff\"\n }\n ]\n }\n },\n \"examples\": [\n {\n \"tag\": {\n \"name\": \"Updated Tag\",\n \"fg_color\": \"#ffffff\",\n \"bg_color\": \"#ffffff\"\n }\n }\n ]\n },\n \"example\": {\n \"tag\": {\n \"name\": \"Tag name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "DeleteSpaceTag", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_space_tag", + "description": { + "tagline": "Delete a task tag from a space in ClickUp.", + "detailed": "Use this tool to delete a specific task tag from a designated space in ClickUp. Ideal for cleaning up or reorganizing tags within a space." + }, + "return_annotation": "Confirmation of tag deletion from a space.", + "arguments": [ + { + "name": "space_identifier", + "alternative_names": [ + "space_id_number", + "space_key" + ], + "description": "The unique identifier of the space from which the tag will be deleted. This should be an integer value.", + "endpoint_argument_name": "space_id" + }, + { + "name": "tag_name_to_delete", + "alternative_names": [ + "space_tag_name", + "task_tag_name" + ], + "description": "The name of the tag to be deleted from the specified space. Ensure this tag name exists in the target space.", + "endpoint_argument_name": "tag_name" + }, + { + "name": "tag_to_delete", + "alternative_names": [ + "target_tag", + "tag_identifier" + ], + "description": "JSON object specifying the tag to be deleted from the space.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "DELETE", + "path": "/v2/space/{space_id}/tag/{tag_name}", + "tags": [ + "Tags" + ], + "summary": "Delete Space Tag", + "description": "Delete a task Tag from a Space.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "tag_name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "tag": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "DeleteSpaceTagrequest", + "properties": { + "tag": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag" + } + }, + "required": [ + "tag" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"DeleteSpaceTagrequest\",\n \"required\": [\n \"tag\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"tag\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag\"\n }\n },\n \"examples\": [\n {\n \"tag\": {\n \"name\": \"Tag name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n }\n ]\n },\n \"example\": {\n \"tag\": {\n \"name\": \"Tag name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "AddTagToTask", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_tag_to_task", + "description": { + "tagline": "Add a tag to a specific task in ClickUp.", + "detailed": "Use this tool to assign a tag to a task in ClickUp by specifying the task ID and tag name. It helps in organizing and categorizing tasks efficiently." + }, + "return_annotation": "Confirmation of tag added to task.", + "arguments": [ + { + "name": "task_identifier", + "alternative_names": [ + "task_reference_id", + "task_custom_id" + ], + "description": "The unique identifier of the task to which the tag will be added. Can be a custom task ID if specified.", + "endpoint_argument_name": "task_id" + }, + { + "name": "tag_name", + "alternative_names": [ + "label_name", + "task_tag_name" + ], + "description": "The name of the tag to add to the task. This should be a string representing the desired tag.", + "endpoint_argument_name": "tag_name" + }, + { + "name": "content_type", + "alternative_names": [ + "content_type_value", + "header_content_type" + ], + "description": "Specifies the media type of the request. Typically set to 'application/json'.", + "endpoint_argument_name": "Content-Type" + }, + { + "name": "workspace_id_if_custom_task_ids", + "alternative_names": [ + "workspace_id_optional", + "workspace_id_with_custom_ids" + ], + "description": "Workspace ID required when referencing a task by its custom task ID. Only needed if `custom_task_ids=true`.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "custom_id_reference", + "task_id_customization" + ], + "description": "Set to true if you want to reference a task using its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "POST", + "path": "/v2/task/{task_id}/tag/{tag_name}", + "tags": [ + "Tags" + ], + "summary": "Add Tag To Task", + "description": "Add a Tag to a task.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "tag_name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "RemoveTagFromTask", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_tag_from_task", + "description": { + "tagline": "Remove a tag from a specific task in ClickUp.", + "detailed": "Use this tool to remove a specified tag from a task in ClickUp without deleting the tag from the space." + }, + "return_annotation": "Confirmation that the tag was removed from the task.", + "arguments": [ + { + "name": "task_id", + "alternative_names": [ + "task_identifier", + "task_key" + ], + "description": "The unique identifier of the task from which the tag will be removed. Use the task's regular ID unless custom task IDs are enabled.", + "endpoint_argument_name": "task_id" + }, + { + "name": "tag_name_to_remove", + "alternative_names": [ + "task_tag_name", + "label_name" + ], + "description": "The name of the tag to remove from the specified task.", + "endpoint_argument_name": "tag_name" + }, + { + "name": "content_type_header", + "alternative_names": [ + "http_content_type", + "api_content_type" + ], + "description": "Specifies the media type of the request. Commonly set to 'application/json'.", + "endpoint_argument_name": "Content-Type" + }, + { + "name": "workspace_id_for_custom_task", + "alternative_names": [ + "workspace_id_with_custom_id", + "team_identifier_for_custom_tasks" + ], + "description": "The Workspace ID required when referencing a task by its custom ID (if custom_task_ids is true).", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_task_ids", + "use_task_custom_ids" + ], + "description": "Set to true to reference a task by its custom task ID, or false to use the standard ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "DELETE", + "path": "/v2/task/{task_id}/tag/{tag_name}", + "tags": [ + "Tags" + ], + "summary": "Remove Tag From Task", + "description": "Remove a Tag from a task. This does not delete the Tag from the Space.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "tag_name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetTasks", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_list_tasks", + "description": { + "tagline": "Retrieve tasks from a specific list in ClickUp.", + "detailed": "This tool retrieves tasks from a specified list in ClickUp, limited to 100 tasks per page. It includes tasks where the specified list is their home, while also allowing inclusion of tasks from multiple lists by using the `include_timl` parameter. It provides details accessible to the user, including time spent on tasks with time entries." + }, + "return_annotation": "Details of tasks in a specified list.", + "arguments": [ + { + "name": "list_identifier", + "alternative_names": [ + "list_id_number", + "list_reference_id" + ], + "description": "The unique identifier for the list. Find it by copying the link and extracting the number following /li in the URL.", + "endpoint_argument_name": "list_id" + }, + { + "name": "page_number_to_fetch", + "alternative_names": [ + "task_page_index", + "fetch_task_page" + ], + "description": "Specify the page number to fetch tasks from, starting at 0.", + "endpoint_argument_name": "page" + }, + { + "name": "order_by_field", + "alternative_names": [ + "sort_by_field", + "task_order_field" + ], + "description": "Specify the field to order tasks by. Options: 'id', 'created', 'updated', 'due_date'. Defaults to 'created'.", + "endpoint_argument_name": "order_by" + }, + { + "name": "filter_by_statuses", + "alternative_names": [ + "statuses_filter", + "task_statuses" + ], + "description": "Filter tasks by their statuses. Use an array of status strings, such as ['to do', 'in progress'].", + "endpoint_argument_name": "statuses" + }, + { + "name": "filter_by_assignees", + "alternative_names": [ + "assignee_filter", + "task_assignees" + ], + "description": "Filter tasks by assignee IDs. Provide an array of assignee IDs to filter tasks assigned to specific users.", + "endpoint_argument_name": "assignees" + }, + { + "name": "filter_by_watchers", + "alternative_names": [ + "watcher_filter", + "task_watchers" + ], + "description": "An array of watcher IDs to filter tasks by watchers. Each ID should be a string.", + "endpoint_argument_name": "watchers" + }, + { + "name": "filter_by_tags", + "alternative_names": [ + "tags_filter", + "tag_list" + ], + "description": "Filter tasks by a list of tags. Provide an array of strings representing the tags to filter by.", + "endpoint_argument_name": "tags" + }, + { + "name": "filter_due_date_greater_than", + "alternative_names": [ + "due_date_greater_than_filter", + "due_date_after_filter" + ], + "description": "Filter tasks by a due date greater than the provided Unix time in milliseconds.", + "endpoint_argument_name": "due_date_gt" + }, + { + "name": "filter_due_date_before", + "alternative_names": [ + "due_date_filter_before", + "before_due_date_unix_time" + ], + "description": "Filter tasks with due dates earlier than the specified Unix time in milliseconds.", + "endpoint_argument_name": "due_date_lt" + }, + { + "name": "filter_date_created_after", + "alternative_names": [ + "date_created_after", + "created_after_date" + ], + "description": "Filter tasks created after this Unix timestamp in milliseconds.", + "endpoint_argument_name": "date_created_gt" + }, + { + "name": "date_created_less_than", + "alternative_names": [ + "created_before_date", + "create_time_before" + ], + "description": "Filter tasks created before the specified Unix timestamp in milliseconds.", + "endpoint_argument_name": "date_created_lt" + }, + { + "name": "filter_date_updated_after", + "alternative_names": [ + "date_updated_after", + "updated_date_filter" + ], + "description": "Filter tasks updated after the specified Unix timestamp in milliseconds.", + "endpoint_argument_name": "date_updated_gt" + }, + { + "name": "filter_date_updated_less_than", + "alternative_names": [ + "updated_before_date", + "updated_before_timestamp" + ], + "description": "Filter tasks updated before a specific date, using Unix time in milliseconds.", + "endpoint_argument_name": "date_updated_lt" + }, + { + "name": "filter_date_done_after", + "alternative_names": [ + "completed_after_date", + "finished_after_date" + ], + "description": "Filter tasks completed after a specified date in Unix time (milliseconds).", + "endpoint_argument_name": "date_done_gt" + }, + { + "name": "filter_by_date_done_before", + "alternative_names": [ + "date_done_less_than", + "date_done_before" + ], + "description": "Filter tasks completed before a specified Unix time in milliseconds.", + "endpoint_argument_name": "date_done_lt" + }, + { + "name": "filter_by_custom_fields", + "alternative_names": [ + "custom_fields_filter", + "custom_fields_conditions" + ], + "description": "Include tasks with specific values in one or more Custom Fields. Use a JSON array of objects, where each object includes 'field_id', 'operator', and 'value'.", + "endpoint_argument_name": "custom_fields" + }, + { + "name": "filter_by_custom_field", + "alternative_names": [ + "custom_field_filter", + "specific_custom_field" + ], + "description": "Include tasks with specific values in one Custom Field. This can be a Custom Relationship. Provide an array of strings representing the field values.", + "endpoint_argument_name": "custom_field" + }, + { + "name": "custom_task_type_filters", + "alternative_names": [ + "task_type_filters", + "custom_items_filter" + ], + "description": "An array of numbers to filter tasks by custom types. Use 0 for tasks, 1 for Milestones, and other numbers for custom types defined in your Workspace.", + "endpoint_argument_name": "custom_items" + }, + { + "name": "include_archived_tasks", + "alternative_names": [ + "show_archived_tasks", + "view_archived_tasks" + ], + "description": "Set to true to include archived tasks in the results. By default, archived tasks are excluded.", + "endpoint_argument_name": "archived" + }, + { + "name": "include_markdown_task_descriptions", + "alternative_names": [ + "return_markdown_task_descriptions", + "markdown_format_task_descriptions" + ], + "description": "Set to true to return task descriptions in Markdown format.", + "endpoint_argument_name": "include_markdown_description" + }, + { + "name": "display_tasks_in_reverse_order", + "alternative_names": [ + "reverse_task_order", + "show_tasks_in_reverse" + ], + "description": "Set to true to display tasks in reverse order.", + "endpoint_argument_name": "reverse" + }, + { + "name": "include_subtasks", + "alternative_names": [ + "show_subtasks", + "display_subtasks" + ], + "description": "Set to true to include subtasks; false to exclude them. Defaults to false.", + "endpoint_argument_name": "subtasks" + }, + { + "name": "include_closed_tasks", + "alternative_names": [ + "include_completed_tasks", + "show_closed_tasks" + ], + "description": "Set to true to include closed tasks in the response. Defaults to false to exclude them.", + "endpoint_argument_name": "include_closed" + }, + { + "name": "include_tasks_in_multiple_lists", + "alternative_names": [ + "include_multiple_list_tasks", + "tasks_in_multiple_lists" + ], + "description": "Set to true to include tasks that exist in multiple lists. By default, these tasks are excluded.", + "endpoint_argument_name": "include_timl" + } + ] + }, + "method": "GET", + "path": "/v2/list/{list_id}/task", + "tags": [ + "Tasks" + ], + "summary": "Get Tasks", + "description": "View the tasks in a List. Responses are limited to 100 tasks per page. You can only view task information of tasks you can access. \\\n \\\nThis endpoint only includes tasks where the specified `list_id` is their home List. Tasks added to the `list_id` with a different home List are not included in the response by default. To include tasks that exist in multiple lists, use the `include_timl` parameter. \\\n \\\nThe `time_spent` field displays time tracked in milliseconds, and is only included in the response for tasks with time entries.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "archived", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "include_markdown_description", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`." + }, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "page", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Page to fetch (starts at 0)." + }, + "description": "Page to fetch (starts at 0).", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "order_by", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`." + }, + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "reverse", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Tasks are displayed in reverse order." + }, + "description": "Tasks are displayed in reverse order.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "subtasks", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or exclude subtasks. By default, subtasks are excluded." + }, + "description": "Include or exclude subtasks. By default, subtasks are excluded.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "statuses", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by statuses. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`" + }, + "description": "Filter by statuses. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "include_closed", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`." + }, + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "include_timl", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include Tasks in Multiple Lists. By default, tasks that exist in multiple lists are excluded from the response.\\\n \\\nTo include tasks that exist in multiple lists, use `include_timl: true`." + }, + "description": "Include Tasks in Multiple Lists. By default, tasks that exist in multiple lists are excluded from the response.\\\n \\\nTo include tasks that exist in multiple lists, use `include_timl: true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "assignees", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Assignees. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`" + }, + "description": "Filter by Assignees. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "watchers", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by watchers." + }, + "description": "Filter by watchers.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "tags", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by tags. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`" + }, + "description": "Filter by tags. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "due_date_gt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date greater than Unix time in milliseconds." + }, + "description": "Filter by due date greater than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "due_date_lt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date less than Unix time in milliseconds." + }, + "description": "Filter by due date less than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_created_gt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created greater than Unix time in milliseconds." + }, + "description": "Filter by date created greater than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_created_lt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created less than Unix time in milliseconds." + }, + "description": "Filter by date created less than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_updated_gt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated greater than Unix time in milliseconds." + }, + "description": "Filter by date updated greater than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_updated_lt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated less than Unix time in milliseconds." + }, + "description": "Filter by date updated less than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_done_gt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done greater than Unix time in milliseconds." + }, + "description": "Filter by date done greater than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_done_lt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done less than Unix time in milliseconds." + }, + "description": "Filter by date done less than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "custom_fields", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)" + }, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "custom_field", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship." + }, + "description": "Include tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "custom_items", + "value_schema": { + "val_type": "array", + "inner_val_type": "number", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace." + }, + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "number" + } + }, + "schema_required": false + } + ], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To find the list_id: \\ 1. In the Sidebar, hover over the List and click the **ellipsis ...** menu. \\ 2. Select **Copy link.** \\ 3. Use the copied URL to find the list_id. The list_id is the number that follows /li in the URL." + }, + "description": "To find the list_id: \\ 1. In the Sidebar, hover over the List and click the **ellipsis ...** menu. \\ 2. Select **Copy link.** \\ 3. Use the copied URL to find the list_id. The list_id is the number that follows /li in the URL.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateTask", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_new_clickup_task", + "description": { + "tagline": "Create a new task in ClickUp.", + "detailed": "This tool is used to create a new task in a specified list on ClickUp. It should be called when you need to add a task to your ClickUp project management system." + }, + "return_annotation": "Details of the newly created task.", + "arguments": [ + { + "name": "target_list_id", + "alternative_names": [ + "clickup_list_id", + "task_list_id" + ], + "description": "The ID of the list where the new task will be created. This should be an integer identifying the list in ClickUp.", + "endpoint_argument_name": "list_id" + }, + { + "name": "task_details", + "alternative_names": [ + "task_information", + "task_payload" + ], + "description": "JSON object containing task details such as name, description, assignees, status, priority, due dates, and more. Formats and fields are required as specified by ClickUp's task creation endpoint.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/list/{list_id}/task", + "tags": [ + "Tasks" + ], + "summary": "Create Task", + "description": "Create a new task.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "assignees": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "archived": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "group_assignees": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Assign multiple user groups to the task." + }, + "tags": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "status": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "priority": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "time_estimate": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "points": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Add Sprint Points to the task." + }, + "notify_all": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "parent": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "You can create a subtask by including an existing task ID.\\\n \\\nThe `parent` task ID you include can be a subtask, but must be in the same List specified in the path parameter." + }, + "markdown_content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`." + }, + "links_to": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include a task ID to create a linked dependency with your new task." + }, + "check_required_custom_fields": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When creating a task via API any required Custom Fields are ignored by default (`false`).\\\n \\\nYou can enforce required Custom Fields by including `check_required_custom_fields: true`." + }, + "custom_fields": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "You can include one or more Custom Fields to set them when creating a new task.\\\n \\\nCustom Fields that use object and array type values are nullable by sending `\"value\": null`." + }, + "custom_item_id": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The custom task type ID for this task. A value of `null` (default) creates a standard task type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "CreateTaskrequest", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "assignees": { + "type": "array", + "description": "", + "items": { + "type": "integer" + } + }, + "archived": { + "type": "boolean" + }, + "group_assignees": { + "type": "array", + "description": "Assign multiple user groups to the task.", + "items": { + "type": "string" + } + }, + "tags": { + "type": "array", + "description": "", + "items": { + "type": "string" + } + }, + "status": { + "type": "string" + }, + "priority": { + "type": [ + "integer", + "null" + ] + }, + "due_date": { + "type": "integer" + }, + "due_date_time": { + "type": "boolean" + }, + "time_estimate": { + "type": "integer" + }, + "start_date": { + "type": "integer" + }, + "start_date_time": { + "type": "boolean" + }, + "points": { + "type": "number", + "description": "Add Sprint Points to the task." + }, + "notify_all": { + "type": "boolean", + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "parent": { + "type": [ + "string", + "null" + ], + "description": "You can create a subtask by including an existing task ID.\\\n \\\nThe `parent` task ID you include can be a subtask, but must be in the same List specified in the path parameter." + }, + "markdown_content": { + "type": "string", + "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`." + }, + "links_to": { + "type": [ + "string", + "null" + ], + "description": "Include a task ID to create a linked dependency with your new task." + }, + "check_required_custom_fields": { + "type": "boolean", + "description": "When creating a task via API any required Custom Fields are ignored by default (`false`).\\\n \\\nYou can enforce required Custom Fields by including `check_required_custom_fields: true`." + }, + "custom_fields": { + "type": "array", + "description": "You can include one or more Custom Fields to set them when creating a new task.\\\n \\\nCustom Fields that use object and array type values are nullable by sending `\"value\": null`.", + "items": { + "type": "object", + "title": "SetCustomFieldValueOnCreateTaskrequest", + "properties": {}, + "anyOf": [ + { + "type": "object", + "title": "URL Custom Field", + "description": "The `value` must be a string with a valid URL.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "string", + "null" + ], + "example": "https://clickup.com/api" + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Dropdown Custom Field", + "description": "Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "string", + "null" + ], + "example": "uuid1234" + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Email Custom Field", + "description": "The `value` must be a string with a valid email address.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "string", + "null" + ], + "example": "user@company.com" + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Phone Custom Field", + "description": "The `value` must be a string with a valid country code.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "string", + "null" + ], + "example": "+1 123 456 7890" + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Date Custom Field", + "description": "The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "integer", + "null" + ], + "format": "int32", + "example": 1667367645000 + }, + "value_options": { + "type": "object", + "properties": { + "time": { + "type": "boolean", + "example": true + } + } + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Short or Long Text Custom Field", + "description": "Enter a string of text.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "string", + "null" + ], + "example": "This is short or long text in a Custom Field." + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Number Custom Field", + "description": "Enter a number.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "number", + "null" + ], + "example": -28 + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Money Custom Field", + "description": "You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "number", + "null" + ], + "example": 8000 + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Task Relationship Custom Field", + "description": "Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship. Task Relationship Custom Fields are nullable: `\"value\": null`.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "string" + } + }, + "rem": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "People Custom Field", + "description": "Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams) People Custom Fields are nullable: `\"value\": null`.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "number" + } + }, + "rem": { + "type": "array", + "items": { + "type": "number" + } + } + } + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Emoji (Rating) Custom Field", + "description": "Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "integer", + "null" + ], + "format": "int32", + "example": 4 + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Manual Progress Custom Field", + "description": "Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) Manual Progress Custom Fields are nullable: `\"value\": null`.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "object", + "properties": { + "current": { + "type": "number", + "example": 20 + } + }, + "required": [ + "current" + ] + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Label Custom Field", + "description": "Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) Label Custom Fields are nullable: `\"value\": null`.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "type": "string", + "example": [ + "uuid1234", + "uuid9876" + ] + } + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Location Custom Field", + "description": "Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "object", + "properties": { + "location": { + "type": "object", + "properties": { + "lat": { + "type": "number" + }, + "lng": { + "type": "number" + } + } + }, + "formatted_address": { + "type": "string" + } + } + } + }, + "required": [ + "id", + "value" + ] + }, + { + "type": "object", + "title": "Button Custom Field", + "description": "Set a button Custom Field to `true` to \"click\" it. This will trigger the button's action as if it was clicked in the UI.", + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "boolean", + "null" + ], + "example": true + } + }, + "required": [ + "id", + "value" + ] + } + ] + } + }, + "custom_item_id": { + "type": "number", + "description": "The custom task type ID for this task. A value of `null` (default) creates a standard task type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + } + }, + "required": [ + "name" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateTaskrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"assignees\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"archived\": {\n \"type\": \"boolean\"\n },\n \"group_assignees\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Assign multiple user groups to the task.\"\n },\n \"tags\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"priority\": {\n \"type\": [\n \"integer\",\n \"null\"\n ],\n \"contentEncoding\": \"int32\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"due_date_time\": {\n \"type\": \"boolean\"\n },\n \"time_estimate\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"start_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"start_date_time\": {\n \"type\": \"boolean\"\n },\n \"points\": {\n \"type\": \"number\",\n \"description\": \"Add Sprint Points to the task.\"\n },\n \"notify_all\": {\n \"type\": \"boolean\",\n \"description\": \"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.\"\n },\n \"parent\": {\n \"description\": \"You can create a subtask by including an existing task ID.\\\\\\n \\\\\\nThe `parent` task ID you include can be a subtask, but must be in the same List specified in the path parameter.\",\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"markdown_content\": {\n \"type\": \"string\",\n \"description\": \"Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`.\"\n },\n \"links_to\": {\n \"description\": \"Include a task ID to create a linked dependency with your new task.\",\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"check_required_custom_fields\": {\n \"description\": \"When creating a task via API any required Custom Fields are ignored by default (`false`).\\\\\\n \\\\\\nYou can enforce required Custom Fields by including `check_required_custom_fields: true`.\",\n \"type\": \"boolean\"\n },\n \"custom_fields\": {\n \"type\": \"array\",\n \"items\": {\n \"title\": \"SetCustomFieldValueOnCreateTaskrequest\",\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"title\": \"URL Custom Field\",\n \"description\": \"The `value` must be a string with a valid URL.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"example\": \"https://clickup.com/api\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Dropdown Custom Field\",\n \"description\": \"Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"example\": \"uuid1234\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Email Custom Field\",\n \"description\": \"The `value` must be a string with a valid email address.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"example\": \"user@company.com\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Phone Custom Field\",\n \"description\": \"The `value` must be a string with a valid country code.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"example\": \"+1 123 456 7890\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Date Custom Field\",\n \"description\": \"The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"integer\",\n \"null\"\n ],\n \"format\": \"int32\",\n \"example\": 1667367645000\n },\n \"value_options\": {\n \"type\": \"object\",\n \"properties\": {\n \"time\": {\n \"type\": \"boolean\",\n \"example\": true\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Short or Long Text Custom Field\",\n \"description\": \"Enter a string of text.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"example\": \"This is short or long text in a Custom Field.\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Number Custom Field\",\n \"description\": \"Enter a number.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"number\",\n \"null\"\n ],\n \"example\": -28\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Money Custom Field\",\n \"description\": \"You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"number\",\n \"null\"\n ],\n \"example\": 8000\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Task Relationship Custom Field\",\n \"description\": \"Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship. Task Relationship Custom Fields are nullable: `\\\"value\\\": null`.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"People Custom Field\",\n \"description\": \"Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams) People Custom Fields are nullable: `\\\"value\\\": null`.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Emoji (Rating) Custom Field\",\n \"description\": \"Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"integer\",\n \"null\"\n ],\n \"format\": \"int32\",\n \"example\": 4\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Manual Progress Custom Field\",\n \"description\": \"Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) Manual Progress Custom Fields are nullable: `\\\"value\\\": null`.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": \"object\",\n \"required\": [\n \"current\"\n ],\n \"properties\": {\n \"current\": {\n \"type\": \"number\",\n \"example\": 20\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Label Custom Field\",\n \"description\": \"Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) Label Custom Fields are nullable: `\\\"value\\\": null`.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"example\": [\n \"uuid1234\",\n \"uuid9876\"\n ]\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Location Custom Field\",\n \"description\": \"Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"object\",\n \"properties\": {\n \"lat\": {\n \"type\": \"number\"\n },\n \"lng\": {\n \"type\": \"number\"\n }\n }\n },\n \"formatted_address\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Button Custom Field\",\n \"description\": \"Set a button Custom Field to `true` to \\\"click\\\" it. This will trigger the button's action as if it was clicked in the UI.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"boolean\",\n \"null\"\n ],\n \"example\": true\n }\n }\n }\n ]\n },\n \"description\": \"You can include one or more Custom Fields to set them when creating a new task.\\\\\\n \\\\\\nCustom Fields that use object and array type values are nullable by sending `\\\"value\\\": null`.\"\n },\n \"custom_item_id\": {\n \"type\": \"number\",\n \"description\": \"The custom task type ID for this task. A value of `null` (default) creates a standard task type \\\"Task\\\".\\\\\\n \\\\\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems).\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Task Name\",\n \"description\": \"New Task Description\",\n \"assignees\": [\n 183\n ],\n \"archived\": false,\n \"group_assignees\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\"\n ],\n \"tags\": [\n \"tag name 1\"\n ],\n \"status\": \"Open\",\n \"priority\": 3,\n \"due_date\": 1508369194377,\n \"due_date_time\": false,\n \"time_estimate\": 8640000,\n \"start_date\": 1567780450202,\n \"start_date_time\": false,\n \"points\": 3,\n \"notify_all\": true,\n \"parent\": null,\n \"links_to\": null,\n \"check_required_custom_fields\": true,\n \"custom_fields\": [\n {\n \"id\": \"0a52c486-5f05-403b-b4fd-c512ff05131c\",\n \"value\": 23\n },\n {\n \"id\": \"03efda77-c7a0-42d3-8afd-fd546353c2f5\",\n \"value\": \"Text field input\"\n }\n ]\n }\n ]\n },\n \"example\": {\n \"name\": \"New Task Name\",\n \"description\": \"New Task Description\",\n \"markdown_description\": \"New Task Description\",\n \"assignees\": [\n 183\n ],\n \"archived\": false,\n \"group_assignees\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\"\n ],\n \"email_assignees\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f13\"\n ],\n \"tags\": [\n \"tag name 1\"\n ],\n \"status\": \"Open\",\n \"priority\": 3,\n \"due_date\": 1508369194377,\n \"due_date_time\": false,\n \"time_estimate\": 8640000,\n \"start_date\": 1567780450202,\n \"start_date_time\": false,\n \"points\": 3,\n \"notify_all\": true,\n \"parent\": null,\n \"links_to\": null,\n \"check_required_custom_fields\": true,\n \"custom_fields\": [\n {\n \"id\": \"0a52c486-5f05-403b-b4fd-c512ff05131c\",\n \"value\": \"This is a string of text added to a Custom Field.\"\n }\n ]\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "GetTask", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_task_details", + "description": { + "tagline": "Retrieve detailed information about a specific task.", + "detailed": "Use this tool to get detailed information on a task you have access to in ClickUp, including any attachments associated with the task." + }, + "return_annotation": "Detailed information about a specific task.", + "arguments": [ + { + "name": "task_identifier", + "alternative_names": [ + "task_id_input", + "task_reference" + ], + "description": "The unique identifier for the task you want to retrieve details for in ClickUp.", + "endpoint_argument_name": "task_id" + }, + { + "name": "workspace_id_for_custom_task", + "alternative_names": [ + "team_identifier_for_custom_task", + "workspace_identifier" + ], + "description": "Provide the Workspace ID when referencing a task by its custom task ID. Required if `custom_task_ids` is true.", + "endpoint_argument_name": "team_id" + }, + { + "name": "filter_custom_fields", + "alternative_names": [ + "custom_field_filters", + "filter_fields" + ], + "description": "Include tasks with specific values in one or more custom fields using the specified JSON format. Custom Relationships are supported.", + "endpoint_argument_name": "custom_fields" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "reference_by_custom_id", + "enable_custom_id_reference" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + }, + { + "name": "include_subtasks", + "alternative_names": [ + "add_subtasks", + "show_subtasks" + ], + "description": "Include subtasks in the task details if set to true. Defaults to false.", + "endpoint_argument_name": "include_subtasks" + }, + { + "name": "include_markdown_description", + "alternative_names": [ + "return_markdown_description", + "markdown_description_enabled" + ], + "description": "Set to true to return task descriptions in Markdown format.", + "endpoint_argument_name": "include_markdown_description" + } + ] + }, + "method": "GET", + "path": "/v2/task/{task_id}", + "tags": [ + "Tasks" + ], + "summary": "Get Task", + "description": "View information about a task. You can only view task information of tasks you can access. \\\n \\\nTasks with attachments will return an \"attachments\" response. \\\n \\\nDocs attached to a task are not returned.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by its custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "include_subtasks", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include subtasks, default false" + }, + "description": "Include subtasks, default false", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "include_markdown_description", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`." + }, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "custom_fields", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:filtertasks)" + }, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:filtertasks)", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "UpdateTask", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_task_in_clickup", + "description": { + "tagline": "Update task details in ClickUp.", + "detailed": "Use this tool to update specific fields of a task in ClickUp by providing the task ID and desired changes." + }, + "return_annotation": "Returns confirmation of the task update.", + "arguments": [ + { + "name": "task_identifier", + "alternative_names": [ + "task_id_value", + "id_of_task" + ], + "description": "The ID of the task to be updated. Provide either the standard task ID or a custom task ID if 'custom_task_ids' is true.", + "endpoint_argument_name": "task_id" + }, + { + "name": "task_update_details", + "alternative_names": [ + "task_update_payload", + "task_update_request" + ], + "description": "JSON object containing the fields to update on the task. Includes fields like name, description, priority, due dates, assignees, and more.", + "endpoint_argument_name": "requestBody" + }, + { + "name": "workspace_id_for_custom_task", + "alternative_names": [ + "clickup_team_id", + "workspace_identifier" + ], + "description": "Provide the Workspace ID when referencing a task by its custom task ID (requires `custom_task_ids` set to true).", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "reference_task_by_custom_id", + "enable_custom_task_id_reference" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "PUT", + "path": "/v2/task/{task_id}", + "tags": [ + "Tasks" + ], + "summary": "Update Task", + "description": "Update a task by including one or more fields in the request body.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by its custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "custom_item_id": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The custom task type ID for this task. A value of `null` (default) sets the task type to type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + }, + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To clear the task description, include `Description` with `\" \"`." + }, + "markdown_content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`." + }, + "status": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "priority": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "parent": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "You can move a subtask to another parent task by including `\"parent\"` with a valid `task id`.\\\n \\\nYou cannot convert a subtask to a task by setting `\"parent\"` to `null`." + }, + "time_estimate": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "points": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Update the task's Sprint Points." + }, + "assignees": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "add": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "rem": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + } + }, + "inner_properties": null, + "description": null + }, + "group_assignees": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "add": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "rem": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + } + }, + "inner_properties": null, + "description": null + }, + "watchers": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "add": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "rem": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + } + }, + "inner_properties": null, + "description": null + }, + "archived": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "***Note:** To update Custom Fields on a task, you must use the Set Custom Field endpoint.*" + }, + "description": "***Note:** To update Custom Fields on a task, you must use the Set Custom Field endpoint.*", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "UpdateTaskrequest", + "properties": { + "custom_item_id": { + "type": [ + "number", + "null" + ], + "description": "The custom task type ID for this task. A value of `null` (default) sets the task type to type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "description": "To clear the task description, include `Description` with `\" \"`." + }, + "markdown_content": { + "type": "string", + "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`." + }, + "status": { + "type": "string" + }, + "priority": { + "type": "integer" + }, + "due_date": { + "type": "integer" + }, + "due_date_time": { + "type": "boolean" + }, + "parent": { + "type": "string", + "description": "You can move a subtask to another parent task by including `\"parent\"` with a valid `task id`.\\\n \\\nYou cannot convert a subtask to a task by setting `\"parent\"` to `null`." + }, + "time_estimate": { + "type": "integer" + }, + "start_date": { + "type": "integer" + }, + "start_date_time": { + "type": "boolean" + }, + "points": { + "type": "number", + "description": "Update the task's Sprint Points." + }, + "assignees": { + "type": "object", + "title": "Assignees", + "properties": { + "add": { + "type": "array", + "description": "", + "items": { + "type": "integer" + } + }, + "rem": { + "type": "array", + "description": "", + "items": { + "type": "integer" + } + } + }, + "required": [ + "add", + "rem" + ] + }, + "group_assignees": { + "type": "object", + "properties": { + "add": { + "type": "array", + "description": "", + "items": { + "type": "integer" + } + }, + "rem": { + "type": "array", + "description": "", + "items": { + "type": "integer" + } + } + } + }, + "watchers": { + "type": "object", + "title": "Watchers", + "properties": { + "add": { + "type": "array", + "description": "", + "items": { + "type": "integer" + } + }, + "rem": { + "type": "array", + "description": "", + "items": { + "type": "integer" + } + } + }, + "required": [ + "add", + "rem" + ] + }, + "archived": { + "type": "boolean" + } + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"***Note:** To update Custom Fields on a task, you must use the Set Custom Field endpoint.*\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateTaskrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"custom_item_id\": {\n \"type\": [\n \"number\",\n \"null\"\n ],\n \"description\": \"The custom task type ID for this task. A value of `null` (default) sets the task type to type \\\"Task\\\".\\\\\\n \\\\\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems).\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"description\": \"To clear the task description, include `Description` with `\\\" \\\"`.\",\n \"type\": \"string\"\n },\n \"markdown_content\": {\n \"type\": \"string\",\n \"description\": \"Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`.\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"priority\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"due_date_time\": {\n \"type\": \"boolean\"\n },\n \"parent\": {\n \"description\": \"You can move a subtask to another parent task by including `\\\"parent\\\"` with a valid `task id`.\\\\\\n \\\\\\nYou cannot convert a subtask to a task by setting `\\\"parent\\\"` to `null`.\",\n \"type\": \"string\"\n },\n \"time_estimate\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"start_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"start_date_time\": {\n \"type\": \"boolean\"\n },\n \"points\": {\n \"type\": \"number\",\n \"description\": \"Update the task's Sprint Points.\"\n },\n \"assignees\": {\n \"title\": \"Assignees\",\n \"required\": [\n \"add\",\n \"rem\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"add\": [\n 182\n ],\n \"rem\": [\n 183\n ]\n }\n ]\n },\n \"group_assignees\": {\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n }\n }\n },\n \"watchers\": {\n \"title\": \"Watchers\",\n \"required\": [\n \"add\",\n \"rem\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"add\": [\n 182,\n 121\n ],\n \"rem\": [\n 183,\n 122\n ]\n }\n ]\n },\n \"archived\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Task Name\",\n \"description\": \"Updated Task Content\",\n \"status\": \"in progress\",\n \"priority\": 1,\n \"due_date\": 1508369194377,\n \"due_date_time\": false,\n \"parent\": \"abc1234\",\n \"time_estimate\": 8640000,\n \"start_date\": 1567780450202,\n \"start_date_time\": false,\n \"points\": 3,\n \"assignees\": {\n \"add\": [\n 182\n ],\n \"rem\": [\n 183\n ]\n },\n \"group_assignees\": {\n \"add\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\"\n ],\n \"rem\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f13\"\n ]\n },\n \"watchers\": {\n \"add\": [\n 182\n ],\n \"rem\": [\n 183\n ]\n },\n \"archived\": false\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Task Name\",\n \"description\": \"Updated Task Content\",\n \"status\": \"in progress\",\n \"priority\": 3,\n \"due_date\": 1508369194377,\n \"due_date_time\": false,\n \"parent\": \"abc1234\",\n \"time_estimate\": 8640000,\n \"start_date\": 1567780450202,\n \"start_date_time\": false,\n \"points\": 3,\n \"assignees\": {\n \"add\": [\n 182\n ],\n \"rem\": [\n 183\n ]\n },\n \"group_assignees\": {\n \"add\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\"\n ],\n \"rem\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f13\"\n ]\n },\n \"archived\": false\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "DeleteTask", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_task", + "description": { + "tagline": "Delete a task from your ClickUp Workspace.", + "detailed": "Use this tool to delete a specific task from your ClickUp Workspace by providing the task ID. It should be called when you want to permanently remove a task." + }, + "return_annotation": "Confirmation of the task deletion.", + "arguments": [ + { + "name": "task_id", + "alternative_names": [ + "task_identifier", + "task_reference" + ], + "description": "The ID of the task to be deleted. This is mandatory and should be a valid task identifier.", + "endpoint_argument_name": "task_id" + }, + { + "name": "content_type", + "alternative_names": [ + "mime_type", + "format_type" + ], + "description": "Specify the media type of the resource. Typically set as 'application/json'.", + "endpoint_argument_name": "Content-Type" + }, + { + "name": "workspace_id", + "alternative_names": [ + "workspace_identifier", + "team_identifier" + ], + "description": "Provide the Workspace ID when referencing a task by its custom task ID. Required if `custom_task_ids` is true.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "is_custom_task_id", + "reference_by_custom_task_id" + ], + "description": "Set to true if referencing a task by custom task ID is required.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "DELETE", + "path": "/v2/task/{task_id}", + "tags": [ + "Tasks" + ], + "summary": "Delete Task", + "description": "Delete a task from your Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by its custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetFilteredTeamTasks", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_filtered_team_tasks", + "description": { + "tagline": "Retrieve tasks from a workspace based on specified filters.", + "detailed": "This tool retrieves tasks from a specified workspace that meet certain criteria. The response is limited to 100 tasks per page, and only tasks that the user has access to are returned. The tool is useful for viewing filtered task information from multiple lists, folders, or spaces." + }, + "return_annotation": "A list of tasks that meet the specified criteria.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the workspace to retrieve tasks from. Must be an integer.", + "endpoint_argument_name": "team_Id" + }, + { + "name": "page_number_to_fetch", + "alternative_names": [ + "fetch_page_number", + "retrieve_page_number" + ], + "description": "Page number to fetch, starting at 0, in the paginated list of tasks.", + "endpoint_argument_name": "page" + }, + { + "name": "order_tasks_by", + "alternative_names": [ + "sort_tasks_by", + "arrange_by_field" + ], + "description": "Specify the field by which to order tasks. Options include: 'id', 'created', 'updated', 'due_date'. Defaults to 'created'.", + "endpoint_argument_name": "order_by" + }, + { + "name": "filter_by_space_ids", + "alternative_names": [ + "spaces_filter", + "select_spaces" + ], + "description": "An array of space IDs to filter tasks by. Example values: ['1234', '6789'].", + "endpoint_argument_name": "space_ids[]" + }, + { + "name": "filter_by_project_ids", + "alternative_names": [ + "filter_by_folder_ids", + "project_id_filters" + ], + "description": "An array of folder IDs to filter tasks by specific folders. For example, ['1234', '6789'].", + "endpoint_argument_name": "project_ids[]" + }, + { + "name": "filter_by_list_ids", + "alternative_names": [ + "list_filter_ids", + "filter_lists" + ], + "description": "An array of list IDs to filter tasks by. Example: [\"1234\", \"6789\"].", + "endpoint_argument_name": "list_ids[]" + }, + { + "name": "status_filters", + "alternative_names": [ + "task_statuses", + "statuses_filter" + ], + "description": "Filter tasks by their statuses. Use '%20' for spaces. Example: ['to%20do', 'in%20progress'].", + "endpoint_argument_name": "statuses[]" + }, + { + "name": "assignee_ids", + "alternative_names": [ + "assignee_user_ids", + "task_assignee_ids" + ], + "description": "Filter tasks by assignee using their ClickUp user IDs.", + "endpoint_argument_name": "assignees[]" + }, + { + "name": "filter_by_tags", + "alternative_names": [ + "tags_filter", + "task_tags" + ], + "description": "Filter tasks by tags. Use `%20` for spaces within tags. Example: `urgent%20task`.", + "endpoint_argument_name": "tags[]" + }, + { + "name": "due_date_greater_than", + "alternative_names": [ + "due_date_after", + "due_date_minimum" + ], + "description": "Filter tasks by a due date greater than the specified Unix time in milliseconds.", + "endpoint_argument_name": "due_date_gt" + }, + { + "name": "due_date_before", + "alternative_names": [ + "max_due_date", + "upper_due_date_limit" + ], + "description": "Filter tasks with due dates earlier than the specified Unix timestamp in milliseconds.", + "endpoint_argument_name": "due_date_lt" + }, + { + "name": "filter_created_date_after", + "alternative_names": [ + "created_after_date_filter", + "date_created_filter" + ], + "description": "Filter tasks by creation date greater than the specified Unix time in milliseconds.", + "endpoint_argument_name": "date_created_gt" + }, + { + "name": "filter_by_date_created_before", + "alternative_names": [ + "created_date_before", + "before_creation_date" + ], + "description": "Filter tasks created before this date. Specify as Unix time in milliseconds.", + "endpoint_argument_name": "date_created_lt" + }, + { + "name": "filter_by_updated_date_greater_than", + "alternative_names": [ + "updated_date_after_timestamp", + "minimum_updated_timestamp" + ], + "description": "Filter tasks by their updated date, greater than the specified Unix time in milliseconds.", + "endpoint_argument_name": "date_updated_gt" + }, + { + "name": "filter_by_update_date_before", + "alternative_names": [ + "update_date_before_filter", + "filter_tasks_by_update_date_before" + ], + "description": "Filter tasks updated before a specific date, provided as Unix time in milliseconds.", + "endpoint_argument_name": "date_updated_lt" + }, + { + "name": "filter_by_date_done_after", + "alternative_names": [ + "date_done_greater_than", + "done_after_date" + ], + "description": "Filter tasks by the completion date after the given Unix time in milliseconds.", + "endpoint_argument_name": "date_done_gt" + }, + { + "name": "filter_by_done_date_before", + "alternative_names": [ + "done_date_less_than", + "completed_before_date" + ], + "description": "Filter tasks completed before a specific date. Provide the date in Unix time (milliseconds).", + "endpoint_argument_name": "date_done_lt" + }, + { + "name": "filter_by_custom_fields", + "alternative_names": [ + "custom_fields_filter", + "tasks_with_custom_fields" + ], + "description": "Include tasks with specific values in Custom Fields. Provide an array of objects with field_id, operator, and value keys.", + "endpoint_argument_name": "custom_fields" + }, + { + "name": "parent_task_id", + "alternative_names": [ + "main_task_id", + "root_task_id" + ], + "description": "Include the parent task ID to return subtasks in the response.", + "endpoint_argument_name": "parent" + }, + { + "name": "custom_task_type_filters", + "alternative_names": [ + "custom_filters", + "task_type_filters" + ], + "description": "Filter tasks by custom task types. Use `0` for tasks, `1` for Milestones, and other numbers for Workspace-defined types.", + "endpoint_argument_name": "custom_items[]" + }, + { + "name": "display_tasks_in_reverse_order", + "alternative_names": [ + "reverse_task_display", + "invert_task_order" + ], + "description": "Set to true to display tasks in reverse order.", + "endpoint_argument_name": "reverse" + }, + { + "name": "include_subtasks", + "alternative_names": [ + "show_subtasks", + "with_subtasks" + ], + "description": "Set to true to include subtasks, or false to exclude them. Defaults to false (exclude).", + "endpoint_argument_name": "subtasks" + }, + { + "name": "include_closed_tasks", + "alternative_names": [ + "show_closed_tasks", + "filter_closed_tasks" + ], + "description": "Set to true to include closed tasks, false to exclude them. By default, closed tasks are excluded.", + "endpoint_argument_name": "include_closed" + }, + { + "name": "include_markdown_description", + "alternative_names": [ + "return_markdown_descriptions", + "enable_markdown_formatting" + ], + "description": "Set to true to return task descriptions in Markdown format. Default is false.", + "endpoint_argument_name": "include_markdown_description" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_Id}/task", + "tags": [ + "Tasks" + ], + "summary": "Get Filtered Team Tasks", + "description": "View the tasks that meet specific criteria from a Workspace. Responses are limited to 100 tasks per page. \\\n \\\nYou can only view task information of tasks you can access. \\\n \\\n Our Try It modal currently supports filtering by two or more Lists, Folders, or Spaces. To filter by a single List, Folder, or Space, we recommend using a free app like [Postman](https://www.postman.com/) to test our public API.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "page", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Page to fetch (starts at 0)." + }, + "description": "Page to fetch (starts at 0).", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "order_by", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`." + }, + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "reverse", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Tasks are displayed in reverse order." + }, + "description": "Tasks are displayed in reverse order.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "subtasks", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or exclude subtasks. By default, subtasks are excluded." + }, + "description": "Include or exclude subtasks. By default, subtasks are excluded.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "space_ids[]", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Spaces. For example: \\\n \\\n`?space_ids[]=1234&space_ids[]=6789`" + }, + "description": "Filter by Spaces. For example: \\\n \\\n`?space_ids[]=1234&space_ids[]=6789`", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "project_ids[]", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Folders. For example: \\\n \\\n`?project_ids[]=1234&project_ids[]=6789`" + }, + "description": "Filter by Folders. For example: \\\n \\\n`?project_ids[]=1234&project_ids[]=6789`", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "list_ids[]", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Lists. For example: \\\n \\\n`?list_ids[]=1234&list_ids[]=6789` " + }, + "description": "Filter by Lists. For example: \\\n \\\n`?list_ids[]=1234&list_ids[]=6789` ", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "statuses[]", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by statuses. Use `%20` to represent a space character. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`" + }, + "description": "Filter by statuses. Use `%20` to represent a space character. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "include_closed", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`." + }, + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "assignees[]", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Assignees using people's ClickUp user id. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`" + }, + "description": "Filter by Assignees using people's ClickUp user id. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "tags[]", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by tags. User `%20` to represent a space character. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`" + }, + "description": "Filter by tags. User `%20` to represent a space character. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "due_date_gt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date greater than Unix time in milliseconds." + }, + "description": "Filter by due date greater than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "due_date_lt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date less than Unix time in milliseconds." + }, + "description": "Filter by due date less than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_created_gt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created greater than Unix time in milliseconds." + }, + "description": "Filter by date created greater than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_created_lt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created less than Unix time in milliseconds." + }, + "description": "Filter by date created less than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_updated_gt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated greater than Unix time in milliseconds." + }, + "description": "Filter by date updated greater than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_updated_lt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated less than Unix time in milliseconds." + }, + "description": "Filter by date updated less than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_done_gt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done greater than Unix time in milliseconds." + }, + "description": "Filter by date done greater than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "date_done_lt", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done less than Unix time in milliseconds." + }, + "description": "Filter by date done less than Unix time in milliseconds.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "custom_fields", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"}{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. The `=` operator isn't supported with Label Custom Fields.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)" + }, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"}{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. The `=` operator isn't supported with Label Custom Fields.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "schema_required": false + }, + { + "name": "parent", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the parent task ID to return subtasks." + }, + "description": "Include the parent task ID to return subtasks.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "include_markdown_description", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`." + }, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "custom_items[]", + "value_schema": { + "val_type": "array", + "inner_val_type": "number", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace." + }, + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "array", + "items": { + "type": "number" + } + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_Id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "mergeTasks", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "merge_tasks_in_clickup", + "description": { + "tagline": "Merge multiple tasks into a target task in ClickUp.", + "detailed": "Use this tool to merge several tasks into a specified target task within ClickUp. The target task is identified by the task_id, with source tasks provided in the request. This is useful when consolidating tasks for better project management." + }, + "return_annotation": "Confirmation of tasks merged into a target task.", + "arguments": [ + { + "name": "target_task_id", + "alternative_names": [ + "destination_task_id", + "merge_task_target_id" + ], + "description": "ID of the target task into which other tasks will be merged.", + "endpoint_argument_name": "task_id" + }, + { + "name": "source_task_ids_to_merge", + "alternative_names": [ + "task_ids_to_merge", + "source_ids_for_merge" + ], + "description": "Array of task IDs to merge into the target task in ClickUp.", + "endpoint_argument_name": "source_task_ids" + } + ] + }, + "method": "POST", + "path": "/v2/task/{task_id}/merge", + "tags": [ + "Tasks" + ], + "summary": "Merge Tasks", + "description": "Merge multiple tasks into a target task. The target task is specified by the task_id parameter, while the source tasks to be merged are provided in the request body. Custom Task IDs are not supported.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the target task that other tasks will be merged into." + }, + "description": "ID of the target task that other tasks will be merged into.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "source_task_ids", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of task IDs to merge into the target task." + }, + "description": "Array of task IDs to merge into the target task.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "description": "Array of task IDs to merge into the target task.", + "items": { + "type": "string" + } + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"source_task_ids\"\n ],\n \"properties\": {\n \"source_task_ids\": {\n \"type\": \"array\",\n \"description\": \"Array of task IDs to merge into the target task.\",\n \"items\": {\n \"type\": \"string\"\n },\n \"examples\": [\n [\n \"abc123\",\n \"def456\"\n ]\n ]\n }\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "GetTask'sTimeinStatus", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "task_status_duration", + "description": { + "tagline": "Get the duration a task spends in each status.", + "detailed": "Use this tool to find out how long a task has been in each status. Ensure that the 'Total time in Status' ClickApp is enabled by the Workspace owner or admin before using this tool." + }, + "return_annotation": "Duration of a task in each status.", + "arguments": [ + { + "name": "task_identifier", + "alternative_names": [ + "task_id_value", + "task_reference_id" + ], + "description": "The unique identifier for the task you want to query. Use this to specify which task's status duration you are interested in.", + "endpoint_argument_name": "task_id" + }, + { + "name": "content_type", + "alternative_names": [ + "content_type_header", + "api_content_type" + ], + "description": "Specify the content type for the API request, typically 'application/json'.", + "endpoint_argument_name": "Content-Type" + }, + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The Workspace ID must be provided when referencing a task by its custom task ID and `custom_task_ids` is set to `true`.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "reference_custom_task_ids", + "enable_custom_task_ids" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "GET", + "path": "/v2/task/{task_id}/time_in_status", + "tags": [ + "Tasks" + ], + "summary": "Get Task's Time in Status", + "description": "View how long a task has been in each status. The Total time in Status ClickApp must first be enabled by the Workspace owner or an admin.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetBulkTasks'TimeinStatus", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_task_time_in_status", + "description": { + "tagline": "Retrieve duration of tasks in various statuses.", + "detailed": "Use this tool to find out how long multiple tasks have remained in each status. The Total Time in Status ClickApp must be enabled by the Workspace owner or an admin." + }, + "return_annotation": "Duration each task has spent in each status.", + "arguments": [ + { + "name": "task_ids_list", + "alternative_names": [ + "task_id_collection", + "bulk_task_ids" + ], + "description": "A list of up to 100 task IDs to check duration in status. Include each task ID separated by commas.", + "endpoint_argument_name": "task_ids" + }, + { + "name": "content_type_header", + "alternative_names": [ + "http_content_type", + "request_content_type" + ], + "description": "The MIME type of the body of the request. Typically set to 'application/json'.", + "endpoint_argument_name": "Content-Type" + }, + { + "name": "workspace_id_for_custom_task_ids", + "alternative_names": [ + "team_id_for_custom_tasks", + "workspace_identifier_for_custom_ids" + ], + "description": "Provide the Workspace ID if using custom task IDs. Required when `custom_task_ids` is `true`.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "reference_by_custom_id", + "enable_custom_id_usage" + ], + "description": "Set to true to reference tasks by custom task IDs.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "GET", + "path": "/v2/task/bulk_time_in_status/task_ids", + "tags": [ + "Tasks" + ], + "summary": "Get Bulk Tasks' Time in Status", + "description": "View how long two or more tasks have been in each status. The Total time in Status ClickApp must first be enabled by the Workspace owner or an admin.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "task_ids", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include this paramater once per `task_id`.\nYou can include up to 100 task ids per request.\nFor example: `task_ids=3cuh&task_ids=g4fs`" + }, + "description": "Include this paramater once per `task_id`.\nYou can include up to 100 task ids per request.\nFor example: `task_ids=3cuh&task_ids=g4fs`", + "required": true, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetTaskTemplates", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_task_templates", + "description": { + "tagline": "View available task templates in a workspace.", + "detailed": "Retrieve a list of task templates available for a specified workspace in ClickUp. Use this tool to explore task templates and plan tasks efficiently." + }, + "return_annotation": "List of task templates available in the specified workspace.", + "arguments": [ + { + "name": "page_number", + "alternative_names": [ + "pagination_page", + "page_index" + ], + "description": "The page number of results to retrieve. Used for pagination.", + "endpoint_argument_name": "page" + }, + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the workspace for which to retrieve task templates. This is used to specify the target workspace in ClickUp.", + "endpoint_argument_name": "team_id" + }, + { + "name": "content_type_header", + "alternative_names": [ + "content_type", + "header_content_type" + ], + "description": "Sets the 'Content-Type' for the API request, typically 'application/json'.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/taskTemplate", + "tags": [ + "Templates" + ], + "summary": "Get Task Templates", + "description": "View the task templates available in a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "page", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateTaskFromTemplate", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_task_from_template", + "description": { + "tagline": "Create a task using an existing template.", + "detailed": "This tool creates a new task in ClickUp using a specified task template from your workspace. Templates must be added to your Workspace before use. Ideal for automating the creation of standardized tasks." + }, + "return_annotation": "Details of the newly created task.", + "arguments": [ + { + "name": "target_list_id", + "alternative_names": [ + "list_identifier", + "destination_list_id" + ], + "description": "The ID of the list where the task will be created. This should be an integer associated with the desired list in your workspace.", + "endpoint_argument_name": "list_id" + }, + { + "name": "task_template_id", + "alternative_names": [ + "template_identifier", + "template_key" + ], + "description": "A string representing the ID of the task template to be used for task creation. Ensure the template is added to your workspace.", + "endpoint_argument_name": "template_id" + }, + { + "name": "task_name", + "alternative_names": [ + "task_title", + "new_task_name" + ], + "description": "The name of the task to be created using the template.", + "endpoint_argument_name": "name" + } + ] + }, + "method": "POST", + "path": "/v2/list/{list_id}/taskTemplate/{template_id}", + "tags": [ + "Tasks" + ], + "summary": "Create Task From Template", + "description": "Create a new task using a task template defined in your workspace. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "template_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateTaskFromTemplaterequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New task name\"\n }\n ]\n },\n \"example\": {\n \"name\": \"New task name\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "CreateFolderListFromTemplate", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_list_from_folder_template", + "description": { + "tagline": "Create a new list in a folder using a template.", + "detailed": "Use this tool to create a new list in a ClickUp folder using an existing list template. Ensure the template is added to your Workspace library before invoking this tool. The tool returns the future List ID immediately, though the list creation may continue asynchronously." + }, + "return_annotation": "Future List ID for the created list.", + "arguments": [ + { + "name": "folder_identifier", + "alternative_names": [ + "folder_reference_id", + "folder_id_value" + ], + "description": "The ID of the folder where the new list will be created using the specified template.", + "endpoint_argument_name": "folder_id" + }, + { + "name": "template_id_for_list_creation", + "alternative_names": [ + "list_template_id", + "folder_list_template_id" + ], + "description": "ID of the template to use for creating a new list in the folder. Ensure the template is added to your Workspace library.", + "endpoint_argument_name": "template_id" + }, + { + "name": "list_details", + "alternative_names": [ + "list_information", + "list_specifications" + ], + "description": "A JSON object containing the properties for the new list, such as 'name' for the list name and 'options' for additional configurations.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/folder/{folder_id}/list_template/{template_id}", + "tags": [ + "Lists" + ], + "summary": "Create List From Template in Folder", + "description": "Create a new list using a list template in a Folder. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\nThis request runs synchronously by default with `return_immediately=true`.\nThe request returns the future List ID immediatly, but the List may not be created when the response is sent.\nSmall templates can be applied synchronously, which guarantees that all sub objects are created.\nIn case of a timeout on synchronous requests, the objects from the template will continue to be created past the timeout.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "folder_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Folder where the List will be created" + }, + "description": "ID of the Folder where the List will be created", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "template_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the template to use" + }, + "description": "ID of the template to use", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Name of the new List" + }, + "options": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the new List" + }, + "options": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options" + } + }, + "required": [ + "name" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"name\"\n ],\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the new List\"\n },\n \"options\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options\"\n }\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "CreateSpaceListFromTemplate", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_list_from_template", + "description": { + "tagline": "Create a new list in a ClickUp space using a template.", + "detailed": "This tool creates a new list within a specified ClickUp space using a provided list template. Publicly shared templates must be added to the Workspace before they can be used. The operation can be performed asynchronously or synchronously based on the 'return_immediately' parameter." + }, + "return_annotation": "Details of the newly created list from the template.", + "arguments": [ + { + "name": "space_id_for_list_creation", + "alternative_names": [ + "target_space_id", + "destination_space_id" + ], + "description": "ID of the ClickUp Space where the new List will be created using the template.", + "endpoint_argument_name": "space_id" + }, + { + "name": "template_id", + "alternative_names": [ + "template_identifier", + "list_template_id" + ], + "description": "ID of the template to use for creating the list in the specified ClickUp space. It must be accessible in your Workspace.", + "endpoint_argument_name": "template_id" + }, + { + "name": "list_creation_options", + "alternative_names": [ + "list_options", + "creation_options" + ], + "description": "JSON object containing various settings for creating the list, such as 'name', 'options', and other specific parameters. Includes flags for aspects like importing automations, views, and subtasks, remapping dates, and more.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/space/{space_id}/list_template/{template_id}", + "tags": [ + "Lists" + ], + "summary": "Create List From Template in Space.", + "description": "Create a new List using a List template within a Space. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\nThis request can be run asynchronously or synchronously via the `return_immediately` parameter.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Space where the List will be created" + }, + "description": "ID of the Space where the List will be created", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "template_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the template to use" + }, + "description": "ID of the template to use", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Name of the new List" + }, + "options": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "return_immediately": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n" + }, + "content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "List description" + }, + "time_estimate": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include time (hours, minutes and seconds)" + }, + "automation": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import automation settings" + }, + "include_views": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import views" + }, + "old_due_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' due dates" + }, + "old_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' start dates" + }, + "old_followers": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' watchers" + }, + "comment_attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' comment attachments" + }, + "recur_settings": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' recurring settings" + }, + "old_tags": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' tags" + }, + "old_statuses": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' status settings" + }, + "subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' subtasks" + }, + "custom_type": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' task types" + }, + "old_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' assignees" + }, + "attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' attachments" + }, + "comment": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' comments" + }, + "old_status": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' current statuses" + }, + "external_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' external dependencies" + }, + "internal_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' internal dependencies" + }, + "priority": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' priorities" + }, + "custom_fields": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' Custom Fields" + }, + "old_checklists": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' checklists" + }, + "relationships": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' relationships" + }, + "old_subtask_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' subtask assignees" + }, + "start_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project start date for remapping dates" + }, + "due_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project due date for remapping dates" + }, + "remap_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Remap start dates" + }, + "skip_weekends": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Skip weekends when remapping dates" + }, + "archived": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "1", + "2", + "None" + ], + "properties": null, + "inner_properties": null, + "description": "Include archived tasks" + } + }, + "inner_properties": null, + "description": "Options for creating the List" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the new List" + }, + "options": { + "type": "object", + "description": "Options for creating the List", + "properties": { + "return_immediately": { + "type": "boolean", + "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n" + }, + "content": { + "type": "string", + "description": "List description" + }, + "time_estimate": { + "type": "number", + "description": "Include time (hours, minutes and seconds)" + }, + "automation": { + "type": "boolean", + "description": "Import automation settings" + }, + "include_views": { + "type": "boolean", + "description": "Import views" + }, + "old_due_date": { + "type": "boolean", + "description": "Import tasks' due dates" + }, + "old_start_date": { + "type": "boolean", + "description": "Import tasks' start dates" + }, + "old_followers": { + "type": "boolean", + "description": "Import tasks' watchers" + }, + "comment_attachments": { + "type": "boolean", + "description": "Import tasks' comment attachments" + }, + "recur_settings": { + "type": "boolean", + "description": "Import tasks' recurring settings" + }, + "old_tags": { + "type": "boolean", + "description": "Import tasks' tags" + }, + "old_statuses": { + "type": "boolean", + "description": "Import tasks' status settings" + }, + "subtasks": { + "type": "boolean", + "description": "Import tasks' subtasks" + }, + "custom_type": { + "type": "boolean", + "description": "Import tasks' task types" + }, + "old_assignees": { + "type": "boolean", + "description": "Import tasks' assignees" + }, + "attachments": { + "type": "boolean", + "description": "Import tasks' attachments" + }, + "comment": { + "type": "boolean", + "description": "Import tasks' comments" + }, + "old_status": { + "type": "boolean", + "description": "Import tasks' current statuses" + }, + "external_dependencies": { + "type": "boolean", + "description": "Import tasks' external dependencies" + }, + "internal_dependencies": { + "type": "boolean", + "description": "Import tasks' internal dependencies" + }, + "priority": { + "type": "boolean", + "description": "Import tasks' priorities" + }, + "custom_fields": { + "type": "boolean", + "description": "Import tasks' Custom Fields" + }, + "old_checklists": { + "type": "boolean", + "description": "Import tasks' checklists" + }, + "relationships": { + "type": "boolean", + "description": "Import tasks' relationships" + }, + "old_subtask_assignees": { + "type": "boolean", + "description": "Import tasks' subtask assignees" + }, + "start_date": { + "type": "string", + "description": "Project start date for remapping dates", + "format": "date-time" + }, + "due_date": { + "type": "string", + "description": "Project due date for remapping dates", + "format": "date-time" + }, + "remap_start_date": { + "type": "boolean", + "description": "Remap start dates" + }, + "skip_weekends": { + "type": "boolean", + "description": "Skip weekends when remapping dates" + }, + "archived": { + "type": "integer", + "description": "Include archived tasks", + "enum": [ + 1, + 2, + null + ] + } + } + } + }, + "required": [ + "name" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"name\"\n ],\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the new List\"\n },\n \"options\": {\n \"type\": \"object\",\n \"description\": \"Options for creating the List\",\n \"properties\": {\n \"return_immediately\": {\n \"type\": \"boolean\",\n \"description\": \"Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\\n\",\n \"default\": true\n },\n \"content\": {\n \"type\": \"string\",\n \"description\": \"List description\"\n },\n \"time_estimate\": {\n \"type\": \"number\",\n \"description\": \"Include time (hours, minutes and seconds)\"\n },\n \"automation\": {\n \"type\": \"boolean\",\n \"description\": \"Import automation settings\"\n },\n \"include_views\": {\n \"type\": \"boolean\",\n \"description\": \"Import views\"\n },\n \"old_due_date\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' due dates\"\n },\n \"old_start_date\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' start dates\"\n },\n \"old_followers\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' watchers\"\n },\n \"comment_attachments\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' comment attachments\"\n },\n \"recur_settings\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' recurring settings\"\n },\n \"old_tags\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' tags\"\n },\n \"old_statuses\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' status settings\"\n },\n \"subtasks\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' subtasks\"\n },\n \"custom_type\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' task types\"\n },\n \"old_assignees\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' assignees\"\n },\n \"attachments\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' attachments\"\n },\n \"comment\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' comments\"\n },\n \"old_status\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' current statuses\"\n },\n \"external_dependencies\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' external dependencies\"\n },\n \"internal_dependencies\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' internal dependencies\"\n },\n \"priority\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' priorities\"\n },\n \"custom_fields\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' Custom Fields\"\n },\n \"old_checklists\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' checklists\"\n },\n \"relationships\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' relationships\"\n },\n \"old_subtask_assignees\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' subtask assignees\"\n },\n \"start_date\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"Project start date for remapping dates\"\n },\n \"due_date\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"Project due date for remapping dates\"\n },\n \"remap_start_date\": {\n \"type\": \"boolean\",\n \"description\": \"Remap start dates\"\n },\n \"skip_weekends\": {\n \"type\": \"boolean\",\n \"description\": \"Skip weekends when remapping dates\"\n },\n \"archived\": {\n \"type\": \"integer\",\n \"enum\": [\n 1,\n 2,\n null\n ],\n \"description\": \"Include archived tasks\"\n }\n }\n }\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "GetWorkspaceseats", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_workspace_seat_details", + "description": { + "tagline": "Retrieve seat details for a workspace.", + "detailed": "Use this tool to view the used, total, and available member and guest seats for a specified workspace in ClickUp." + }, + "return_annotation": "Details about used, total, and available seats in a workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The unique ID of the workspace for which seat details are to be retrieved.", + "endpoint_argument_name": "team_id" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/seats", + "tags": [ + "Workspaces" + ], + "summary": "Get Workspace seats", + "description": "View the used, total, and available member and guest seats for a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetWorkspaceplan", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_workspace_plan", + "description": { + "tagline": "Retrieve the current subscription plan for a workspace.", + "detailed": "Use this tool to get details about the current subscription plan for a specified workspace in ClickUp. It should be called when you need to view the plan or pricing details associated with a workspace." + }, + "return_annotation": "Current subscription plan details for the specified workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The unique ID for the workspace whose subscription plan you want to retrieve.", + "endpoint_argument_name": "team_id" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/plan", + "tags": [ + "Workspaces" + ], + "summary": "Get Workspace Plan", + "description": "View the current [Plan](https://clickup.com/pricing) for the specified Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateUserGroup", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_user_group", + "description": { + "tagline": "Create a user group within a ClickUp workspace.", + "detailed": "Use this tool to organize and manage users by creating a user group within a specific ClickUp workspace. Note that adding a guest with view-only permissions converts them to a paid guest, potentially incurring additional costs." + }, + "return_annotation": "Details of the created user group in the workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The unique ID of the ClickUp workspace where the user group will be created.", + "endpoint_argument_name": "team_id" + }, + { + "name": "group_name", + "alternative_names": [ + "user_group_name", + "workspace_group_name" + ], + "description": "The name of the user group to be created within the workspace. This should be a descriptive name to identify the group easily.", + "endpoint_argument_name": "name" + }, + { + "name": "user_group_members", + "alternative_names": [ + "group_member_ids", + "workspace_user_ids" + ], + "description": "List of user IDs to include in the user group. Each ID should be an integer representing a user within the workspace.", + "endpoint_argument_name": "members" + }, + { + "name": "group_handle", + "alternative_names": [ + "group_identifier", + "user_group_handle" + ], + "description": "A unique string identifier for the user group to be created. This will be used as the group's handle within the workspace.", + "endpoint_argument_name": "handle" + } + ] + }, + "method": "POST", + "path": "/v2/team/{team_id}/group", + "tags": [ + "User Groups" + ], + "summary": "Create Group", + "description": "This endpoint creates a [User Group](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) within a Workspace.\\\n \\\nUser Groups are used to organize and manage users within a Workspace.\\\n \\\nIn the API documentation, `team_id` refers to the Workspace ID, and `group_id` refers to the User Group ID.\\\n \\\n**Note:** Adding a guest with view-only permissions to a Team automatically converts them to a paid guest.\\\n \\\nIf no paid guest seats are available, an additional member seat will be added, increasing the number of paid guest seats.\\\n \\\nThis change incurs a prorated charge based on the billing cycle.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "handle", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "members", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "description": "", + "items": { + "type": "integer" + } + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateTeamrequest\",\n \"required\": [\n \"name\",\n \"members\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"handle\": {\n \"type\": \"string\"\n },\n \"members\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New team name\",\n \"handle\": \"newteamname\",\n \"members\": [\n 123456,\n 987654\n ]\n }\n ]\n },\n \"example\": {\n \"name\": \"New User Group name\",\n \"handle\": \"newusergroupname\",\n \"members\": [\n 123456,\n 987654\n ]\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "GetCustomItems", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_workspace_custom_task_types", + "description": { + "tagline": "Retrieve custom task types for a specific workspace.", + "detailed": "Use this tool to view the custom task types available in a specified workspace. Ideal for gaining insight into workspace-specific configurations and custom workflows." + }, + "return_annotation": "Custom task types available in a workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the Workspace to retrieve custom task types for.", + "endpoint_argument_name": "team_id" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/custom_item", + "tags": [ + "Custom Task Types" + ], + "summary": "Get Custom Task Types", + "description": "View the custom task types available in a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "UpdateTeam", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_user_group", + "description": { + "tagline": "Update and manage user groups within a ClickUp Workspace.", + "detailed": "Use this tool to update user groups in your ClickUp Workspace. Useful for managing team membership, permissions, or configurations. Note that adding a guest with view-only permissions will incur additional charges as they convert to paid guests." + }, + "return_annotation": "Information about the updated User Group.", + "arguments": [ + { + "name": "user_group_id", + "alternative_names": [ + "group_identifier", + "user_group_identifier" + ], + "description": "The unique identifier of the User Group within the Workspace. This ID is required to specify which group to update.", + "endpoint_argument_name": "group_id" + }, + { + "name": "user_group_name", + "alternative_names": [ + "group_name", + "name_of_group" + ], + "description": "The new name for the User Group within the ClickUp Workspace. This should be a string representing the desired name.", + "endpoint_argument_name": "name" + }, + { + "name": "handle_identifier", + "alternative_names": [ + "group_handle", + "user_group_handle" + ], + "description": "A unique identifier or handle for the User Group. This is used to reference the group within ClickUp.", + "endpoint_argument_name": "handle" + }, + { + "name": "add_member_ids", + "alternative_names": [ + "add_user_ids", + "include_member_ids" + ], + "description": "An array of user IDs to add to the User Group. Each ID should be an integer.", + "endpoint_argument_name": "members.add" + }, + { + "name": "remove_members_ids", + "alternative_names": [ + "members_to_remove_ids", + "user_ids_to_remove" + ], + "description": "An array of integer IDs representing the users to be removed from the User Group.", + "endpoint_argument_name": "members.rem" + } + ] + }, + "method": "PUT", + "path": "/v2/group/{group_id}", + "tags": [ + "User Groups" + ], + "summary": "Update Group", + "description": "This endpoint is used to manage [User Groups](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups), which are groups of users within your Workspace.\\\n \\\nIn our API, `team_id` in the path refers to the Workspace ID, and `group_id` refers to the ID of a User Group.\\\n \\\n**Note:** Adding a guest with view-only permissions to a User Group automatically converts them to a paid guest.\\\n \\\nIf you don't have any paid guest seats available, a new member seat is automatically added to increase the number of paid guest seats.\\\n \\\nThis incurs a prorated charge based on your billing cycle.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "group_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "User Group ID" + }, + "description": "User Group ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "handle", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "members.add", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "description": "", + "items": { + "type": "integer" + } + }, + "schema_required": false + }, + { + "name": "members.rem", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "description": "", + "items": { + "type": "integer" + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"The group handle can be updated, which is used to @mention a User Group within the Workspace.\\\\\\n \\\\\\nModify Group members by using the \\\"add\\\" and \\\"rem\\\" parameters with an array of user IDs to include or exclude members.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateTeamrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"handle\": {\n \"type\": \"string\"\n },\n \"members\": {\n \"title\": \"Members2\",\n \"required\": [\n \"add\",\n \"rem\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"add\": [\n 123456,\n 987654\n ],\n \"rem\": [\n 159753\n ]\n }\n ]\n }\n },\n \"examples\": [\n {\n \"name\": \"New User Group Name\",\n \"handle\": \"newusergroupname\",\n \"members\": {\n \"add\": [\n 123456,\n 987654\n ],\n \"rem\": [\n 159753\n ]\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New User Group Name\",\n \"handle\": \"newusergroupname\",\n \"members\": {\n \"add\": [\n 123456,\n 987654\n ],\n \"rem\": [\n 159753\n ]\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "DeleteTeam", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_user_group", + "description": { + "tagline": "Delete a user group from your ClickUp workspace.", + "detailed": "This tool removes a user group from your ClickUp workspace based on the provided group ID." + }, + "return_annotation": "Confirmation of user group deletion from the workspace.", + "arguments": [ + { + "name": "user_group_id", + "alternative_names": [ + "group_identifier", + "group_id" + ], + "description": "The identifier of the user group to be deleted from the workspace.", + "endpoint_argument_name": "group_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/group/{group_id}", + "tags": [ + "User Groups" + ], + "summary": "Delete Group", + "description": "This endpoint is used to remove a [User Group](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) from your Workspace.\\\n \\\nIn our API documentation, `team_id` refers to the id of a Workspace, and `group_id` refers to the id of a user group.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "group_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "User Group ID" + }, + "description": "User Group ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetTeams1", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_user_groups_in_workspace", + "description": { + "tagline": "Retrieve user groups in a ClickUp workspace.", + "detailed": "Use this tool to view the user groups within a specific ClickUp workspace. It's useful for managing and organizing user permissions and roles within a team environment." + }, + "return_annotation": "Details of user groups in a workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "workspace_identifier", + "workspace_id_number" + ], + "description": "The ID of the ClickUp workspace to retrieve user groups from.", + "endpoint_argument_name": "team_id" + }, + { + "name": "user_group_ids", + "alternative_names": [ + "group_identifiers", + "group_id_list" + ], + "description": "List one or more User Group IDs to retrieve details about specific user groups in the workspace.", + "endpoint_argument_name": "group_ids" + } + ] + }, + "method": "GET", + "path": "/v2/group", + "tags": [ + "User Groups" + ], + "summary": "Get Groups", + "description": "This endpoint is used to view [User Groups](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) in your Workspace.\\\n \\\nIn our API documentation, `team_id` refers to the ID of a Workspace, and `group_id` refers to the ID of a User Group.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "group_ids", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter one or more User Group IDs to retrieve information about specific User Group." + }, + "description": "Enter one or more User Group IDs to retrieve information about specific User Group.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "path": [], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "Gettrackedtime", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_tracked_time_for_task", + "description": { + "tagline": "Fetch tracked time for a specific task.", + "detailed": "Use this tool to get the tracked time recorded for a specific task in ClickUp. It's useful for retrieving time spent details on tasks, though it doesn't handle new time entries." + }, + "return_annotation": "Tracked time details for a specific task.", + "arguments": [ + { + "name": "task_id", + "alternative_names": [ + "task_identifier", + "task_reference_id" + ], + "description": "The unique identifier for the task whose tracked time you want to retrieve.", + "endpoint_argument_name": "task_id" + }, + { + "name": "set_content_type_header", + "alternative_names": [ + "define_content_type", + "specify_content_header" + ], + "description": "Set the Content-Type header for the request, typically as 'application/json'.", + "endpoint_argument_name": "Content-Type" + }, + { + "name": "workspace_id", + "alternative_names": [ + "workspace_identifier", + "team_identifier" + ], + "description": "The ID of the Workspace to be provided when referencing a task by its custom task ID. Required if `custom_task_ids` is `true`.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_task_ids", + "custom_ids_usage" + ], + "description": "Set to true to reference tasks by their custom task IDs instead of default IDs.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "GET", + "path": "/v2/task/{task_id}/time", + "tags": [ + "Time Tracking (Legacy)" + ], + "summary": "Get tracked time", + "description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "Tracktime", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "clickup_legacy_time_tracking", + "description": { + "tagline": "Log time entry for a ClickUp task using legacy endpoint.", + "detailed": "This tool allows logging time entries for a specific ClickUp task using a legacy API endpoint. It should be called when you need to record time spent on tasks, although it's recommended to use the updated Time Tracking API for new implementations." + }, + "return_annotation": "Confirmation of time entry being logged for a task.", + "arguments": [ + { + "name": "clickup_task_id", + "alternative_names": [ + "clickup_task_reference_id", + "clickup_task_identifier" + ], + "description": "The unique identifier of the task for which time is being logged. This can refer to either the standard task ID or a custom task ID if specified.", + "endpoint_argument_name": "task_id" + }, + { + "name": "start_time_unix_epoch", + "alternative_names": [ + "start_time_unix", + "start_timestamp_epoch" + ], + "description": "The start time of the time entry in Unix epoch format. This is required to log time for a task.", + "endpoint_argument_name": "start" + }, + { + "name": "end_timestamp", + "alternative_names": [ + "stop_time", + "finish_time" + ], + "description": "Epoch timestamp indicating when the time tracking ended for the task.", + "endpoint_argument_name": "end" + }, + { + "name": "time_spent_seconds", + "alternative_names": [ + "duration_seconds", + "work_duration_seconds" + ], + "description": "Duration of time spent on the task in seconds. This is the time you want to log for the specific task.", + "endpoint_argument_name": "time" + }, + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "custom_task_workspace_id" + ], + "description": "Provide the Workspace ID when `custom_task_ids` is `true`.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "custom_task_id_reference", + "enable_custom_task_ids" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "POST", + "path": "/v2/task/{task_id}/time", + "tags": [ + "Time Tracking (Legacy)" + ], + "summary": "Track time", + "description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "start", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + }, + { + "name": "end", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + }, + { + "name": "time", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"Include the total time or the start time and end time.\\\\\\n \\\\\\nThe total time is in milliseconds and `\\\"start\\\"` and `\\\"end\\\"` values are Unix time in milliseconds.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Tracktimerequest\",\n \"required\": [\n \"start\",\n \"end\",\n \"time\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"start\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"end\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"time\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"start\": 1567780450202,\n \"end\": 1508369194377,\n \"time\": 8640000\n }\n ]\n },\n \"example\": {\n \"start\": 1567780450202,\n \"end\": 1508369194377,\n \"time\": 8640000\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "Edittimetracked", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "edit_legacy_time_entry", + "description": { + "tagline": "Edit a legacy time tracked entry for a task in ClickUp.", + "detailed": "Use this tool to modify an existing time entry on a specific task using the legacy endpoint in ClickUp. It's recommended to use newer APIs for time tracking, but this can be used for older integrations." + }, + "return_annotation": "Confirmation of time entry update.", + "arguments": [ + { + "name": "task_identifier", + "alternative_names": [ + "task_id_reference", + "task_id_value" + ], + "description": "The unique identifier of the task for which the legacy time entry is being edited. This is required to specify the task in ClickUp.", + "endpoint_argument_name": "task_id" + }, + { + "name": "legacy_time_interval_id", + "alternative_names": [ + "legacy_time_entry_id", + "time_tracking_interval_id" + ], + "description": "The unique identifier for the time interval to be edited.", + "endpoint_argument_name": "interval_id" + }, + { + "name": "start_timestamp", + "alternative_names": [ + "start_time_unix", + "start_time_epoch" + ], + "description": "The start time of the time entry as a Unix timestamp in milliseconds.", + "endpoint_argument_name": "start" + }, + { + "name": "end_time_epoch", + "alternative_names": [ + "ending_timestamp", + "finish_time_epoch" + ], + "description": "The end time of the tracked interval in Unix epoch format. It marks when the time entry should conclude.", + "endpoint_argument_name": "end" + }, + { + "name": "time_duration_in_seconds", + "alternative_names": [ + "duration_seconds", + "total_time_seconds" + ], + "description": "The total time duration (in seconds) for the time entry to be updated. This modifies the tracked time for a specific task.", + "endpoint_argument_name": "time" + }, + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The Workspace ID required when custom task IDs are used. This must be set if `custom_task_ids` is `true`.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_task_reference", + "custom_id_usage" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "PUT", + "path": "/v2/task/{task_id}/time/{interval_id}", + "tags": [ + "Time Tracking (Legacy)" + ], + "summary": "Edit time tracked", + "description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "interval_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "start", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + }, + { + "name": "end", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + }, + { + "name": "time", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"Edit the start, end, or total time of a time tracked entry.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Edittimetrackedrequest\",\n \"required\": [\n \"start\",\n \"end\",\n \"time\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"start\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"end\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"time\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"start\": 1567780450202,\n \"end\": 1508369194377,\n \"time\": 8640000\n }\n ]\n },\n \"example\": {\n \"start\": 1567780450202,\n \"end\": 1508369194377,\n \"time\": 8640000\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "Deletetimetracked", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_time_entry", + "description": { + "tagline": "Delete a specific time entry from a task.", + "detailed": "Use this tool to delete a specific time tracking entry from a task. It's useful for managing or correcting time logs by removing unwanted entries." + }, + "return_annotation": "Confirms deletion of a specific time entry from a task.", + "arguments": [ + { + "name": "task_identifier", + "alternative_names": [ + "task_id_tool", + "task_reference" + ], + "description": "The identifier of the task from which to delete the time entry. This must match the task ID used in ClickUp.", + "endpoint_argument_name": "task_id" + }, + { + "name": "interval_id_for_removal", + "alternative_names": [ + "time_entry_id", + "time_interval_id" + ], + "description": "The unique identifier of the time entry to delete from a task.", + "endpoint_argument_name": "interval_id" + }, + { + "name": "content_type_header", + "alternative_names": [ + "content_type", + "header_content_type" + ], + "description": "Specify the media type of the resource (usually 'application/json').", + "endpoint_argument_name": "Content-Type" + }, + { + "name": "workspace_id", + "alternative_names": [ + "team_workspace_id", + "workspace_identifier" + ], + "description": "Provide the Workspace ID when `use_custom_task_ids` is `true`. Required to identify the workspace in ClickUp.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "reference_by_custom_id", + "enable_custom_task_id" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "DELETE", + "path": "/v2/task/{task_id}/time/{interval_id}", + "tags": [ + "Time Tracking (Legacy)" + ], + "summary": "Delete time tracked", + "description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "interval_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "Gettimeentrieswithinadaterange", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_time_entries_in_date_range", + "description": { + "tagline": "Retrieve time entries within a specified date range.", + "detailed": "Use this tool to view time entries filtered by start and end dates. By default, it returns entries from the last 30 days for the authenticated user. To access entries for other users, use the 'assignee' parameter. You may apply location filters with 'space_id', 'folder_id', 'list_id', or 'task_id', but only one at a time. Note: Negative duration entries indicate a running timer." + }, + "return_annotation": "Time entries filtered by date range and optional parameters.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_id", + "workspace_identifier" + ], + "description": "Specify the Workspace ID for filtering time entries when using custom task IDs.", + "endpoint_argument_name": "team_Id" + }, + { + "name": "content_type", + "alternative_names": [ + "http_content_type", + "response_content_type" + ], + "description": "Specifies the format of the response content. Usually set to 'application/json'.", + "endpoint_argument_name": "Content-Type" + }, + { + "name": "start_date_in_unix_milliseconds", + "alternative_names": [ + "unix_start_date", + "start_date_unix_ms" + ], + "description": "The start date of the time entries in Unix time (milliseconds).", + "endpoint_argument_name": "start_date" + }, + { + "name": "end_date_unix_milliseconds", + "alternative_names": [ + "end_time_unix_milliseconds", + "end_timestamp_unix_milliseconds" + ], + "description": "Specify the end date in Unix time (milliseconds) to filter time entries up to this point.", + "endpoint_argument_name": "end_date" + }, + { + "name": "filter_by_assignee", + "alternative_names": [ + "assignee_ids", + "user_filter" + ], + "description": "Filter by user IDs. Use commas to separate multiple IDs (e.g., '1234,9876'). Only accessible to Workspace Owners/Admins.", + "endpoint_argument_name": "assignee" + }, + { + "name": "space_id", + "alternative_names": [ + "specific_space_id", + "task_space_id" + ], + "description": "Include time entries associated only with tasks in the specified Space using its ID.", + "endpoint_argument_name": "space_id" + }, + { + "name": "folder_id", + "alternative_names": [ + "specific_folder_id", + "task_folder_id" + ], + "description": "Include time entries for tasks in a specific folder by providing its ID. Only one location filter (space, folder, list, or task) can be used at a time.", + "endpoint_argument_name": "folder_id" + }, + { + "name": "specific_list_id", + "alternative_names": [ + "target_list_id", + "list_identifier" + ], + "description": "Include only time entries associated with tasks in a specified List by providing the List ID.", + "endpoint_argument_name": "list_id" + }, + { + "name": "specific_task_id", + "alternative_names": [ + "designated_task_id", + "task_id_filter" + ], + "description": "Include only time entries associated with the specified task.", + "endpoint_argument_name": "task_id" + }, + { + "name": "workspace_id_for_custom_task_ids", + "alternative_names": [ + "custom_task_workspace_id", + "workspace_identifier_for_custom_tasks" + ], + "description": "Provide the Workspace ID when referencing a task by its custom task ID, and `custom_task_ids` is set to true.", + "endpoint_argument_name": "team_id" + }, + { + "name": "include_task_tags", + "alternative_names": [ + "add_task_tags_to_response", + "with_task_tags_included" + ], + "description": "Set to true to include task tags in the response for associated time entries.", + "endpoint_argument_name": "include_task_tags" + }, + { + "name": "include_location_names", + "alternative_names": [ + "show_location_names", + "display_location_names" + ], + "description": "Include the names of the List, Folder, and Space in the response along with their IDs when set to true.", + "endpoint_argument_name": "include_location_names" + }, + { + "name": "include_approval_history", + "alternative_names": [ + "approval_history", + "include_approval_change_history" + ], + "description": "Set to true to include the approval history for each time entry, with status changes, notes, and approvers.", + "endpoint_argument_name": "include_approval_history" + }, + { + "name": "include_approval_details", + "alternative_names": [ + "add_approval_details", + "show_approval_details" + ], + "description": "Include detailed approval information for each time entry, such as Approver ID, Approved Time, List of Approvers, and Approval Status.", + "endpoint_argument_name": "include_approval_details" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_task_id_reference", + "custom_task_id_id_mode" + ], + "description": "Set to true to reference tasks by their custom task IDs. Requires specifying the team_id.", + "endpoint_argument_name": "custom_task_ids" + }, + { + "name": "include_only_billable_entries", + "alternative_names": [ + "restrict_to_billing_status", + "limit_by_billability" + ], + "description": "Set to `true` to include only billable time entries, or `false` for non-billable entries.", + "endpoint_argument_name": "is_billable" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_Id}/time_entries", + "tags": [ + "Time Tracking" + ], + "summary": "Get time entries within a date range", + "description": "View time entries filtered by start and end date. \\\n \\\nBy default, this endpoint returns time entries from the last 30 days created by the authenticated user. \\\n \\\nTo retrieve time entries for other users, you must include the `assignee` query parameter. \\\n \\\nOnly one of the following location filters can be included at a time: `space_id`, `folder_id`, `list_id`, or `task_id`. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "start_date", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Unix time in milliseconds" + }, + "description": "Unix time in milliseconds", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "end_date", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Unix time in milliseconds" + }, + "description": "Unix time in milliseconds", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "assignee", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by `user_id`. For multiple assignees, separate `user_id` using commas.\\\n \\\n **Example:** `assignee=1234,9876`\\\n \\\n***Note:** Only Workspace Owners/Admins have access to do this.*" + }, + "description": "Filter by `user_id`. For multiple assignees, separate `user_id` using commas.\\\n \\\n **Example:** `assignee=1234,9876`\\\n \\\n***Note:** Only Workspace Owners/Admins have access to do this.*", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "include_task_tags", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include task tags in the response for time entries associated with tasks." + }, + "description": "Include task tags in the response for time entries associated with tasks.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "include_location_names", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the names of the List, Folder, and Space along with the `list_id`,`folder_id`, and `space_id`." + }, + "description": "Include the names of the List, Folder, and Space along with the `list_id`,`folder_id`, and `space_id`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "include_approval_history", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the history of the approval for each time entry. Adds status changes, notes, and approvers." + }, + "description": "Include the history of the approval for each time entry. Adds status changes, notes, and approvers.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "include_approval_details", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the details of the approval for each time entry. Adds Approver ID, Approved Time, List of Approvers, and Approval Status." + }, + "description": "Include the details of the approval for each time entry. Adds Approver ID, Approved Time, List of Approvers, and Approval Status.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with tasks in a specific Space." + }, + "description": "Only include time entries associated with tasks in a specific Space.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with tasks in a specific Folder." + }, + "description": "Only include time entries associated with tasks in a specific Folder.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with tasks in a specific List." + }, + "description": "Only include time entries associated with tasks in a specific List.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with a specific task." + }, + "description": "Only include time entries associated with a specific task.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + }, + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "is_billable", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include only billable time entries by using a value of `true` or only non-billable time entries by using a value of `false`.\\\n \\\nFor example: `?is_billable=true`." + }, + "description": "Include only billable time entries by using a value of `true` or only non-billable time entries by using a value of `false`.\\\n \\\nFor example: `?is_billable=true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_Id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "Createatimeentry", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_time_entry", + "description": { + "tagline": "Create a new time entry for tracking work.", + "detailed": "Use this tool to log a new time entry for a specific team. If the duration is negative, it indicates that a timer is running for the user." + }, + "return_annotation": "Information about the created time entry.", + "arguments": [ + { + "name": "team_id_numeric", + "alternative_names": [ + "team_id_numeric", + "workspace_identifier" + ], + "description": "The numeric ID of the workspace. Required if referencing a task by custom task ID.", + "endpoint_argument_name": "team_Id" + }, + { + "name": "time_entry_details", + "alternative_names": [ + "entry_details", + "work_time_details" + ], + "description": "JSON object providing details for the time entry, including 'description', 'start', 'stop', 'tags', 'billable', 'assignee', 'tid'.", + "endpoint_argument_name": "requestBody" + }, + { + "name": "workspace_id", + "alternative_names": [ + "team_workspace_id", + "workspace_identifier" + ], + "description": "Required if `custom_task_ids` is true. Provide the Workspace ID for the team.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_task_ids", + "custom_ids_usage" + ], + "description": "Set to true to reference a task by its custom task id.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "POST", + "path": "/v2/team/{team_Id}/time_entries", + "tags": [ + "Time Tracking" + ], + "summary": "Create a time entry", + "description": "Create a time entry. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_Id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tag_fg": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tag_bg": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "description": "Users on the Business Plan and above can include a time tracking label." + }, + "start": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "stop": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The `duration` parameter can be used instead of the `stop` parameter. " + }, + "end": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "billable": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "duration": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When there are values for both `start` and `end`, `duration` is ignored. The `stop` parameter can be used instead of the `duration` parameter." + }, + "assignee": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace owners and admins can include any user id. Workspace members can only include their own user id." + }, + "tid": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "Associate a time entry with a task using the `tid` parameter." + }, + "description": "Associate a time entry with a task using the `tid` parameter.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "Createatimeentryrequest", + "properties": { + "description": { + "type": "string" + }, + "tags": { + "type": "array", + "description": "Users on the Business Plan and above can include a time tracking label.", + "items": { + "type": "object", + "title": "Tags6", + "properties": { + "name": { + "type": "string" + }, + "tag_fg": { + "type": "string" + }, + "tag_bg": { + "type": "string" + } + }, + "required": [ + "name", + "tag_fg", + "tag_bg" + ] + } + }, + "start": { + "type": "integer" + }, + "stop": { + "type": "integer", + "description": "The `duration` parameter can be used instead of the `stop` parameter. " + }, + "end": { + "type": "integer" + }, + "billable": { + "type": "boolean" + }, + "duration": { + "type": "integer", + "description": "When there are values for both `start` and `end`, `duration` is ignored. The `stop` parameter can be used instead of the `duration` parameter." + }, + "assignee": { + "type": "integer", + "description": "Workspace owners and admins can include any user id. Workspace members can only include their own user id." + }, + "tid": { + "type": "string" + } + }, + "required": [ + "start", + "duration" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"Associate a time entry with a task using the `tid` parameter.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Createatimeentryrequest\",\n \"required\": [\n \"start\",\n \"duration\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\"\n },\n \"tags\": {\n \"description\": \"Users on the Business Plan and above can include a time tracking label.\",\n \"type\": \"array\",\n \"items\": {\n \"title\": \"Tags6\",\n \"required\": [\n \"name\",\n \"tag_fg\",\n \"tag_bg\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"tag_fg\": {\n \"type\": \"string\"\n },\n \"tag_bg\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Tag name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n ]\n }\n },\n \"start\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"stop\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\",\n \"description\": \"The `duration` parameter can be used instead of the `stop` parameter. \"\n },\n \"end\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"billable\": {\n \"type\": \"boolean\"\n },\n \"duration\": {\n \"description\": \"When there are values for both `start` and `end`, `duration` is ignored. The `stop` parameter can be used instead of the `duration` parameter.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"assignee\": {\n \"description\": \"Workspace owners and admins can include any user id. Workspace members can only include their own user id.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"tid\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"description\": \"from api\",\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ],\n \"start\": 1595282645000,\n \"end\": 1595282660000,\n \"billable\": true,\n \"duration\": 50000,\n \"assignee\": 1,\n \"tid\": \"task_id\"\n }\n ]\n },\n \"example\": {\n \"description\": \"from api\",\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ],\n \"start\": 1595282645000,\n \"billable\": true,\n \"duration\": 50000,\n \"assignee\": 1,\n \"tid\": \"task_id\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "Getsingulartimeentry", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_time_entry", + "description": { + "tagline": "Retrieve details of a specific time entry.", + "detailed": "Use this tool to view information about a single time entry, including its duration. If the duration is negative, it indicates an active timer for the user." + }, + "return_annotation": "Details of a specific time entry.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the workspace (team) to which the time entry belongs.", + "endpoint_argument_name": "team_id" + }, + { + "name": "time_entry_id", + "alternative_names": [ + "entry_timer_id", + "time_log_id" + ], + "description": "The ID of a specific time entry, which can be found using the Get Time Entries Within a Date Range endpoint.", + "endpoint_argument_name": "timer_id" + }, + { + "name": "content_type", + "alternative_names": [ + "response_format", + "data_type" + ], + "description": "Specifies the format of the content being sent or received, such as 'application/json'.", + "endpoint_argument_name": "Content-Type" + }, + { + "name": "include_task_tags", + "alternative_names": [ + "show_task_tags", + "display_task_tags" + ], + "description": "Set to true to include task tags in the response.", + "endpoint_argument_name": "include_task_tags" + }, + { + "name": "include_location_names", + "alternative_names": [ + "show_location_names", + "add_location_names" + ], + "description": "Include names of the List, Folder, and Space in the response along with their respective IDs.", + "endpoint_argument_name": "include_location_names" + }, + { + "name": "include_approval_history", + "alternative_names": [ + "add_approval_history", + "show_approval_history" + ], + "description": "Include the approval history of the time entry in the response. Set to true to include.", + "endpoint_argument_name": "include_approval_history" + }, + { + "name": "include_approval_details", + "alternative_names": [ + "show_approval_details", + "fetch_approval_details" + ], + "description": "Include the details of the approval for the time entry when true.", + "endpoint_argument_name": "include_approval_details" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/time_entries/{timer_id}", + "tags": [ + "Time Tracking" + ], + "summary": "Get singular time entry", + "description": "View a single time entry. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "include_task_tags", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include task tags in the response for time entries associated with tasks." + }, + "description": "Include task tags in the response for time entries associated with tasks.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "include_location_names", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`." + }, + "description": "Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "include_approval_history", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the history of the approval for the time entry." + }, + "description": "Include the history of the approval for the time entry.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "include_approval_details", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the details of the approval for the time entry." + }, + "description": "Include the details of the approval for the time entry.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "timer_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint." + }, + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "DeleteatimeEntry", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_time_entry", + "description": { + "tagline": "Deletes a time entry from a ClickUp workspace.", + "detailed": "Use this tool to delete a specific time entry from a ClickUp workspace. This should be called when you need to remove a recorded time entry by specifying the team and timer identifiers." + }, + "return_annotation": "Confirmation of time entry deletion.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The unique identifier for the ClickUp workspace from which you want to delete the time entry.", + "endpoint_argument_name": "team_id" + }, + { + "name": "timer_ids_to_delete", + "alternative_names": [ + "timer_ids", + "ids_for_deletion" + ], + "description": "Comma-separated list of timer IDs to delete.", + "endpoint_argument_name": "timer_id" + }, + { + "name": "content_type_header", + "alternative_names": [ + "mime_type_header", + "data_format_header" + ], + "description": "Specify the content type of the request, usually 'application/json'.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "DELETE", + "path": "/v2/team/{team_id}/time_entries/{timer_id}", + "tags": [ + "Time Tracking" + ], + "summary": "Delete a time Entry", + "description": "Delete a time entry from a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "timer_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of timer ids to delete separated by commas" + }, + "description": "Array of timer ids to delete separated by commas", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "UpdateatimeEntry", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_time_entry", + "description": { + "tagline": "Update the details of a time entry.", + "detailed": "This tool updates specific details of a time entry in ClickUp. Use it when you need to modify data such as the duration, description, or other attributes of an existing time entry." + }, + "return_annotation": "Confirmation of updated time entry details.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "space_id" + ], + "description": "The Workspace ID is required when referencing a task by its custom task ID. Provide it if `custom_task_ids` is set to `true`.", + "endpoint_argument_name": "team_id" + }, + { + "name": "team_identifier", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the workspace (team) where the time entry is located. This is an integer value.", + "endpoint_argument_name": "team_id" + }, + { + "name": "timer_id", + "alternative_names": [ + "time_entry_identifier", + "entry_id" + ], + "description": "The unique identifier of the time entry to be updated.", + "endpoint_argument_name": "timer_id" + }, + { + "name": "time_entry_details", + "alternative_names": [ + "time_entry_data", + "entry_update_data" + ], + "description": "Details for updating the time entry, including description, tags, start, end times, and other attributes.", + "endpoint_argument_name": "requestBody" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_task_ids", + "custom_task_id_reference" + ], + "description": "Set to true to reference tasks by custom task IDs instead of standard IDs.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "PUT", + "path": "/v2/team/{team_id}/time_entries/{timer_id}", + "tags": [ + "Time Tracking" + ], + "summary": "Update a time Entry", + "description": "Update the details of a time entry.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`" + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "timer_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "Users on the Business Plan and above can include a time tracking label." + }, + "tag_action": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When providing `start`, you must also provide `end`." + }, + "end": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When providing `end`, you must also provide `start`." + }, + "tid": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "billable": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "duration": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "Accessible tag actions are `[\"replace\", \"add\", \"remove\"]`" + }, + "description": "Accessible tag actions are `[\"replace\", \"add\", \"remove\"]`", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "UpdateatimeEntryrequest", + "properties": { + "description": { + "type": "string" + }, + "tags": { + "type": "array", + "description": "Users on the Business Plan and above can include a time tracking label.", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items" + } + }, + "tag_action": { + "type": "string" + }, + "start": { + "type": "integer", + "description": "When providing `start`, you must also provide `end`." + }, + "end": { + "type": "integer", + "description": "When providing `end`, you must also provide `start`." + }, + "tid": { + "type": "string" + }, + "billable": { + "type": "boolean" + }, + "duration": { + "type": "integer" + } + }, + "required": [ + "tags", + "tid" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"Accessible tag actions are `[\\\"replace\\\", \\\"add\\\", \\\"remove\\\"]`\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateatimeEntryrequest\",\n \"required\": [\n \"tags\",\n \"tid\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\"\n },\n \"tags\": {\n \"description\": \"Users on the Business Plan and above can include a time tracking label.\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items\"\n }\n },\n \"tag_action\": {\n \"type\": \"string\"\n },\n \"start\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\",\n \"description\": \"When providing `start`, you must also provide `end`.\"\n },\n \"end\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\",\n \"description\": \"When providing `end`, you must also provide `start`.\"\n },\n \"tid\": {\n \"type\": \"string\"\n },\n \"billable\": {\n \"type\": \"boolean\"\n },\n \"duration\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"description\": \"\",\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ],\n \"tag_action\": \"add\",\n \"start\": 1595289395842,\n \"end\": 1595289495842,\n \"tid\": \"task_id\",\n \"billable\": true,\n \"duration\": 100000\n }\n ]\n },\n \"example\": {\n \"description\": \"\",\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ],\n \"tag_action\": \"add\",\n \"start\": 1595289395842,\n \"end\": 1595289495842,\n \"tid\": \"task_id\",\n \"billable\": true,\n \"duration\": 100000\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "Gettimeentryhistory", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_time_entry_changes", + "description": { + "tagline": "View a list of changes made to a time entry.", + "detailed": "Use this tool to access the history of modifications for a specific time entry within a team in ClickUp. It provides insights into various changes made on the entry, such as updates or edits." + }, + "return_annotation": "List of changes made to a time entry.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the workspace (team) where the time entry resides.", + "endpoint_argument_name": "team_id" + }, + { + "name": "time_entry_id", + "alternative_names": [ + "entry_id", + "log_id" + ], + "description": "The ID of a time entry. This ID can be obtained using the Get Time Entries Within a Date Range endpoint.", + "endpoint_argument_name": "timer_id" + }, + { + "name": "content_type_header", + "alternative_names": [ + "http_content_type", + "content_type_value" + ], + "description": "The media type for the request, typically 'application/json'. Required for HTTP headers.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/time_entries/{timer_id}/history", + "tags": [ + "Time Tracking" + ], + "summary": "Get time entry history", + "description": "View a list of changes made to a time entry.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "timer_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint." + }, + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "Getrunningtimeentry", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_current_running_time_entry", + "description": { + "tagline": "Retrieve the current running time entry for the user.", + "detailed": "Use this tool to view the time entry that is currently tracking time for the authenticated user. It indicates which timer is actively running. A negative duration suggests an ongoing timer." + }, + "return_annotation": "Details of the currently running time entry for the user.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the workspace to retrieve the running time entry for. It identifies the specific workspace within ClickUp.", + "endpoint_argument_name": "team_id" + }, + { + "name": "content_type_header", + "alternative_names": [ + "http_content_type", + "content_type_parameter" + ], + "description": "The MIME type of the content, e.g., 'application/json'. Required for HTTP content negotiation.", + "endpoint_argument_name": "Content-Type" + }, + { + "name": "assignee_user_id", + "alternative_names": [ + "user_id_of_assignee", + "timer_assignee_id" + ], + "description": "The user ID of the time entry assignee for whom the current running timer is being retrieved. This identifies which user's timer is actively running.", + "endpoint_argument_name": "assignee" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/time_entries/current", + "tags": [ + "Time Tracking" + ], + "summary": "Get running time entry", + "description": "View a time entry that's currently tracking time for the authenticated user. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "assignee", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "user id" + }, + "description": "user id", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "Removetagsfromtimeentries", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_tags_from_time_entries", + "description": { + "tagline": "Remove labels from specific time entries.", + "detailed": "Use this tool to remove labels from time entries without affecting the labels in the Workspace." + }, + "return_annotation": "Confirmation of tag removal from time entries.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The unique ID of the Workspace from which to remove labels from time entries. Must be an integer.", + "endpoint_argument_name": "team_id" + }, + { + "name": "time_entry_tags_payload", + "alternative_names": [ + "time_entries_labels_data", + "entries_tags_info" + ], + "description": "A JSON object containing the IDs of the time entries and the tags to be removed. The object should have two fields: `time_entry_ids` (an array of strings for the IDs) and `tags` (an array of objects for tags to be removed).", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "DELETE", + "path": "/v2/team/{team_id}/time_entries/tags", + "tags": [ + "Time Tracking" + ], + "summary": "Remove tags from time entries", + "description": "Remove labels from time entries. This does not remove the label from a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "time_entry_ids": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "Removetagsfromtimeentriesrequest", + "properties": { + "time_entry_ids": { + "type": "array", + "description": "", + "items": { + "type": "string" + } + }, + "tags": { + "type": "array", + "description": "", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries~1start/post/requestBody/content/application~1json/schema/properties/tags/items", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries~1start/post/requestBody/content/application~1json/schema/properties/tags/items" + } + } + }, + "required": [ + "time_entry_ids", + "tags" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Removetagsfromtimeentriesrequest\",\n \"required\": [\n \"time_entry_ids\",\n \"tags\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"time_entry_ids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"\"\n },\n \"tags\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries~1start/post/requestBody/content/application~1json/schema/properties/tags/items\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries~1start/post/requestBody/content/application~1json/schema/properties/tags/items\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"time_entry_ids\": [\n \"timer_id\"\n ],\n \"tags\": [\n {\n \"name\": \"name of tag\"\n }\n ]\n }\n ]\n },\n \"example\": {\n \"time_entry_ids\": [\n \"timer_id\"\n ],\n \"tags\": [\n {\n \"name\": \"name of tag\"\n }\n ]\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "Getalltagsfromtimeentries", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_time_entry_tags", + "description": { + "tagline": "Retrieve all tags from time entries in a workspace.", + "detailed": "Use this tool to view all labels that have been applied to time entries within a specified workspace." + }, + "return_annotation": "List of labels applied to time entries in a workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The unique ID of the workspace to retrieve tags from.", + "endpoint_argument_name": "team_id" + }, + { + "name": "content_type_header", + "alternative_names": [ + "content_type_value", + "header_content_type" + ], + "description": "The media type of the resource, usually set to 'application/json'.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/time_entries/tags", + "tags": [ + "Time Tracking" + ], + "summary": "Get all tags from time entries", + "description": "View all the labels that have been applied to time entries in a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "Addtagsfromtimeentries", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_tag_to_time_entry", + "description": { + "tagline": "Add a label to a specific time entry in ClickUp.", + "detailed": "This tool is used to attach a label to a time entry for a specific team in ClickUp. It should be called when you want to organize or categorize time entries with tags for better tracking and management." + }, + "return_annotation": "Confirmation of tag addition to the time entry.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the workspace where the time entry is located. This is required to specify which team the tag should be added to.", + "endpoint_argument_name": "team_id" + }, + { + "name": "time_entry_tag_request", + "alternative_names": [ + "tagging_data", + "time_entry_labeling" + ], + "description": "JSON object containing time_entry_ids (array of strings) and tags (array of JSON objects) to be added.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/team/{team_id}/time_entries/tags", + "tags": [ + "Time Tracking" + ], + "summary": "Add tags from time entries", + "description": "Add a label to a time entry.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "time_entry_ids": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "Addtagsfromtimeentriesrequest", + "properties": { + "time_entry_ids": { + "type": "array", + "description": "", + "items": { + "type": "string" + } + }, + "tags": { + "type": "array", + "description": "", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items" + } + } + }, + "required": [ + "time_entry_ids", + "tags" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Addtagsfromtimeentriesrequest\",\n \"required\": [\n \"time_entry_ids\",\n \"tags\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"time_entry_ids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"\"\n },\n \"tags\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"time_entry_ids\": [\n \"timer_id\"\n ],\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ]\n }\n ]\n },\n \"example\": {\n \"time_entry_ids\": [\n \"timer_id\"\n ],\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ]\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "Changetagnamesfromtimeentries", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "rename_time_entry_label", + "description": { + "tagline": "Rename a time entry label in ClickUp.", + "detailed": "Use this tool to change the name of a label associated with time entries for a specific team in ClickUp." + }, + "return_annotation": "Confirmation of label rename for time entries.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_id", + "clickup_team_id" + ], + "description": "The ID of the workspace where the label is located. This is required to specify the team in ClickUp whose label you want to rename.", + "endpoint_argument_name": "team_id" + }, + { + "name": "current_label_name", + "alternative_names": [ + "existing_label_name", + "old_label_name" + ], + "description": "The current name of the time entry label that needs to be renamed.", + "endpoint_argument_name": "name" + }, + { + "name": "new_label_name", + "alternative_names": [ + "updated_label_name", + "renamed_label_title" + ], + "description": "The new name for the time entry label to be applied in ClickUp.", + "endpoint_argument_name": "new_name" + }, + { + "name": "label_background_color", + "alternative_names": [ + "tag_background_color", + "time_entry_label_background" + ], + "description": "Hex code for the new background color of the label (e.g., '#FFFFFF').", + "endpoint_argument_name": "tag_bg" + }, + { + "name": "foreground_color_for_tag", + "alternative_names": [ + "tag_text_color", + "text_color_for_tag" + ], + "description": "Specify the hexadecimal foreground color for the tag (e.g., '#FFFFFF').", + "endpoint_argument_name": "tag_fg" + } + ] + }, + "method": "PUT", + "path": "/v2/team/{team_id}/time_entries/tags", + "tags": [ + "Time Tracking" + ], + "summary": "Change tag names from time entries", + "description": "Rename an time entry label.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "new_name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "tag_bg", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "tag_fg", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Changetagnamesfromtimeentriesrequest\",\n \"required\": [\n \"name\",\n \"new_name\",\n \"tag_bg\",\n \"tag_fg\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"new_name\": {\n \"type\": \"string\"\n },\n \"tag_bg\": {\n \"type\": \"string\"\n },\n \"tag_fg\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"old tag name\",\n \"new_name\": \"new tag name\",\n \"tag_bg\": \"#000000\",\n \"tag_fg\": \"#000000\"\n }\n ]\n },\n \"example\": {\n \"name\": \"old tag name\",\n \"new_name\": \"new tag name\",\n \"tag_bg\": \"#000000\",\n \"tag_fg\": \"#000000\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "StartatimeEntry", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "start_timer_clickup", + "description": { + "tagline": "Start a timer for the authenticated ClickUp user.", + "detailed": "Use this tool to initiate a timer for the authenticated user in ClickUp. It is ideal for tracking time on specific tasks or projects." + }, + "return_annotation": "Confirmation of the timer start operation.", + "arguments": [ + { + "name": "workspace_identifier", + "alternative_names": [ + "workspace_identifier", + "team_identifier" + ], + "description": "The Workspace ID required when custom task IDs are used.", + "endpoint_argument_name": "team_Id" + }, + { + "name": "timer_request_body", + "alternative_names": [ + "entry_request_body", + "start_time_entry_request" + ], + "description": "JSON object detailing the timer entry. Includes fields like `tid`, `description`, `tags`, and `billable`.", + "endpoint_argument_name": "requestBody" + }, + { + "name": "workspace_id", + "alternative_names": [ + "workspace_identifier", + "team_identifier" + ], + "description": "Provide the Workspace ID when `custom_task_ids` is `true`. Required for task referencing.", + "endpoint_argument_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "alternative_names": [ + "enable_custom_task_id_reference", + "set_custom_task_ids" + ], + "description": "Set to true to reference a task by its custom task ID.", + "endpoint_argument_name": "custom_task_ids" + } + ] + }, + "method": "POST", + "path": "/v2/team/{team_Id}/time_entries/start", + "tags": [ + "Time Tracking" + ], + "summary": "Start a time Entry", + "description": "Start a timer for the authenticated user.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "custom_task_ids", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + }, + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_Id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "description": "Users on the Business Plan and above can include a time tracking label." + }, + "tid": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "billable": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "For Workspaces on the Free Forever or Unlimited Plan, either the `timer_id` parameter or the `\"tid\"` field in the body of the request are required fields." + }, + "description": "For Workspaces on the Free Forever or Unlimited Plan, either the `timer_id` parameter or the `\"tid\"` field in the body of the request are required fields.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "StartatimeEntryrequest", + "properties": { + "description": { + "type": "string" + }, + "tags": { + "type": "array", + "description": "Users on the Business Plan and above can include a time tracking label.", + "items": { + "type": "object", + "title": "Tags10", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + "tid": { + "type": "string" + }, + "billable": { + "type": "boolean" + } + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"For Workspaces on the Free Forever or Unlimited Plan, either the `timer_id` parameter or the `\\\"tid\\\"` field in the body of the request are required fields.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"StartatimeEntryrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\"\n },\n \"tags\": {\n \"description\": \"Users on the Business Plan and above can include a time tracking label.\",\n \"type\": \"array\",\n \"items\": {\n \"title\": \"Tags10\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"name of tag\"\n }\n ]\n }\n },\n \"tid\": {\n \"type\": \"string\"\n },\n \"billable\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"description\": \"from api\",\n \"tags\": [\n {\n \"name\": \"tag1\"\n }\n ],\n \"tid\": \"task_id\",\n \"billable\": false\n }\n ]\n },\n \"example\": {\n \"description\": \"from api\",\n \"tags\": [\n {\n \"name\": \"tag1\"\n }\n ],\n \"tid\": \"task_id\",\n \"billable\": false\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "StopatimeEntry", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "stop_timer_entry", + "description": { + "tagline": "Stops a running timer for the authenticated user.", + "detailed": "Use this tool to stop a currently running timer for the authenticated user on ClickUp. This action is initiated for a specific team, requiring the team ID." + }, + "return_annotation": "Stop confirmation for the running timer.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the workspace where the timer is running. Required to stop the timer.", + "endpoint_argument_name": "team_id" + }, + { + "name": "content_type", + "alternative_names": [ + "content_type_header", + "http_content_type" + ], + "description": "Specifies the media type of the request. Usually 'application/json'.", + "endpoint_argument_name": "Content-Type" + } + ] + }, + "method": "POST", + "path": "/v2/team/{team_id}/time_entries/stop", + "tags": [ + "Time Tracking" + ], + "summary": "Stop a time Entry", + "description": "Stop a timer that's currently running for the authenticated user.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "Content-Type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "InviteUserToWorkspace", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "invite_user_to_workspace", + "description": { + "tagline": "Invite a user to your ClickUp Workspace as a member.", + "detailed": "Use this tool to invite someone to your ClickUp Workspace as a member. This is suitable for Workspaces on the Enterprise Plan. For inviting guests, use the appropriate tool instead." + }, + "return_annotation": "Confirmation of user invitation to the workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The unique ID of the workspace to which the user is being invited.", + "endpoint_argument_name": "team_id" + }, + { + "name": "user_email", + "alternative_names": [ + "member_email", + "email_address" + ], + "description": "The email address of the user to be invited to the Workspace. Must be a valid email format.", + "endpoint_argument_name": "email" + }, + { + "name": "invite_as_admin", + "alternative_names": [ + "set_admin_privileges", + "admin_status" + ], + "description": "Indicate if the user should be invited as an admin. True for admin, False for regular member.", + "endpoint_argument_name": "admin" + }, + { + "name": "custom_role_id", + "alternative_names": [ + "role_id", + "member_role_id" + ], + "description": "The ID of the custom role to assign to the user in the Workspace. Must be an integer.", + "endpoint_argument_name": "custom_role_id" + } + ] + }, + "method": "POST", + "path": "/v2/team/{team_id}/user", + "tags": [ + "Users" + ], + "summary": "Invite User To Workspace", + "description": "Invite someone to join your Workspace as a member. To invite someone as a guest, use the [Invite Guest](ref:inviteguesttoworkspace) endpoint.\\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "email", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "admin", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": true + }, + { + "name": "custom_role_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"InviteUserToWorkspacerequest\",\n \"required\": [\n \"email\",\n \"admin\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"email\": {\n \"type\": \"string\"\n },\n \"admin\": {\n \"type\": \"boolean\"\n },\n \"custom_role_id\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"email\": \"user@example.com\",\n \"admin\": true,\n \"custom_role_id\": 112233\n }\n ]\n },\n \"example\": {\n \"email\": \"user@example.com\",\n \"admin\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "GetUser", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_workspace_user_info", + "description": { + "tagline": "Retrieve user information from a specified workspace.", + "detailed": "Call this tool to get details about a user from a specific workspace on the ClickUp platform. This tool is applicable only to Workspaces that are on the Enterprise Plan." + }, + "return_annotation": "Information about a user in a specified workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "workspace_identifier", + "team_identifier" + ], + "description": "The unique ID of the Workspace. Used to specify which Workspace's user information is to be retrieved.", + "endpoint_argument_name": "team_id" + }, + { + "name": "user_id", + "alternative_names": [ + "userid", + "user_identifier" + ], + "description": "The unique identifier of the user to retrieve information for. This is required to specify which user's information is being accessed in the workspace.", + "endpoint_argument_name": "user_id" + }, + { + "name": "show_shared_items", + "alternative_names": [ + "display_shared_content", + "include_shared_details" + ], + "description": "Set to `true` to include details of shared items; `false` excludes them by default.", + "endpoint_argument_name": "include_shared" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/user/{user_id}", + "tags": [ + "Users" + ], + "summary": "Get User", + "description": "View information about a user in a Workspace. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "include_shared", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "boolean" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "user_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "EditUserOnWorkspace", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_user_workspace_details", + "description": { + "tagline": "Update a user's name and role in a ClickUp workspace.", + "detailed": "This tool updates a user's name and role within a specific ClickUp workspace. It's only available to Workspaces on the Enterprise Plan. Use it to change user details in a team." + }, + "return_annotation": "Information about the updated user in the workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the ClickUp workspace where the user's details will be updated.", + "endpoint_argument_name": "team_id" + }, + { + "name": "user_identifier", + "alternative_names": [ + "user_id_number", + "workspace_user_id" + ], + "description": "The unique identifier for the user within the workspace. This value is required to specify which user's details need updating.", + "endpoint_argument_name": "user_id" + }, + { + "name": "user_name", + "alternative_names": [ + "user_full_name", + "display_name" + ], + "description": "The new full name of the user to be updated in the ClickUp workspace.", + "endpoint_argument_name": "username" + }, + { + "name": "custom_role_id", + "alternative_names": [ + "role_identifier", + "workspace_role_id" + ], + "description": "An integer representing the custom role ID to assign to the user in the workspace. This is required for users with specific roles.", + "endpoint_argument_name": "custom_role_id" + }, + { + "name": "assign_admin_role", + "alternative_names": [ + "set_user_as_admin", + "grant_admin_privileges" + ], + "description": "Set to true to assign the user as an admin in the workspace, otherwise false.", + "endpoint_argument_name": "admin" + } + ] + }, + "method": "PUT", + "path": "/v2/team/{team_id}/user/{user_id}", + "tags": [ + "Users" + ], + "summary": "Edit User On Workspace", + "description": "Update a user's name and role. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "user_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "username", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "admin", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "boolean" + }, + "schema_required": true + }, + { + "name": "custom_role_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditUserOnWorkspacerequest\",\n \"required\": [\n \"username\",\n \"admin\",\n \"custom_role_id\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"username\": {\n \"type\": \"string\"\n },\n \"admin\": {\n \"type\": \"boolean\"\n },\n \"custom_role_id\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"username\": \"User Name\",\n \"admin\": false,\n \"custom_role_id\": 998877\n }\n ]\n },\n \"example\": {\n \"username\": \"User Name\",\n \"admin\": false,\n \"custom_role_id\": 998877\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "RemoveUserFromWorkspace", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "remove_user_from_workspace", + "description": { + "tagline": "Remove a user from a ClickUp workspace.", + "detailed": "Use this tool to deactivate a user from a ClickUp workspace, applicable for Workspaces on the Enterprise Plan." + }, + "return_annotation": "Confirmation of user removal from the workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_id_identifier", + "workspace_identifier" + ], + "description": "The ID of the Workspace in ClickUp from which the user will be removed.", + "endpoint_argument_name": "team_id" + }, + { + "name": "user_id", + "alternative_names": [ + "workspace_user_id", + "member_id" + ], + "description": "The ID of the user to be deactivated from the workspace.", + "endpoint_argument_name": "user_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/team/{team_id}/user/{user_id}", + "tags": [ + "Users" + ], + "summary": "Remove User From Workspace", + "description": "Deactivate a user from a Workspace. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + }, + { + "name": "user_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetTeamViews", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_team_views", + "description": { + "tagline": "Retrieve task and page views at the workspace level.", + "detailed": "Use this tool to view the task and page views available at the Everything Level of a specified workspace in ClickUp." + }, + "return_annotation": "List of task and page views for a workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_workspace_id", + "workspace_identifier" + ], + "description": "The ID of the workspace to retrieve task and page views from in ClickUp.", + "endpoint_argument_name": "team_id" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/view", + "tags": [ + "Views" + ], + "summary": "Get Workspace (Everything level) Views", + "description": "View the task and page views available at the Everything Level of a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateTeamView", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_team_view", + "description": { + "tagline": "Add various views to a workspace at the Everything Level.", + "detailed": "This tool allows you to add different types of views such as List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt to a specified workspace within a team. Use this when you need to create or organize views for better workspace management." + }, + "return_annotation": "Confirmation of view creation in the workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_workspace_id", + "workspace_identifier" + ], + "description": "The unique identifier for the workspace where the view will be added. This corresponds to the team or workspace ID.", + "endpoint_argument_name": "team_id" + }, + { + "name": "view_configuration", + "alternative_names": [ + "view_setup", + "view_options" + ], + "description": "JSON object specifying the view details: name, type (e.g., list, board), and optional configurations like grouping, divide, sorting, filters, columns, sidebar, and settings.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/team/{team_id}/view", + "tags": [ + "Views" + ], + "summary": "Create Workspace (Everything level) View", + "description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view at the Everything Level of a Workspace.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "CreateTeamViewrequest", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "required": [ + "name", + "type", + "grouping", + "divide", + "sorting", + "filters", + "columns", + "team_sidebar", + "settings" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateTeamViewrequest\",\n \"required\": [\n \"name\",\n \"type\",\n \"grouping\",\n \"divide\",\n \"sorting\",\n \"filters\",\n \"columns\",\n \"team_sidebar\",\n \"settings\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`.\"\n },\n \"grouping\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\"\n },\n \"divide\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\"\n },\n \"sorting\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\"\n },\n \"filters\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\"\n },\n \"columns\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\"\n },\n \"team_sidebar\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\"\n },\n \"settings\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Team View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": []\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": []\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New Everything level View\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n },\n \"filters\": {\n \"op\": \"AND\",\n \"field\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"op\": \"EQ\",\n \"determinor\": null,\n \"idx\": 0,\n \"values\": \"123\"\n }\n ],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": [\n {\n \"field\": \"assignee\",\n \"idx\": 0,\n \"width\": 160,\n \"hidden\": true,\n \"name\": null,\n \"display\": null\n }\n ]\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "GetSpaceViews", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_space_views", + "description": { + "tagline": "Retrieve the task and page views for a specified Space.", + "detailed": "This tool is used to obtain the task and page views available within a specific Space in ClickUp. It should be called when you need to explore or list the views associated with a given space by providing the space ID." + }, + "return_annotation": "Details about task and page views available in a space.", + "arguments": [ + { + "name": "space_identifier", + "alternative_names": [ + "space_id_number", + "identifier_for_space" + ], + "description": "The unique integer ID of the space for which to retrieve task and page views.", + "endpoint_argument_name": "space_id" + } + ] + }, + "method": "GET", + "path": "/v2/space/{space_id}/view", + "tags": [ + "Views" + ], + "summary": "Get Space Views", + "description": "View the task and page views available for a Space.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateSpaceView", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_space_view", + "description": { + "tagline": "Add a new view to a ClickUp space.", + "detailed": "Use this tool to add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a ClickUp Space." + }, + "return_annotation": "Details of the newly created view in the space.", + "arguments": [ + { + "name": "space_id", + "alternative_names": [ + "space_identifier", + "space_key" + ], + "description": "The unique identifier of the ClickUp space where the view will be added. It should be an integer.", + "endpoint_argument_name": "space_id" + }, + { + "name": "view_configuration", + "alternative_names": [ + "view_setup", + "view_details" + ], + "description": "A JSON object detailing the view's setup, including `name`, `type` (e.g., list, board), and optional attributes like `grouping`, `divide`, `sorting`, `filters`, `columns`, `team_sidebar`, and `settings`.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/space/{space_id}/view", + "tags": [ + "Views" + ], + "summary": "Create Space View", + "description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Space.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "CreateSpaceViewrequest", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "required": [ + "name", + "type", + "grouping", + "divide", + "sorting", + "filters", + "columns", + "team_sidebar", + "settings" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateSpaceViewrequest\",\n \"required\": [\n \"name\",\n \"type\",\n \"grouping\",\n \"divide\",\n \"sorting\",\n \"filters\",\n \"columns\",\n \"team_sidebar\",\n \"settings\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`.\"\n },\n \"grouping\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\"\n },\n \"divide\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\"\n },\n \"sorting\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\"\n },\n \"filters\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\"\n },\n \"columns\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\"\n },\n \"team_sidebar\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\"\n },\n \"settings\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Space View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": []\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": []\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New Space View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"op\": \"EQ\",\n \"determinor\": null,\n \"idx\": 0,\n \"values\": \"123\"\n }\n ],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": [\n {\n \"field\": \"assignee\",\n \"idx\": 0,\n \"width\": 160,\n \"hidden\": true,\n \"name\": null,\n \"display\": null\n }\n ]\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "GetFolderViews", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_folder_views", + "description": { + "tagline": "Retrieve available task and page views for a Folder in ClickUp.", + "detailed": "" + }, + "return_annotation": "Available task and page views for a folder.", + "arguments": [ + { + "name": "folder_id", + "alternative_names": [ + "folder_identifier", + "id_of_folder" + ], + "description": "The ID of the folder to retrieve views for. This should be an integer value.", + "endpoint_argument_name": "folder_id" + } + ] + }, + "method": "GET", + "path": "/v2/folder/{folder_id}/view", + "tags": [ + "Views" + ], + "summary": "Get Folder Views", + "description": "View the task and page views available for a Folder.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateFolderView", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_view_to_folder", + "description": { + "tagline": "Add various view types to a ClickUp folder.", + "detailed": "Use this tool to add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a specific folder in ClickUp." + }, + "return_annotation": "Confirmation of the view added to the folder.", + "arguments": [ + { + "name": "folder_id", + "alternative_names": [ + "folder_identifier", + "clickup_folder_id" + ], + "description": "The unique integer ID of the ClickUp folder where the view will be added. Required for specifying the target folder.", + "endpoint_argument_name": "folder_id" + }, + { + "name": "view_configuration", + "alternative_names": [ + "view_setup", + "view_parameters" + ], + "description": "A JSON object detailing the view settings such as type, name, sorting, filters, and other configurations.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/folder/{folder_id}/view", + "tags": [ + "Views" + ], + "summary": "Create Folder View", + "description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Folder.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "CreateFolderViewrequest", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "required": [ + "name", + "type", + "grouping", + "divide", + "sorting", + "filters", + "columns", + "team_sidebar", + "settings" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateFolderViewrequest\",\n \"required\": [\n \"name\",\n \"type\",\n \"grouping\",\n \"divide\",\n \"sorting\",\n \"filters\",\n \"columns\",\n \"team_sidebar\",\n \"settings\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`.\"\n },\n \"grouping\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\"\n },\n \"divide\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\"\n },\n \"sorting\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\"\n },\n \"filters\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\"\n },\n \"columns\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\"\n },\n \"team_sidebar\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\"\n },\n \"settings\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Folder View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": []\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": []\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New Folder View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"op\": \"EQ\",\n \"determinor\": null,\n \"idx\": 0,\n \"values\": \"123\"\n }\n ],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": [\n {\n \"field\": \"assignee\",\n \"idx\": 0,\n \"width\": 160,\n \"hidden\": true,\n \"name\": null,\n \"display\": null\n }\n ]\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "GetListViews", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_list_views", + "description": { + "tagline": "Retrieve available views for a specific list.", + "detailed": "Use this tool to view the task and page views available for a specific list in ClickUp. It retrieves both regular and required views." + }, + "return_annotation": "Available task and page views for a list.", + "arguments": [ + { + "name": "target_list_id", + "alternative_names": [ + "specified_list_id", + "list_identifier" + ], + "description": "The unique identifier for the list to retrieve views from. This should be an integer.", + "endpoint_argument_name": "list_id" + } + ] + }, + "method": "GET", + "path": "/v2/list/{list_id}/view", + "tags": [ + "Views" + ], + "summary": "Get List Views", + "description": "View the task and page views available for a List.
Views and required views are separate responses.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateListView", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "add_view_to_clickup_list", + "description": { + "tagline": "Add various views to a ClickUp list.", + "detailed": "Use this tool to add different types of views (List, Board, Calendar, etc.) to a specific ClickUp list using the list ID." + }, + "return_annotation": "Confirmation of view addition to a ClickUp list.", + "arguments": [ + { + "name": "clickup_list_id", + "alternative_names": [ + "list_identifier", + "clickup_list_identifier" + ], + "description": "An integer representing the ID of the ClickUp list to which the view will be added.", + "endpoint_argument_name": "list_id" + }, + { + "name": "view_configuration", + "alternative_names": [ + "view_settings", + "view_options" + ], + "description": "Configuration settings for the view, including 'name', 'type', 'grouping', 'divide', 'sorting', 'filters', 'columns', 'team_sidebar', and 'settings'.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/v2/list/{list_id}/view", + "tags": [ + "Views" + ], + "summary": "Create List View", + "description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a List.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "CreateListViewrequest", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", + "properties": {}, + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "required": [ + "name", + "type", + "grouping", + "divide", + "sorting", + "filters", + "columns", + "team_sidebar", + "settings" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateListViewrequest\",\n \"required\": [\n \"name\",\n \"type\",\n \"grouping\",\n \"divide\",\n \"sorting\",\n \"filters\",\n \"columns\",\n \"team_sidebar\",\n \"settings\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`.\"\n },\n \"grouping\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\"\n },\n \"divide\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\"\n },\n \"sorting\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\"\n },\n \"filters\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\"\n },\n \"columns\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\"\n },\n \"team_sidebar\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\"\n },\n \"settings\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New List View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": []\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": []\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New List View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"op\": \"EQ\",\n \"determinor\": null,\n \"idx\": 0,\n \"values\": \"123\"\n }\n ],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": [\n {\n \"field\": \"assignee\",\n \"idx\": 0,\n \"width\": 160,\n \"hidden\": true,\n \"name\": null,\n \"display\": null\n }\n ]\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "GetView", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "view_task_or_page_info", + "description": { + "tagline": "Retrieve details of a specific task or page view.", + "detailed": "Use this tool to get detailed information about a specific task or page view in ClickUp using the view ID." + }, + "return_annotation": "Information about a specific task or page view.", + "arguments": [ + { + "name": "view_identifier", + "alternative_names": [ + "task_page_identifier", + "specific_view_id" + ], + "description": "A unique identifier for the specific task or page view in ClickUp to be retrieved. This is required to obtain the relevant information.", + "endpoint_argument_name": "view_id" + } + ] + }, + "method": "GET", + "path": "/v2/view/{view_id}", + "tags": [ + "Views" + ], + "summary": "Get View", + "description": "View information about a specific task or page view.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "view_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "UpdateView", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_view_settings", + "description": { + "tagline": "Update the settings and configuration of a view.", + "detailed": "Rename, regroup, sort, filter, and modify columns and settings of a view when needing to adjust its configuration." + }, + "return_annotation": "Confirmation of updated view settings.", + "arguments": [ + { + "name": "view_identifier", + "alternative_names": [ + "view_id_reference", + "view_unique_id" + ], + "description": "The unique identifier for the view to be updated.", + "endpoint_argument_name": "view_id" + }, + { + "name": "view_configuration_details", + "alternative_names": [ + "view_update_payload", + "view_settings_json" + ], + "description": "JSON object detailing the view's name, type, location, grouping, sorting, filters, columns, team sidebar, and other settings.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "PUT", + "path": "/v2/view/{view_id}", + "tags": [ + "Views" + ], + "summary": "Update View", + "description": "Rename a view, update the grouping, sorting, filters, columns, and settings of a view.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "view_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "parent": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "id": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The id of the Workspace, Space, Folder, or List where the view is located." + }, + "type": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The level of the Hierarchy where the view is created. \\\n \\\nOptions include: \\\n \\\nWorkspace (Everything Level): `7` \\\n \\\nSpace: `4` \\\n \\\nFolder: `5` \\\n \\\nList: `6`" + } + }, + "inner_properties": null, + "description": "The parent parameter specifies where the view is located in the ClickUp Hierarchy. Both `id` and `type` are required. \\\n \\\nThe `id` is the id of the Workspace, Space, Folder, or List where the view is located. \\\n \\\nThe `type` value indciates the level of the Hierarchy where the view is located." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "field": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`." + }, + "dir": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view." + }, + "collapsed": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "ignore": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "field": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "dir": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "collapsed": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "fields": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views)." + } + }, + "inner_properties": null, + "description": null + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "op": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The available operator (`op``) values are `AND`` and `OR``." + }, + "fields": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "View the list of [fields available](doc:filter-views) to filter by." + }, + "search": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_closed": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "fields": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`" + } + }, + "inner_properties": null, + "description": "Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy." + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "assignees": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "assigned_comments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "unassigned_tasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "show_task_locations": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_subtasks": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed." + }, + "show_subtask_parent_names": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_closed_subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_images": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "collapse_empty_columns": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "me_comments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "me_subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "me_checklists": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "object", + "title": "UpdateViewrequest", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "parent": { + "type": "object", + "title": "Parent", + "description": "The parent parameter specifies where the view is located in the ClickUp Hierarchy. Both `id` and `type` are required. \\\n \\\nThe `id` is the id of the Workspace, Space, Folder, or List where the view is located. \\\n \\\nThe `type` value indciates the level of the Hierarchy where the view is located.", + "properties": { + "id": { + "type": "string", + "description": "The id of the Workspace, Space, Folder, or List where the view is located." + }, + "type": { + "type": "integer", + "description": "The level of the Hierarchy where the view is created. \\\n \\\nOptions include: \\\n \\\nWorkspace (Everything Level): `7` \\\n \\\nSpace: `4` \\\n \\\nFolder: `5` \\\n \\\nList: `6`" + } + }, + "required": [ + "id", + "type" + ] + }, + "grouping": { + "type": "object", + "title": "Grouping", + "properties": { + "field": { + "type": "string", + "description": "Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`." + }, + "dir": { + "type": "integer", + "description": "Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view." + }, + "collapsed": { + "type": "array", + "description": "", + "items": { + "type": "string" + } + }, + "ignore": { + "type": "boolean" + } + }, + "required": [ + "field", + "dir", + "collapsed", + "ignore" + ] + }, + "divide": { + "type": "object", + "title": "Divide", + "properties": { + "field": { + "type": [ + "null" + ] + }, + "dir": { + "type": [ + "null" + ] + }, + "collapsed": { + "type": [ + "boolean" + ] + } + }, + "required": [ + "collapsed" + ] + }, + "sorting": { + "type": "object", + "title": "Sorting", + "properties": { + "fields": { + "type": "array", + "description": "Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views).", + "items": { + "type": "string" + } + } + }, + "required": [ + "fields" + ] + }, + "filters": { + "type": "object", + "title": "Filters", + "properties": { + "op": { + "type": "string", + "description": "The available operator (`op``) values are `AND`` and `OR``." + }, + "fields": { + "type": "array", + "description": "View the list of [fields available](doc:filter-views) to filter by.", + "items": { + "type": "string" + } + }, + "search": { + "type": "string" + }, + "show_closed": { + "type": "boolean" + } + }, + "required": [ + "op", + "fields", + "search", + "show_closed" + ] + }, + "columns": { + "type": "object", + "title": "Columns", + "description": "Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy.", + "properties": { + "fields": { + "type": "array", + "description": "Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`", + "items": { + "type": "string" + } + } + }, + "required": [ + "fields" + ] + }, + "team_sidebar": { + "type": "object", + "title": "TeamSidebar", + "properties": { + "assignees": { + "type": "array", + "description": "", + "items": { + "type": "string" + } + }, + "assigned_comments": { + "type": "boolean" + }, + "unassigned_tasks": { + "type": "boolean" + } + }, + "required": [ + "assignees", + "assigned_comments", + "unassigned_tasks" + ] + }, + "settings": { + "type": "object", + "title": "Settings", + "properties": { + "show_task_locations": { + "type": "boolean" + }, + "show_subtasks": { + "type": "integer", + "description": "Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed." + }, + "show_subtask_parent_names": { + "type": "boolean" + }, + "show_closed_subtasks": { + "type": "boolean" + }, + "show_assignees": { + "type": "boolean" + }, + "show_images": { + "type": "boolean" + }, + "collapse_empty_columns": { + "type": [ + "string", + "null" + ] + }, + "me_comments": { + "type": "boolean" + }, + "me_subtasks": { + "type": "boolean" + }, + "me_checklists": { + "type": "boolean" + } + }, + "required": [ + "show_task_locations", + "show_subtasks", + "show_subtask_parent_names", + "show_closed_subtasks", + "show_assignees", + "show_images", + "collapse_empty_columns", + "me_comments", + "me_subtasks", + "me_checklists" + ] + } + }, + "required": [ + "name", + "type", + "parent", + "grouping", + "divide", + "sorting", + "filters", + "columns", + "team_sidebar", + "settings" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateViewrequest\",\n \"required\": [\n \"name\",\n \"type\",\n \"parent\",\n \"grouping\",\n \"divide\",\n \"sorting\",\n \"filters\",\n \"columns\",\n \"team_sidebar\",\n \"settings\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"parent\": {\n \"title\": \"Parent\",\n \"description\": \"The parent parameter specifies where the view is located in the ClickUp Hierarchy. Both `id` and `type` are required. \\\\\\n \\\\\\nThe `id` is the id of the Workspace, Space, Folder, or List where the view is located. \\\\\\n \\\\\\nThe `type` value indciates the level of the Hierarchy where the view is located.\",\n \"required\": [\n \"id\",\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The id of the Workspace, Space, Folder, or List where the view is located.\"\n },\n \"type\": {\n \"type\": \"integer\",\n \"description\": \"The level of the Hierarchy where the view is created. \\\\\\n \\\\\\nOptions include: \\\\\\n \\\\\\nWorkspace (Everything Level): `7` \\\\\\n \\\\\\nSpace: `4` \\\\\\n \\\\\\nFolder: `5` \\\\\\n \\\\\\nList: `6`\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"id\": \"512\",\n \"type\": 7\n }\n ]\n },\n \"grouping\": {\n \"title\": \"Grouping\",\n \"required\": [\n \"field\",\n \"dir\",\n \"collapsed\",\n \"ignore\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"field\": {\n \"type\": \"string\",\n \"description\": \"Set the field to group by.\\\\\\n \\\\\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`.\"\n },\n \"dir\": {\n \"description\": \"Set a group sort order using `1` or `-1`.\\\\\\n \\\\\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\\\\n \\\\\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"collapsed\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"\"\n },\n \"ignore\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n }\n ]\n },\n \"divide\": {\n \"title\": \"Divide\",\n \"required\": [\n \"collapsed\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"field\": {\n \"type\": [\n \"null\"\n ]\n },\n \"dir\": {\n \"type\": [\n \"null\"\n ]\n },\n \"collapsed\": {\n \"type\": [\n \"boolean\"\n ]\n }\n },\n \"examples\": [\n {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n }\n ]\n },\n \"sorting\": {\n \"title\": \"Sorting\",\n \"required\": [\n \"fields\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"fields\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Include an array of fields to sort by.\\\\\\n \\\\\\n You can sort by the same fields available when [filtering a view](doc:filter-views).\"\n }\n },\n \"examples\": [\n {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n }\n ]\n },\n \"filters\": {\n \"title\": \"Filters\",\n \"required\": [\n \"op\",\n \"fields\",\n \"search\",\n \"show_closed\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"op\": {\n \"type\": \"string\",\n \"description\": \"The available operator (`op``) values are `AND`` and `OR``.\"\n },\n \"fields\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"View the list of [fields available](doc:filter-views) to filter by.\"\n },\n \"search\": {\n \"type\": \"string\"\n },\n \"show_closed\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n }\n ]\n },\n \"columns\": {\n \"title\": \"Columns\",\n \"description\": \"Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy.\",\n \"required\": [\n \"fields\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"fields\": {\n \"description\": \"Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"examples\": [\n {\n \"fields\": []\n }\n ]\n },\n \"team_sidebar\": {\n \"title\": \"TeamSidebar\",\n \"required\": [\n \"assignees\",\n \"assigned_comments\",\n \"unassigned_tasks\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"assignees\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"\"\n },\n \"assigned_comments\": {\n \"type\": \"boolean\"\n },\n \"unassigned_tasks\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n }\n ]\n },\n \"settings\": {\n \"title\": \"Settings\",\n \"required\": [\n \"show_task_locations\",\n \"show_subtasks\",\n \"show_subtask_parent_names\",\n \"show_closed_subtasks\",\n \"show_assignees\",\n \"show_images\",\n \"collapse_empty_columns\",\n \"me_comments\",\n \"me_subtasks\",\n \"me_checklists\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"show_task_locations\": {\n \"type\": \"boolean\"\n },\n \"show_subtasks\": {\n \"description\": \"Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"show_subtask_parent_names\": {\n \"type\": \"boolean\"\n },\n \"show_closed_subtasks\": {\n \"type\": \"boolean\"\n },\n \"show_assignees\": {\n \"type\": \"boolean\"\n },\n \"show_images\": {\n \"type\": \"boolean\"\n },\n \"collapse_empty_columns\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"me_comments\": {\n \"type\": \"boolean\"\n },\n \"me_subtasks\": {\n \"type\": \"boolean\"\n },\n \"me_checklists\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n ]\n }\n },\n \"examples\": [\n {\n \"name\": \"New View Name\",\n \"type\": \"list\",\n \"parent\": {\n \"id\": \"512\",\n \"type\": 7\n },\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": []\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": []\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New View Name\",\n \"type\": \"list\",\n \"parent\": {\n \"id\": \"512\",\n \"type\": 7\n },\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"op\": \"EQ\",\n \"determinor\": null,\n \"idx\": 0,\n \"values\": \"123\"\n }\n ],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": [\n {\n \"field\": \"assignee\",\n \"idx\": 0,\n \"width\": 160,\n \"hidden\": true,\n \"name\": null,\n \"display\": null\n }\n ]\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true, + "use_flatten_mode": false + }, + { + "name": "DeleteView", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_view", + "description": { + "tagline": "Delete a specified view from ClickUp.", + "detailed": "Use this tool to delete a specific view in ClickUp by providing the view ID. Useful for managing and organizing views by removing those that are no longer needed." + }, + "return_annotation": "Confirmation of view deletion.", + "arguments": [ + { + "name": "view_id", + "alternative_names": [ + "view_identifier", + "id_of_view" + ], + "description": "The ID of the view to be deleted in ClickUp. Must be provided as a string.", + "endpoint_argument_name": "view_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/view/{view_id}", + "tags": [ + "Views" + ], + "summary": "Delete View", + "description": "", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "view_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "description": "105 (string)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetViewTasks", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_visible_tasks_in_view", + "description": { + "tagline": "Retrieve all visible tasks from a ClickUp view.", + "detailed": "Use this tool to obtain a list of all tasks that are visible in a specific view within ClickUp. It is useful for task management and organization within the platform." + }, + "return_annotation": "List of visible tasks in the specified ClickUp view.", + "arguments": [ + { + "name": "pagination_page_number", + "alternative_names": [ + "page_number_index", + "current_page" + ], + "description": "The specific page number of tasks to retrieve. Used for pagination in task lists, starting at 1.", + "endpoint_argument_name": "page" + }, + { + "name": "view_identifier", + "alternative_names": [ + "view_id_string", + "view_identifier_code" + ], + "description": "The ID of the ClickUp view from which to retrieve visible tasks. Must be a string.", + "endpoint_argument_name": "view_id" + } + ] + }, + "method": "GET", + "path": "/v2/view/{view_id}/task", + "tags": [ + "Views" + ], + "summary": "Get View Tasks", + "description": "See all visible tasks in a view in ClickUp.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [ + { + "name": "page", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer" + }, + "schema_required": false + } + ], + "path": [ + { + "name": "view_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "description": "105 (string)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "GetWebhooks", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_workspace_webhooks", + "description": { + "tagline": "Retrieve webhooks for a workspace.", + "detailed": "Use this tool to view the webhooks created via the API for a specific Workspace. It returns webhooks created by the authenticated user." + }, + "return_annotation": "List of webhooks created by the user for a workspace.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the Workspace to retrieve the webhooks for.", + "endpoint_argument_name": "team_id" + } + ] + }, + "method": "GET", + "path": "/v2/team/{team_id}/webhook", + "tags": [ + "Webhooks" + ], + "summary": "Get Webhooks", + "description": "View the webhooks created via the API for a Workspace. This endpoint returns webhooks created by the authenticated user.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + }, + { + "name": "CreateWebhook", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "setup_clickup_webhook", + "description": { + "tagline": "Set up a ClickUp webhook to monitor events.", + "detailed": "Use this tool to create a webhook in ClickUp, enabling monitoring of events for a specific team. Useful for triggering actions or notifications based on certain events within a ClickUp team." + }, + "return_annotation": "Confirmation of webhook setup in ClickUp for a team.", + "arguments": [ + { + "name": "workspace_id", + "alternative_names": [ + "team_identifier", + "workspace_identifier" + ], + "description": "The ID of the workspace where the webhook will be set up. Use this to specify the team context for monitoring.", + "endpoint_argument_name": "team_id" + }, + { + "name": "webhook_url", + "alternative_names": [ + "url_endpoint", + "callback_url" + ], + "description": "The URL where the webhook will send POST requests. Must be reachable to receive event data.", + "endpoint_argument_name": "endpoint" + }, + { + "name": "event_types", + "alternative_names": [ + "webhook_event_types", + "clickup_event_types" + ], + "description": "An array of event types to subscribe to, or use `*` to subscribe to all events. Refer to ClickUp documentation for available options.", + "endpoint_argument_name": "events" + }, + { + "name": "space_identifier", + "alternative_names": [ + "space_id_number", + "workspace_space_id" + ], + "description": "The numeric ID of the space within a ClickUp workspace for which the webhook is set up.", + "endpoint_argument_name": "space_id" + }, + { + "name": "folder_id", + "alternative_names": [ + "clickup_folder_id", + "workspace_folder_id" + ], + "description": "Specify the folder ID in ClickUp for which the webhook is to be created. It should be an integer value representing the folder.", + "endpoint_argument_name": "folder_id" + }, + { + "name": "target_list_id", + "alternative_names": [ + "list_identifier", + "targeted_list_id" + ], + "description": "The ID of the list in ClickUp for which you want to set up a webhook.", + "endpoint_argument_name": "list_id" + }, + { + "name": "specific_task_id", + "alternative_names": [ + "task_identifier", + "id_of_task" + ], + "description": "Unique identifier for a specific task to monitor. Leave empty if not targeting a specific task.", + "endpoint_argument_name": "task_id" + } + ] + }, + "method": "POST", + "path": "/v2/team/{team_id}/webhook", + "tags": [ + "Webhooks" + ], + "summary": "Create Webhook", + "description": "Set up a webhook to monitor for events.
We do not have a dedicated IP address for webhooks. We use our domain name and dynamic addressing.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "team_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "description": "Workspace ID", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "number" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "endpoint", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "events", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "See [documentation](doc:webhooks#task-webhooks) for available event options. Use `*` to subscribe to all events." + }, + "description": "See [documentation](doc:webhooks#task-webhooks) for available event options. Use `*` to subscribe to all events.", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "description": "See [documentation](doc:webhooks#task-webhooks) for available event options. Use `*` to subscribe to all events.", + "items": { + "type": "string" + } + }, + "schema_required": true + }, + { + "name": "space_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "folder_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "list_id", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer" + }, + "schema_required": false + }, + { + "name": "task_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"description\": \"You can subscribe to specific events, and one specific location per webhook. [Learn more](doc:webhooks).\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateWebhookrequest\",\n \"required\": [\n \"endpoint\",\n \"events\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"endpoint\": {\n \"type\": \"string\"\n },\n \"events\": {\n \"type\": \"array\",\n \"description\": \"See [documentation](doc:webhooks#task-webhooks) for available event options. Use `*` to subscribe to all events.\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"space_id\": {\n \"type\": \"integer\"\n },\n \"folder_id\": {\n \"type\": \"integer\"\n },\n \"list_id\": {\n \"type\": \"integer\"\n },\n \"task_id\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"endpoint\": \"https://yourdomain.com/webhook\",\n \"events\": [\n \"taskCreated\",\n \"taskUpdated\",\n \"taskDeleted\",\n \"taskPriorityUpdated\",\n \"taskStatusUpdated\",\n \"taskAssigneeUpdated\",\n \"taskDueDateUpdated\",\n \"taskTagUpdated\",\n \"taskMoved\",\n \"taskCommentPosted\",\n \"taskCommentUpdated\",\n \"taskTimeEstimateUpdated\",\n \"taskTimeTrackedUpdated\",\n \"listCreated\",\n \"listUpdated\",\n \"listDeleted\",\n \"folderCreated\",\n \"folderUpdated\",\n \"folderDeleted\",\n \"spaceCreated\",\n \"spaceUpdated\",\n \"spaceDeleted\",\n \"goalCreated\",\n \"goalUpdated\",\n \"goalDeleted\",\n \"keyResultCreated\",\n \"keyResultUpdated\",\n \"keyResultDeleted\"\n ],\n \"space_id\": 1234,\n \"folder_id\": 5678,\n \"list_id\": 9876,\n \"task_id\": \"abc1234\"\n }\n ]\n },\n \"example\": {\n \"endpoint\": \"https://yourdomain.com/webhook\",\n \"events\": [\n \"taskCreated\",\n \"taskUpdated\",\n \"taskDeleted\",\n \"taskPriorityUpdated\",\n \"taskStatusUpdated\",\n \"taskAssigneeUpdated\",\n \"taskDueDateUpdated\",\n \"taskTagUpdated\",\n \"taskMoved\",\n \"taskCommentPosted\",\n \"taskCommentUpdated\",\n \"taskTimeEstimateUpdated\",\n \"taskTimeTrackedUpdated\",\n \"listCreated\",\n \"listUpdated\",\n \"listDeleted\",\n \"folderCreated\",\n \"folderUpdated\",\n \"folderDeleted\",\n \"spaceCreated\",\n \"spaceUpdated\",\n \"spaceDeleted\",\n \"goalCreated\",\n \"goalUpdated\",\n \"goalDeleted\",\n \"keyResultCreated\",\n \"keyResultUpdated\",\n \"keyResultDeleted\"\n ],\n \"space_id\": 1234,\n \"folder_id\": 5678,\n \"list_id\": 9876,\n \"task_id\": \"abc1234\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "UpdateWebhook", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_clickup_webhook_events", + "description": { + "tagline": "Update a ClickUp webhook to modify monitored events.", + "detailed": "Use this tool to update the events a ClickUp webhook monitors, allowing for changes to event tracking as needed." + }, + "return_annotation": "Information about the updated webhook.", + "arguments": [ + { + "name": "webhook_identifier", + "alternative_names": [ + "webhook_id_string", + "webhook_uuid" + ], + "description": "The unique identifier for the webhook to be updated, formatted as a UUID.", + "endpoint_argument_name": "webhook_id" + }, + { + "name": "webhook_endpoint_url", + "alternative_names": [ + "url_for_webhook", + "webhook_destination_url" + ], + "description": "The URL where the webhook should send POST requests for the events. Must be a valid and accessible URL.", + "endpoint_argument_name": "endpoint" + }, + { + "name": "monitored_events", + "alternative_names": [ + "webhook_events", + "event_list" + ], + "description": "A comma-separated list of events for the webhook to monitor. Use valid event names as per ClickUp webhook documentation.", + "endpoint_argument_name": "events" + }, + { + "name": "webhook_status", + "alternative_names": [ + "status_of_webhook", + "current_webhook_status" + ], + "description": "Specify the new status of the webhook. Use 'active' to enable or 'inactive' to disable it.", + "endpoint_argument_name": "status" + } + ] + }, + "method": "PUT", + "path": "/v2/webhook/{webhook_id}", + "tags": [ + "Webhooks" + ], + "summary": "Update Webhook", + "description": "Update a webhook to change the events to be monitored.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "webhook_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e506-4a29-9d42-26e504e3435e (uuid)" + }, + "description": "e506-4a29-9d42-26e504e3435e (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "endpoint", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "events", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + }, + { + "name": "status", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string" + }, + "schema_required": true + } + ] + }, + "request_body_spec": "{\n \"description\": \"To subscribe to specific events, pass an array of `events` that you want to subscribe to, or use the wildcard character `\\\"*\\\"` to subscribe to everything.\\\\\\n \\\\\\nIf you don't specify any events, all events will be sent to the webhook.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateWebhookrequest\",\n \"required\": [\n \"endpoint\",\n \"events\",\n \"status\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"endpoint\": {\n \"type\": \"string\"\n },\n \"events\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"endpoint\": \"https://yourdomain.com/webhook\",\n \"events\": \"*\",\n \"status\": \"active\"\n }\n ]\n },\n \"example\": {\n \"endpoint\": \"https://yourdomain.com/webhook\",\n \"events\": \"*\",\n \"status\": \"active\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true + }, + { + "name": "DeleteWebhook", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "delete_webhook", + "description": { + "tagline": "Delete a webhook to stop event monitoring.", + "detailed": "Use this tool to delete a webhook, which will stop monitoring events and locations associated with it. Useful for managing and updating your event tracking preferences." + }, + "return_annotation": "Confirmation of webhook deletion.", + "arguments": [ + { + "name": "webhook_id", + "alternative_names": [ + "webhook_identifier", + "webhook_uuid" + ], + "description": "The unique identifier for the webhook to be deleted. Must be in UUID format.", + "endpoint_argument_name": "webhook_id" + } + ] + }, + "method": "DELETE", + "path": "/v2/webhook/{webhook_id}", + "tags": [ + "Webhooks" + ], + "summary": "Delete Webhook", + "description": "Delete a webhook to stop monitoring the events and locations of the webhook.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "Authorization_Token" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "webhook_id", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e506-4a29-9d42-26e504e3435e (uuid)" + }, + "description": "e506-4a29-9d42-26e504e3435e (uuid)", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [] + }, + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false + } + ], + "security_scheme_key_selected": null, + "security_scheme_selected": {} +} diff --git a/toolkits/clickup_api/clickup_api/moar/openapi.json b/toolkits/clickup_api/clickup_api/moar/openapi.json new file mode 100644 index 00000000..28732450 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/moar/openapi.json @@ -0,0 +1,32740 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ClickUp API v2 Reference", + "description": "The ClickUp API enables you to programmatically access and manage your ClickUp resources.\n\n## Authentication\nThe API supports two authentication methods:\n- **Personal API Token**: Use for testing and personal integrations. Add token to requests with header: `Authorization: pk_...`\n- **OAuth 2.0**: Required for building apps for other users. Uses authorization code flow.\n\n## Getting Started\nOur [Getting Started Guide](https://developer.clickup.com/docs/index) provides a comprehensive overview of how to use the ClickUp API.\n", + "contact": {}, + "version": "2.0" + }, + "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", + "servers": [ + { + "url": "https://api.clickup.com/api", + "description": "ClickUp", + "variables": {} + } + ], + "paths": { + "/v2/task/{task_id}/attachment": { + "post": { + "summary": "Create Task Attachment", + "tags": [ + "Attachments" + ], + "description": "Upload a file to a task as an attachment. Files stored in the cloud cannot be used in this API request.\\\n \\\n***Note:** This request uses multipart/form-data as the content type.*", + "operationId": "CreateTaskAttachment", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by its custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "attachment": { + "type": "array", + "items": {} + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateTaskAttachmentresponse", + "required": [ + "id", + "version", + "date", + "title", + "extension", + "thumbnail_small", + "thumbnail_large", + "url" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "version": { + "type": "string" + }, + "date": { + "type": "integer", + "contentEncoding": "int64" + }, + "title": { + "type": "string" + }, + "extension": { + "type": "string" + }, + "thumbnail_small": { + "type": "string" + }, + "thumbnail_large": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "examples": [ + { + "id": "ac434d4e-8b1c-4571-951b-866b6d9f2ee6.png", + "version": "0", + "date": 1569988578766, + "title": "image.png", + "extension": "png", + "thumbnail_small": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png", + "thumbnail_large": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png", + "url": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png" + } + ] + }, + "example": { + "id": "ac434d4e-8b1c-4571-951b-866b6d9f2ee6.png", + "version": "0", + "date": 1569988578766, + "title": "image.png", + "extension": "png", + "thumbnail_small": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png", + "thumbnail_large": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png", + "url": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/oauth/token": { + "parameters": [], + "post": { + "summary": "Get Access Token", + "tags": [ + "Authorization" + ], + "description": "These are the routes for authing the API and going through the [OAuth flow](doc:authentication).\\\n \\\nApplications utilizing a personal API token don't use this endpoint.\\\n \\\n***Note:** OAuth tokens are not supported when using the [**Try It** feature](doc:trytheapi) of our Reference docs. You can't try this endpoint from your web browser.*\n", + "operationId": "GetAccessToken", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "GetAccessTokenrequest", + "required": [ + "client_id", + "client_secret", + "code" + ], + "type": "object", + "properties": { + "client_id": { + "type": "string", + "description": "OAuth app client id" + }, + "client_secret": { + "type": "string", + "description": "OAuth app client secret" + }, + "code": { + "type": "string", + "description": "Code given in redirect url" + } + }, + "examples": [ + { + "client_id": "your_client_id", + "client_secret": "your_client_secret", + "code": "authorization_code" + } + ] + }, + "example": { + "client_id": "your_client_id", + "client_secret": "your_client_secret", + "code": "authorization_code" + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1oauth~1token/post/requestBody/content/application~1json/schema", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1oauth~1token/post/requestBody/content/application~1json/schema" + }, + "example": { + "client_id": "your_client_id", + "client_secret": "your_client_secret", + "code": "authorization_code" + } + } + } + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetAccessTokenresponse", + "required": [ + "access_token" + ], + "type": "object", + "properties": { + "access_token": { + "type": "string" + } + }, + "examples": [ + { + "access_token": "access token" + } + ] + }, + "example": { + "access_token": "access token" + } + } + } + } + }, + "deprecated": false, + "security": [], + "x-hideTryItPanel": true, + "x-moar-primitive-count": 3, + "x-moar-complexity-skipped": false + } + }, + "/v2/user": { + "parameters": [], + "get": { + "summary": "Get Authorized User", + "tags": [ + "Authorization" + ], + "description": "View the details of the authenticated user's ClickUp account.", + "operationId": "GetAuthorizedUser", + "parameters": [], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetAuthorizedUserresponse", + "type": "object", + "properties": { + "user": { + "title": "User", + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "profilePicture": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "week_start_day": { + "type": "integer", + "contentEncoding": "int32", + "description": "The user's preferred start of the calendar week setting. \\ `0` is Sunday. \\ `1` is Monday." + }, + "global_font_support": { + "type": "boolean" + }, + "timezeone": { + "type": "string" + } + }, + "examples": [ + { + "id": 123, + "username": "John Doe", + "email": "user@company.com", + "color": "#000000", + "profilePicture": "https://clickup.com/avatar.jpg", + "initials": "JD", + "week_start_day": 0, + "global_font_support": false, + "timezone": "America/Los_Angeles" + } + ] + } + }, + "examples": [ + { + "user": { + "id": 123, + "username": "John Doe", + "email": "user@company.com", + "color": "#000000", + "profilePicture": "https://clickup.com/avatar.jpg", + "initials": "JD", + "week_start_day": 0, + "global_font_support": false, + "timezone": "America/Los_Angeles" + } + } + ] + }, + "example": { + "user": { + "id": 123, + "username": "John Doe", + "email": "user@company.com", + "color": "#000000", + "profilePicture": "https://clickup.com/avatar.jpg", + "initials": "JD", + "week_start_day": 0, + "global_font_support": false, + "timezone": "America/Los_Angeles" + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team": { + "parameters": [], + "get": { + "summary": "Get Authorized Workspaces", + "tags": [ + "Workspaces" + ], + "description": "View the Workspaces available to the authenticated user.", + "operationId": "GetAuthorizedTeams", + "parameters": [], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetAuthorizedTeamsresponse", + "required": [ + "teams" + ], + "type": "object", + "properties": { + "teams": { + "type": "array", + "items": { + "title": "Team", + "required": [ + "id", + "name", + "color", + "avatar", + "members" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "avatar": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "title": "Member", + "required": [ + "user" + ], + "type": "object", + "properties": { + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1user/get/responses/200/content/application~1json/schema/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1user/get/responses/200/content/application~1json/schema/properties/user" + } + }, + "examples": [ + { + "user": { + "id": 123, + "username": "John Doe", + "color": "#000000", + "profilePicture": "https://clickup.com/avatar.jpg" + } + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "id": "1234", + "name": "My ClickUp Workspace", + "color": "#000000", + "avatar": "https://clickup.com/avatar.jpg", + "members": [ + { + "user": { + "id": 123, + "username": "John Doe", + "color": "#000000", + "profilePicture": "https://clickup.com/avatar.jpg" + } + } + ] + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "teams": [ + { + "id": "1234", + "name": "My ClickUp Workspace", + "color": "#000000", + "avatar": "https://clickup.com/avatar.jpg", + "members": [ + { + "user": { + "id": 123, + "username": "John Doe", + "color": "#000000", + "profilePicture": "https://clickup.com/avatar.jpg" + } + } + ] + } + ] + } + ] + }, + "example": { + "teams": [ + { + "id": "1234", + "name": "My ClickUp Workspace", + "color": "#000000", + "avatar": "https://clickup.com/avatar.jpg", + "members": [ + { + "user": { + "id": 123, + "username": "John Doe", + "color": "#000000", + "profilePicture": "https://clickup.com/avatar.jpg" + } + } + ] + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/checklist": { + "parameters": [], + "post": { + "summary": "Create Checklist", + "tags": [ + "Task Checklists" + ], + "description": "Add a new checklist to a task.", + "operationId": "CreateChecklist", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateChecklistrequest", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "examples": [ + { + "name": "Checklist" + } + ] + }, + "example": { + "name": "Checklist" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateChecklistresponse", + "required": [ + "checklist" + ], + "type": "object", + "properties": { + "checklist": { + "title": "Checklist", + "required": [ + "id", + "task_id", + "name", + "orderindex", + "resolved", + "unresolved", + "items" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "task_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "resolved": { + "type": "integer", + "contentEncoding": "int32" + }, + "unresolved": { + "type": "integer", + "contentEncoding": "int32" + }, + "items": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + } + }, + "examples": [ + { + "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", + "task_id": "9hz", + "name": "Checklist", + "orderindex": 0, + "resolved": 0, + "unresolved": 0, + "items": [] + } + ] + } + }, + "examples": [ + { + "checklist": { + "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", + "task_id": "9hz", + "name": "Checklist", + "orderindex": 0, + "resolved": 0, + "unresolved": 0, + "items": [] + } + } + ] + }, + "example": { + "checklist": { + "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", + "task_id": "9hz", + "name": "Checklist", + "orderindex": 0, + "resolved": 0, + "unresolved": 0, + "items": [] + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 1, + "x-moar-complexity-skipped": false + } + }, + "/v2/checklist/{checklist_id}": { + "parameters": [], + "put": { + "summary": "Edit Checklist", + "tags": [ + "Task Checklists" + ], + "description": "Rename a task checklist, or reorder a checklist so it appears above or below other checklists on a task. ", + "operationId": "EditChecklist", + "parameters": [ + { + "name": "checklist_id", + "in": "path", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "b955c4dc" + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "EditChecklistrequest", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "position": { + "description": "Position refers to the order of appearance of checklists on a task.\\\n \\\nTo set a checklist to appear at the top of the checklists section of a task, use `\"position\": 0`.", + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "name": "Updated Checklist", + "position": 1 + } + ] + }, + "example": { + "name": "Updated Checklist", + "position": 1 + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "contentMediaType": "application/json" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 2, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Checklist", + "tags": [ + "Task Checklists" + ], + "description": "Delete a checklist from a task.", + "operationId": "DeleteChecklist", + "parameters": [ + { + "name": "checklist_id", + "in": "path", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "b955c4dc" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/checklist/{checklist_id}/checklist_item": { + "parameters": [], + "post": { + "summary": "Create Checklist Item", + "tags": [ + "Task Checklists" + ], + "description": "Add a line item to a task checklist.", + "operationId": "CreateChecklistItem", + "parameters": [ + { + "name": "checklist_id", + "in": "path", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "b955c4dc" + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateChecklistItemrequest", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "assignee": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "name": "Checklist Item", + "assignee": 183 + } + ] + }, + "example": { + "name": "Checklist Item", + "assignee": 183 + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateChecklistItemresponse", + "required": [ + "checklist" + ], + "type": "object", + "properties": { + "checklist": { + "title": "Checklist1", + "required": [ + "id", + "task_id", + "name", + "date_created", + "orderindex", + "resolved", + "unresolved", + "items" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "task_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "resolved": { + "type": "integer", + "contentEncoding": "int32" + }, + "unresolved": { + "type": "integer", + "contentEncoding": "int32" + }, + "items": { + "type": "array", + "items": { + "title": "Item", + "required": [ + "id", + "name", + "orderindex", + "assignee", + "resolved", + "parent", + "date_created", + "children" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "assignee": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema/properties/comments/items/properties/assignee", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema/properties/comments/items/properties/assignee" + }, + "resolved": { + "type": "boolean" + }, + "parent": { + "type": [ + "string", + "null" + ] + }, + "date_created": { + "type": "string" + }, + "children": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + } + }, + "examples": [ + { + "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", + "name": "Checklist Item", + "orderindex": 0, + "assignee": { + "id": 183, + "username": "John Doe", + "email": "example@email.com", + "color": "#827718", + "initials": "JD", + "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg" + }, + "resolved": false, + "parent": null, + "date_created": "1567711566859", + "children": [] + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", + "task_id": "9hv", + "name": "Checklist", + "date_created": "1567711563204", + "orderindex": 0, + "resolved": 0, + "unresolved": 1, + "items": [ + { + "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", + "name": "Checklist Item", + "orderindex": 0, + "assignee": { + "id": 183, + "username": "John Doe", + "email": "example@email.com", + "color": "#827718", + "initials": "JD", + "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg" + }, + "resolved": false, + "parent": null, + "date_created": "1567711566859", + "children": [] + } + ] + } + ] + } + }, + "examples": [ + { + "checklist": { + "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", + "task_id": "9hv", + "name": "Checklist", + "date_created": "1567711563204", + "orderindex": 0, + "resolved": 0, + "unresolved": 1, + "items": [ + { + "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", + "name": "Checklist Item", + "orderindex": 0, + "assignee": { + "id": 183, + "username": "John Doe", + "email": "example@email.com", + "color": "#827718", + "initials": "JD", + "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg" + }, + "resolved": false, + "parent": null, + "date_created": "1567711566859", + "children": [] + } + ] + } + } + ] + }, + "example": { + "checklist": { + "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", + "task_id": "9hv", + "name": "Checklist", + "date_created": "1567711563204", + "orderindex": 0, + "resolved": 0, + "unresolved": 1, + "items": [ + { + "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", + "name": "Checklist Item", + "orderindex": 0, + "assignee": { + "id": 183, + "username": "John Doe", + "email": "example@email.com", + "color": "#827718", + "initials": "JD", + "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg" + }, + "resolved": false, + "parent": null, + "date_created": "1567711566859", + "children": [] + } + ] + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 2, + "x-moar-complexity-skipped": false + } + }, + "/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}": { + "parameters": [], + "put": { + "summary": "Edit Checklist Item", + "tags": [ + "Task Checklists" + ], + "description": "Update an individual line item in a task checklist. \\\n \\\nYou can rename it, set the assignee, mark it as resolved, or nest it under another checklist item.", + "operationId": "EditChecklistItem", + "parameters": [ + { + "name": "checklist_id", + "in": "path", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "b955c4dc" + ] + } + }, + { + "name": "checklist_item_id", + "in": "path", + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "21e08dc8" + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "EditChecklistItemrequest", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "assignee": { + "type": [ + "string", + "null" + ] + }, + "resolved": { + "type": "boolean" + }, + "parent": { + "description": "To nest a checklist item under another checklist item, include the other item's `checklist_item_id`.", + "type": [ + "string", + "null" + ] + } + }, + "examples": [ + { + "name": "Updated Checklist Item", + "assignee": null, + "resolved": true, + "parent": null + } + ] + }, + "example": { + "name": "Updated Checklist Item", + "assignee": null, + "resolved": true, + "parent": null + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "EditChecklistItemresponse", + "required": [ + "checklist" + ], + "type": "object", + "properties": { + "checklist": { + "title": "Checklist2", + "required": [ + "id", + "task_id", + "name", + "date_created", + "orderindex", + "resolved", + "unresolved", + "items" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "task_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "resolved": { + "type": "integer", + "contentEncoding": "int32" + }, + "unresolved": { + "type": "integer", + "contentEncoding": "int32" + }, + "items": { + "type": "array", + "items": { + "title": "Item1", + "required": [ + "id", + "name", + "orderindex", + "assignee", + "resolved", + "parent", + "date_created", + "children" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "assignee": { + "type": [ + "string", + "null" + ] + }, + "resolved": { + "type": "boolean" + }, + "parent": { + "type": [ + "string", + "null" + ] + }, + "date_created": { + "type": "string" + }, + "children": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + } + }, + "examples": [ + { + "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", + "name": "Updated Checklist Item", + "orderindex": 0, + "assignee": null, + "resolved": true, + "parent": null, + "date_created": "1567711566859", + "children": [] + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", + "task_id": "9hv", + "name": "Checklist", + "date_created": "1567711563204", + "orderindex": 0, + "resolved": 1, + "unresolved": 0, + "items": [ + { + "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", + "name": "Updated Checklist Item", + "orderindex": 0, + "assignee": null, + "resolved": true, + "parent": null, + "date_created": "1567711566859", + "children": [] + } + ] + } + ] + } + }, + "examples": [ + { + "checklist": { + "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", + "task_id": "9hv", + "name": "Checklist", + "date_created": "1567711563204", + "orderindex": 0, + "resolved": 1, + "unresolved": 0, + "items": [ + { + "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", + "name": "Updated Checklist Item", + "orderindex": 0, + "assignee": null, + "resolved": true, + "parent": null, + "date_created": "1567711566859", + "children": [] + } + ] + } + } + ] + }, + "example": { + "checklist": { + "id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683", + "task_id": "9hv", + "name": "Checklist", + "date_created": "1567711563204", + "orderindex": 0, + "resolved": 1, + "unresolved": 0, + "items": [ + { + "id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f", + "name": "Updated Checklist Item", + "orderindex": 0, + "assignee": null, + "resolved": true, + "parent": null, + "date_created": "1567711566859", + "children": [] + } + ] + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 2, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Checklist Item", + "tags": [ + "Task Checklists" + ], + "description": "Delete a line item from a task checklist.", + "operationId": "DeleteChecklistItem", + "parameters": [ + { + "name": "checklist_id", + "in": "path", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "b955c4dc" + ] + } + }, + { + "name": "checklist_item_id", + "in": "path", + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "21e08dc8" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/comment": { + "parameters": [], + "get": { + "summary": "Get Task Comments", + "description": "View task comments. \\\n \\\nIf you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\\\n \\\nUse the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.", + "tags": [ + "Comments" + ], + "operationId": "GetTaskComments", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "start", + "in": "query", + "description": "Enter the `date` of a task comment using Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "start_id", + "in": "query", + "description": "Enter the Comment `id` of a task comment.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetTaskCommentsresponse", + "required": [ + "comments" + ], + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "title": "Comment", + "required": [ + "id", + "comment", + "comment_text", + "user", + "resolved", + "assignee", + "assigned_by", + "reactions", + "date" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "comment": { + "type": "array", + "items": { + "title": "Comment1", + "required": [ + "text" + ], + "type": "object", + "properties": { + "text": { + "type": "string" + } + }, + "examples": [ + { + "text": "Task comment content" + } + ] + }, + "description": "" + }, + "comment_text": { + "type": "string" + }, + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user" + }, + "resolved": { + "type": "boolean" + }, + "assignee": { + "title": "Assignee", + "required": [ + "id", + "username", + "email", + "color", + "initials", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 183, + "username": "John Doe", + "email": "example@email.com", + "color": "#827718", + "initials": "JD", + "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg" + } + ] + }, + "assigned_by": { + "title": "AssignedBy", + "required": [ + "id", + "username", + "initials", + "email", + "color", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + } + ] + }, + "reactions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "date": { + "type": "string" + }, + "reply_count": { + "type": "string", + "description": "For threaded comments, `reply_count` is always 0." + } + }, + "examples": [ + { + "id": "458", + "comment": [ + { + "text": "Task comment content" + } + ], + "comment_text": "Task comment content", + "user": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "resolved": false, + "assignee": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assigned_by": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "reactions": [], + "date": "1568036964079", + "reply_count": "1" + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "comments": [ + { + "id": "458", + "comment": [ + { + "text": "Task comment content" + } + ], + "comment_text": "Task comment content", + "user": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "resolved": false, + "assignee": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assigned_by": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "reactions": [], + "date": "1568036964079", + "reply_count": "1" + } + ] + } + ] + }, + "example": { + "comments": [ + { + "id": "458", + "comment": [ + { + "text": "Task comment content" + } + ], + "comment_text": "Task comment content", + "user": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "resolved": false, + "assignee": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assigned_by": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "reactions": [], + "date": "1568036964079", + "reply_count": "1" + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Task Comment", + "tags": [ + "Comments" + ], + "description": "Add a new comment to a task.", + "operationId": "CreateTaskComment", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateTaskCommentrequest", + "required": [ + "comment_text", + "notify_all" + ], + "type": "object", + "properties": { + "comment_text": { + "type": "string" + }, + "assignee": { + "type": "integer", + "contentEncoding": "int32" + }, + "group_assignee": { + "type": "string", + "contentEncoding": "int32", + "description": "" + }, + "notify_all": { + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.", + "type": "boolean" + } + }, + "examples": [ + { + "comment_text": "Task comment content", + "assignee": 183, + "group_assignee": "d01f92f-48ca-446d-88a1-0beb0e8f5f14", + "notify_all": true + } + ] + }, + "example": { + "comment_text": "Task comment content", + "assignee": 183, + "group_assignee": "dd01f92f-48ca-446d-88a1-0beb0e8f5f14", + "notify_all": true + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateTaskCommentresponse", + "required": [ + "id", + "hist_id", + "date" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "hist_id": { + "type": "string" + }, + "date": { + "type": "integer", + "contentEncoding": "int64" + } + }, + "examples": [ + { + "id": "458", + "hist_id": "26508", + "date": 1568036964079 + } + ] + }, + "example": { + "id": "458", + "hist_id": "26508", + "date": 1568036964079 + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 4, + "x-moar-complexity-skipped": false + } + }, + "/v2/view/{view_id}/comment": { + "parameters": [], + "get": { + "summary": "Get Chat View Comments", + "description": "View comments from a Chat view. \\\n \\\nIf you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\\\n \\\nUse the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.", + "tags": [ + "Comments" + ], + "operationId": "GetChatViewComments", + "parameters": [ + { + "name": "view_id", + "in": "path", + "description": "105 (string)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "3c" + ] + } + }, + { + "name": "start", + "in": "query", + "description": "Enter the `date` of a Chat view comment using Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "start_id", + "in": "query", + "description": "Enter the Comment `id` of a Chat view comment.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetChatViewCommentsresponse", + "required": [ + "comments" + ], + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "title": "Comment2", + "required": [ + "id", + "comment", + "comment_text", + "user", + "resolved", + "assignee", + "assigned_by", + "reactions", + "date" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "comment": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema/properties/comments/items/properties/comment/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema/properties/comments/items/properties/comment/items" + }, + "description": "" + }, + "comment_text": { + "type": "string" + }, + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user" + }, + "resolved": { + "type": "boolean" + }, + "assignee": { + "type": [ + "string", + "null" + ] + }, + "assigned_by": { + "type": [ + "string", + "null" + ] + }, + "reactions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "date": { + "type": "string" + }, + "reply_count": { + "type": "string" + } + }, + "examples": [ + { + "id": "459", + "comment": [ + { + "text": "View comment content" + } + ], + "comment_text": "View comment content", + "user": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "resolved": false, + "assignee": null, + "assigned_by": null, + "reactions": [], + "date": "1568036964079", + "reply_count": "1" + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "comments": [ + { + "id": "459", + "comment": [ + { + "text": "View comment content" + } + ], + "comment_text": "View comment content", + "user": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "resolved": false, + "assignee": null, + "assigned_by": null, + "reactions": [], + "date": "1568036964079", + "reply_count": "1" + } + ] + } + ] + }, + "example": { + "comments": [ + { + "id": "459", + "comment": [ + { + "text": "View comment content" + } + ], + "comment_text": "View comment content", + "user": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "resolved": false, + "assignee": null, + "assigned_by": null, + "reactions": [], + "date": "1568036964079", + "reply_count": "1" + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Chat View Comment", + "tags": [ + "Comments" + ], + "description": "Add a new comment to a Chat view.", + "operationId": "CreateChatViewComment", + "parameters": [ + { + "name": "view_id", + "in": "path", + "description": "105 (string)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "3c" + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateChatViewCommentrequest", + "required": [ + "comment_text", + "notify_all" + ], + "type": "object", + "properties": { + "comment_text": { + "type": "string" + }, + "notify_all": { + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.", + "type": "boolean" + } + }, + "examples": [ + { + "comment_text": "View comment content", + "notify_all": true + } + ] + }, + "example": { + "comment_text": "View comment content", + "notify_all": true + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateChatViewCommentresponse", + "required": [ + "id", + "hist_id", + "date" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "hist_id": { + "type": "string" + }, + "date": { + "type": "integer", + "contentEncoding": "int64" + } + }, + "examples": [ + { + "id": "459", + "hist_id": "0a45e16e-4e2f-4a9e-99ec-3cf520b87eae", + "date": 1568037065216 + } + ] + }, + "example": { + "id": "459", + "hist_id": "0a45e16e-4e2f-4a9e-99ec-3cf520b87eae", + "date": 1568037065216 + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 2, + "x-moar-complexity-skipped": false + } + }, + "/v2/list/{list_id}/comment": { + "parameters": [], + "get": { + "summary": "Get List Comments", + "description": "View the comments added to a List. \\\n \\\nIf you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\\\n \\\nUse the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.", + "tags": [ + "Comments" + ], + "operationId": "GetListComments", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 124 + ] + } + }, + { + "name": "start", + "in": "query", + "description": "Enter the `date` of a List info comment using Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "start_id", + "in": "query", + "description": "Enter the Comment `id` of a List info comment.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetListCommentsresponse", + "required": [ + "comments" + ], + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema/properties/comments/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema/properties/comments/items" + }, + "description": "" + } + }, + "examples": [ + { + "comments": [ + { + "id": "462", + "comment": [ + { + "text": "List comment content" + } + ], + "comment_text": "List comment content", + "user": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "resolved": false, + "assignee": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assigned_by": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "reactions": [], + "date": "1568036964079", + "reply_count": "1" + } + ] + } + ] + }, + "example": { + "comments": [ + { + "id": "462", + "comment": [ + { + "text": "List comment content" + } + ], + "comment_text": "List comment content", + "user": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "resolved": false, + "assignee": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assigned_by": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "reactions": [], + "date": "1568036964079", + "reply_count": "1" + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create List Comment", + "tags": [ + "Comments" + ], + "description": "Add a comment to a List.", + "operationId": "CreateListComment", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 124 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateListCommentrequest", + "required": [ + "comment_text", + "assignee", + "notify_all" + ], + "type": "object", + "properties": { + "comment_text": { + "type": "string" + }, + "assignee": { + "type": "integer", + "contentEncoding": "int32" + }, + "notify_all": { + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.", + "type": "boolean" + } + }, + "examples": [ + { + "comment_text": "List comment content", + "assignee": 183, + "notify_all": true + } + ] + }, + "example": { + "comment_text": "List comment content", + "assignee": 183, + "notify_all": true + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateListCommentresponse", + "required": [ + "id", + "hist_id", + "date" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "hist_id": { + "type": "string" + }, + "date": { + "type": "integer", + "contentEncoding": "int64" + } + }, + "examples": [ + { + "id": "462", + "hist_id": "5bbea9ad-7cc3-4038-a8bb-a89ac1337c08", + "date": 1568037341249 + } + ] + }, + "example": { + "id": "462", + "hist_id": "5bbea9ad-7cc3-4038-a8bb-a89ac1337c08", + "date": 1568037341249 + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 3, + "x-moar-complexity-skipped": false + } + }, + "/v2/comment/{comment_id}": { + "parameters": [], + "put": { + "summary": "Update Comment", + "tags": [ + "Comments" + ], + "description": "Replace the content of a task commment, assign a comment, and mark a comment as resolved.", + "operationId": "UpdateComment", + "parameters": [ + { + "name": "comment_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 456 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "UpdateCommentrequest", + "required": [ + "comment_text", + "assignee", + "resolved" + ], + "type": "object", + "properties": { + "comment_text": { + "type": "string" + }, + "assignee": { + "type": "integer", + "contentEncoding": "int32" + }, + "group_assignee": { + "type": "integer", + "contentEncoding": "int32", + "description": "" + }, + "resolved": { + "description": "", + "type": "boolean" + } + }, + "examples": [ + { + "comment_text": "Updated comment content", + "assignee": 183, + "resolved": true + } + ] + }, + "example": { + "comment_text": "Updated comment content", + "assignee": 183, + "group_assignee": "dd01f92f-48ca-446d-88a1-0beb0e8f5f14", + "resolved": true + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 4, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Comment", + "tags": [ + "Comments" + ], + "description": "Delete a task comment.", + "operationId": "DeleteComment", + "parameters": [ + { + "name": "comment_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 456 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/comment/{comment_id}/reply": { + "get": { + "summary": "Get Threaded Comments", + "description": "View threaded comments. The parent comment is not included in the response.", + "tags": [ + "Comments" + ], + "operationId": "GetThreadedComments", + "parameters": [ + { + "name": "comment_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 456 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema" + }, + "example": { + "comments": [ + { + "id": "458", + "comment": [ + { + "text": "Task comment content" + } + ], + "comment_text": "Task comment content", + "user": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "resolved": false, + "assignee": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assigned_by": { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "reactions": [], + "date": "1568036964079", + "reply_count": "0" + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Threaded Comment", + "tags": [ + "Comments" + ], + "description": "Create a threaded comment.", + "operationId": "CreateThreadedComment", + "parameters": [ + { + "name": "comment_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 456 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1comment/post/requestBody/content/application~1json/schema", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/post/requestBody/content/application~1json/schema" + }, + "example": { + "comment_text": "Task comment content", + "assignee": 183, + "group_assignee": "d01f92f-48ca-446d-88a1-0beb0e8f5f14", + "notify_all": true + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/list/{list_id}/field": { + "parameters": [], + "get": { + "summary": "Get List Custom Fields", + "tags": [ + "Custom Fields" + ], + "description": "View the Custom Fields you have access to in a specific List.", + "operationId": "GetAccessibleCustomFields", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetAccessibleCustomFieldsresponse", + "required": [ + "fields" + ], + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "title": "Field", + "required": [ + "id", + "name", + "type", + "type_config", + "date_created", + "hide_from_guests" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "type_config": { + "title": "TypeConfig", + "type": "object", + "properties": { + "options": { + "type": "array", + "items": { + "title": "Option", + "required": [ + "id", + "color" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "label": { + "type": "string" + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "value": { + "type": "integer", + "contentEncoding": "int32" + }, + "type": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "id": "fb332c98-d7bc-4ee8-a3bd-b5ffaff98c3c", + "label": "one", + "color": null + } + ] + }, + "description": "" + }, + "default": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": "integer", + "contentEncoding": "int32" + }, + {} + ] + }, + "precision": { + "type": "integer", + "contentEncoding": "int32" + }, + "currency_type": { + "type": "string" + }, + "placeholder": { + "type": [ + "string", + "null" + ] + }, + "end": { + "type": "integer", + "contentEncoding": "int32" + }, + "start": { + "type": "integer", + "contentEncoding": "int32" + }, + "count": { + "type": "integer", + "contentEncoding": "int32" + }, + "code_point": { + "type": "string" + }, + "tracking": { + "title": "Tracking", + "required": [ + "subtasks", + "checklists", + "assigned_comments" + ], + "type": "object", + "properties": { + "subtasks": { + "type": "boolean" + }, + "checklists": { + "type": "boolean" + }, + "assigned_comments": { + "type": "boolean" + } + }, + "examples": [ + { + "subtasks": true, + "checklists": true, + "assigned_comments": true + } + ] + }, + "complete_on": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + {} + ] + }, + "date_created": { + "type": "string" + }, + "hide_from_guests": { + "type": "boolean" + } + }, + "examples": [ + { + "id": "03efda77-c7a0-42d3-8afd-fd546353c2f5", + "name": "Text Field", + "type": "text", + "type_config": {}, + "date_created": "1566400407303", + "hide_from_guests": false + } + ] + }, + "description": "" + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/folder/{folder_id}/field": { + "parameters": [], + "get": { + "summary": "Get Folder Custom Fields", + "tags": [ + "Custom Fields" + ], + "description": "View the Custom Fields you have access to in a Folder. Get Folder Custom Fields only returns Custom Fields created at the Folder level. Custom Fields created at the List level are not included.", + "operationId": "getFolderAvailableFields", + "parameters": [ + { + "name": "folder_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetFolderAvailableFieldsresponse", + "required": [ + "fields" + ], + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D~1field/get/responses/200/content/application~1json/schema/properties/fields/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D~1field/get/responses/200/content/application~1json/schema/properties/fields/items" + }, + "description": "" + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/space/{space_id}/field": { + "parameters": [], + "get": { + "summary": "Get Space Custom Fields", + "tags": [ + "Custom Fields" + ], + "description": "View the Custom Fields you have access to in a specific Space. Get Space Custom Fields only returns Custom Fields created at the Space level. Custom Fields created at the Folder and List level are not included.", + "operationId": "getSpaceAvailableFields", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetSpaceAvailableFieldsresponse", + "required": [ + "fields" + ], + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D~1field/get/responses/200/content/application~1json/schema/properties/fields/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D~1field/get/responses/200/content/application~1json/schema/properties/fields/items" + }, + "description": "" + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/field": { + "parameters": [], + "get": { + "summary": "Get Workspace Custom Fields", + "tags": [ + "Custom Fields" + ], + "description": "View the Custom Fields you have access to in a specific Workspace. Get Workspace Custom Fields only returns Custom Fields created at the Workspace level. Custom Fields created at the Space, Folder, and List level are not included.", + "operationId": "getTeamAvailableFields", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetTeamAvailableFieldsresponse", + "required": [ + "fields" + ], + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D~1field/get/responses/200/content/application~1json/schema/properties/fields/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D~1field/get/responses/200/content/application~1json/schema/properties/fields/items" + }, + "description": "" + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/field/{field_id}": { + "parameters": [], + "post": { + "summary": "Set Custom Field Value", + "description": "Add data to a Custom field on a task. \\\n \\\nYou'll need to know the `task_id` of the task you want to update, and the universal unique identifier (UUID) `field_id` of the Custom Field you want to set. \\\n \\\nYou can use [Get Accessible Custom Fields](ref:getaccessiblecustomfields) or the [Get Task](ref:gettask) endpoint to find the `field_id`.", + "tags": [ + "Custom Fields" + ], + "operationId": "SetCustomFieldValue", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "Enter the task ID of the task you want to update.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + }, + { + "name": "field_id", + "in": "path", + "description": "Enter the universal unique identifier (UUID) of the Custom Field you want to set.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "b955c4dc" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by its Custom Task ID, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "SetCustomFieldValuerequest", + "anyOf": [ + { + "type": "object", + "title": "URL Custom Field", + "description": "The `value` must be a string with a valid URL.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "example": "https://clickup.com/api" + } + } + }, + { + "type": "object", + "title": "Dropdown Custom Field", + "description": "Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "example": "uuid1234" + } + } + }, + { + "type": "object", + "title": "Email Custom Field", + "description": "The `value` must be a string with a valid email address.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "example": "user@company.com" + } + } + }, + { + "type": "object", + "title": "Phone Custom Field", + "description": "The `value` must be a string with a valid country code.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "example": "+1 123 456 7890" + } + } + }, + { + "type": "object", + "title": "Date Custom Field", + "description": "The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.", + "properties": { + "value": { + "type": "integer", + "format": "int32", + "example": 1667367645000 + }, + "value_options": { + "type": "object", + "required": [ + "time" + ], + "properties": { + "time": { + "type": "boolean", + "example": true + } + } + } + } + }, + { + "type": "object", + "title": "Short or Long Text Custom Field", + "description": "Enter a string of text.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "example": "This is short or long text in a Custom Field." + } + } + }, + { + "type": "object", + "title": "Number Custom Field", + "description": "Enter a number.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "number", + "example": -28 + } + } + }, + { + "type": "object", + "title": "Money Custom Field", + "description": "You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "number", + "example": 8000 + } + } + }, + { + "type": "object", + "title": "Task Relationship Custom Field", + "description": "Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "string" + } + }, + "rem": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "type": "object", + "title": "People Custom Field", + "description": "Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams)", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "number" + } + }, + "rem": { + "type": "array", + "items": { + "type": "number" + } + } + } + } + } + }, + { + "type": "object", + "title": "Emoji (Rating) Custom Field", + "description": "Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "integer", + "format": "int32", + "example": 4 + } + } + }, + { + "type": "object", + "title": "Manual Progress Custom Field", + "description": "Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "object", + "required": [ + "current" + ], + "properties": { + "current": { + "type": "number", + "example": 20 + } + } + } + } + }, + { + "type": "object", + "title": "Label Custom Field", + "description": "Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "items": { + "type": "string", + "example": [ + "uuid1234", + "uuid9876" + ] + } + } + } + }, + { + "type": "object", + "title": "Location Custom Field", + "description": "Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "object", + "properties": { + "location": { + "type": "object", + "properties": { + "lat": { + "type": "number" + }, + "lng": { + "type": "number" + } + } + }, + "formatted_address": { + "type": "string" + } + } + } + } + }, + { + "type": "object", + "title": "Button Custom Field", + "description": "Set a button Custom Field to `true` to \"click\" it. This will trigger the button's action as if it was clicked in the UI.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "boolean", + "example": true + } + } + } + ] + }, + "examples": { + "URL Custom Field": { + "value": { + "value": "https://clickup.com/api" + } + }, + "Dropdown Custom Field": { + "value": { + "value": "uuid1234" + } + }, + "Email Custom Field": { + "value": { + "value": "user@company.com" + } + }, + "Phone Custom Field": { + "value": { + "value": "+1 201 555 0123" + } + }, + "Date Custom Field": { + "value": { + "value": 1667367645000, + "value_options": { + "time": true + } + } + }, + "Short or Long Text Custom Field": { + "value": { + "value": "This is short or long text in a Custom Field." + } + }, + "Number Custom Field": { + "value": { + "value": -28 + } + }, + "Money Custom Field": { + "value": { + "value": 8000 + } + }, + "Task Relationship Custom Field": { + "value": { + "value": { + "add": [ + "abcd1234", + "efghi5678" + ], + "rem": [ + "jklm9876", + "yuiop5678" + ] + } + } + }, + "People Custom Field": { + "value": { + "value": { + "add": [ + 123, + 456 + ], + "rem": [ + 987, + 765 + ] + } + } + }, + "Emoji (Rating) Custom Field": { + "value": { + "value": 4 + } + }, + "Manual Progress Custom Field": { + "value": { + "value": { + "current": 20 + } + } + }, + "Label Custom Field": { + "value": { + "value": [ + "uuid1234", + "uuid9876" + ] + } + }, + "Location Custom Field": { + "value": { + "value": { + "location": { + "lat": -28.016667, + "lng": 153.4 + }, + "formatted_address": "Gold Coast QLD, Australia" + } + } + }, + "Button Custom Field": { + "value": { + "value": true + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 20, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Remove Custom Field Value", + "tags": [ + "Custom Fields" + ], + "description": "Remove the data from a Custom Field on a task. This does not delete the option from the Custom Field.", + "operationId": "RemoveCustomFieldValue", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + }, + { + "name": "field_id", + "in": "path", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "b955c4dc" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/dependency": { + "parameters": [], + "post": { + "summary": "Add Dependency", + "tags": [ + "Task Relationships" + ], + "description": "Set a task as waiting on or blocking another task.", + "operationId": "AddDependency", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "This is the task which is waiting on or blocking another task.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "Use the `depends_on` parameter in the request body to specify the task that must be completed before the task in the path parameter.\\\n \\\nUse the `dependency_of` parameter in the request body to specify the task that's waiting for the task in the path parameter to be completed.\\\n \\\nYou can only use one per request.", + "content": { + "application/json": { + "schema": { + "title": "AddDependencyrequest", + "type": "object", + "properties": { + "depends_on": { + "type": "string" + }, + "depedency_of": { + "type": "string" + } + }, + "examples": [ + { + "depends_on": "9hw" + } + ] + }, + "example": { + "depends_on": "9hw" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 2, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Dependency", + "tags": [ + "Task Relationships" + ], + "description": "Remove the dependency relationship between two or more tasks.", + "operationId": "DeleteDependency", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + }, + { + "name": "depends_on", + "in": "query", + "description": "", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + }, + { + "name": "dependency_of", + "in": "query", + "description": "", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/link/{links_to}": { + "parameters": [], + "post": { + "summary": "Add Task Link", + "tags": [ + "Task Relationships" + ], + "description": "This is the equivalent of the feature _Task Links_ in the right-hand sidebar of a Task. It allows you to link two tasks together. General links or links to other objects than tasks are not supported.", + "operationId": "AddTaskLink", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "The task to initiate the link from.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + }, + { + "name": "links_to", + "in": "path", + "description": "The task to link to.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "AddTaskLinkresponse", + "required": [ + "task" + ], + "type": "object", + "properties": { + "task": { + "title": "Task", + "required": [ + "id", + "name", + "status", + "orderindex", + "date_created", + "date_updated", + "date_closed", + "creator", + "assignees", + "checklists", + "tags", + "parent", + "priority", + "due_date", + "start_date", + "time_estimate", + "time_spent", + "list", + "folder", + "space", + "linked_tasks", + "url" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "orderindex": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "date_updated": { + "type": "string" + }, + "date_closed": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator" + }, + "assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "checklists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "parent": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "type": [ + "string", + "null" + ] + }, + "due_date": { + "type": [ + "string", + "null" + ] + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "time_estimate": { + "type": [ + "string", + "null" + ] + }, + "time_spent": { + "type": [ + "string", + "null" + ] + }, + "list": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list" + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "linked_tasks": { + "type": "array", + "items": { + "title": "LinkedTask", + "required": [ + "task_id", + "link_id", + "date_created", + "userid" + ], + "type": "object", + "properties": { + "task_id": { + "type": "string" + }, + "link_id": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "userid": { + "type": "string" + } + }, + "examples": [ + { + "task_id": "9hv", + "link_id": "9hz", + "date_created": "1587571108988", + "userid": "183" + } + ] + }, + "description": "" + }, + "url": { + "type": "string" + } + }, + "examples": [ + { + "id": "9hv", + "name": "Task Name", + "status": { + "status": "in progress", + "color": "#d3d3d3", + "orderindex": 1, + "type": "custom" + }, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": null, + "due_date": null, + "start_date": null, + "time_estimate": null, + "time_spent": null, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "linked_tasks": [ + { + "task_id": "9hv", + "link_id": "9hz", + "date_created": "1587571108988", + "userid": "183" + } + ], + "url": "https://app.clickup.com/t/9hx" + } + ] + } + }, + "examples": [ + { + "task": { + "id": "9hv", + "name": "Task Name", + "status": { + "status": "in progress", + "color": "#d3d3d3", + "orderindex": 1, + "type": "custom" + }, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": null, + "due_date": null, + "start_date": null, + "time_estimate": null, + "time_spent": null, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "linked_tasks": [ + { + "task_id": "9hv", + "link_id": "9hz", + "date_created": "1587571108988", + "userid": "183" + } + ], + "url": "https://app.clickup.com/t/9hx" + } + } + ] + }, + "example": { + "task": { + "id": "9hv", + "name": "Task Name", + "status": { + "status": "in progress", + "color": "#d3d3d3", + "orderindex": 1, + "type": "custom" + }, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": null, + "due_date": null, + "start_date": null, + "time_estimate": null, + "time_spent": null, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "linked_tasks": [ + { + "task_id": "9hv", + "link_id": "9hz", + "date_created": "1587571108988", + "userid": "183" + } + ], + "url": "https://app.clickup.com/t/9hx" + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Task Link", + "tags": [ + "Task Relationships" + ], + "description": "Remove the link between two tasks.", + "operationId": "DeleteTaskLink", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + }, + { + "name": "links_to", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "DeleteTaskLinkresponse", + "required": [ + "task" + ], + "type": "object", + "properties": { + "task": { + "title": "Task1", + "required": [ + "id", + "name", + "status", + "orderindex", + "date_created", + "date_updated", + "date_closed", + "creator", + "assignees", + "checklists", + "tags", + "parent", + "priority", + "due_date", + "start_date", + "time_estimate", + "time_spent", + "list", + "folder", + "space", + "linked_tasks", + "url" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "orderindex": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "date_updated": { + "type": "string" + }, + "date_closed": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator" + }, + "assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "checklists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "parent": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "type": [ + "string", + "null" + ] + }, + "due_date": { + "type": [ + "string", + "null" + ] + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "time_estimate": { + "type": [ + "string", + "null" + ] + }, + "time_spent": { + "type": [ + "string", + "null" + ] + }, + "list": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list" + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "linked_tasks": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "url": { + "type": "string" + } + }, + "examples": [ + { + "id": "9hv", + "name": "Task Name", + "status": { + "status": "in progress", + "color": "#d3d3d3", + "orderindex": 1, + "type": "custom" + }, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": null, + "due_date": null, + "start_date": null, + "time_estimate": null, + "time_spent": null, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "linked_tasks": [], + "url": "https://app.clickup.com/t/9hx" + } + ] + } + }, + "examples": [ + { + "task": { + "id": "9hv", + "name": "Task Name", + "status": { + "status": "in progress", + "color": "#d3d3d3", + "orderindex": 1, + "type": "custom" + }, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": null, + "due_date": null, + "start_date": null, + "time_estimate": null, + "time_spent": null, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "linked_tasks": [], + "url": "https://app.clickup.com/t/9hx" + } + } + ] + }, + "example": { + "task": { + "id": "9hv", + "name": "Task Name", + "status": { + "status": "in progress", + "color": "#d3d3d3", + "orderindex": 1, + "type": "custom" + }, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": null, + "due_date": null, + "start_date": null, + "time_estimate": null, + "time_spent": null, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "linked_tasks": [], + "url": "https://app.clickup.com/t/9hx" + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/space/{space_id}/folder": { + "parameters": [], + "get": { + "summary": "Get Folders", + "tags": [ + "Folders" + ], + "description": "View the Folders in a Space.", + "operationId": "GetFolders", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 789 + ] + } + }, + { + "name": "archived", + "in": "query", + "description": "", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "description": "", + "examples": [ + { + "folders": [ + { + "id": "457", + "name": "Updated Folder Name", + "orderindex": 0, + "override_statuses": false, + "hidden": false, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "task_count": "0", + "lists": [] + }, + { + "id": "458", + "name": "Second Folder Name", + "orderindex": 1, + "override_statuses": false, + "hidden": false, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "task_count": "0", + "lists": [] + } + ] + } + ], + "contentMediaType": "application/json", + "title": "GetFoldersresponse", + "required": [ + "folders" + ], + "type": "object", + "properties": { + "folders": { + "title": "Folder5", + "required": [ + "id", + "name", + "orderindex", + "override_statuses", + "hidden", + "space", + "task_count", + "lists" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "override_statuses": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "task_count": { + "type": "string" + }, + "lists": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "examples": [ + { + "id": "1057", + "name": "Folder Name", + "orderindex": 5, + "override_statuses": true, + "hidden": false, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "task_count": "20", + "lists": [] + } + ] + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Folder", + "tags": [ + "Folders" + ], + "description": "Add a new Folder to a Space.", + "operationId": "CreateFolder", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 789 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateFolderrequest", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "examples": [ + { + "name": "New Folder Name" + } + ] + }, + "example": { + "name": "New Folder Name" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateFolderresponse", + "required": [ + "id", + "name", + "orderindex", + "override_statuses", + "hidden", + "space", + "task_count" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "override_statuses": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "task_count": { + "type": "string" + } + }, + "examples": [ + { + "id": "457", + "name": "New Folder Name", + "orderindex": 0, + "override_statuses": false, + "hidden": false, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "task_count": "0" + } + ] + }, + "example": { + "id": "457", + "name": "New Folder Name", + "orderindex": 0, + "override_statuses": false, + "hidden": false, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "task_count": "0" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 1, + "x-moar-complexity-skipped": false + } + }, + "/v2/folder/{folder_id}": { + "parameters": [], + "get": { + "summary": "Get Folder", + "tags": [ + "Folders" + ], + "description": "View the Lists within a Folder.", + "operationId": "GetFolder", + "parameters": [ + { + "name": "folder_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 457 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetFolderresponse", + "required": [ + "id", + "name", + "orderindex", + "override_statuses", + "hidden", + "space", + "task_count", + "lists" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "override_statuses": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "task_count": { + "type": "string" + }, + "lists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + } + }, + "examples": [ + { + "id": "457", + "name": "Updated Folder Name", + "orderindex": 0, + "override_statuses": false, + "hidden": false, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "task_count": "0", + "lists": [] + } + ] + }, + "example": { + "id": "457", + "name": "Updated Folder Name", + "orderindex": 0, + "override_statuses": false, + "hidden": false, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "task_count": "0", + "lists": [] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "put": { + "summary": "Update Folder", + "tags": [ + "Folders" + ], + "description": "Rename a Folder.", + "operationId": "UpdateFolder", + "parameters": [ + { + "name": "folder_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 457 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "UpdateFolderrequest", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "examples": [ + { + "name": "Updated Folder Name" + } + ] + }, + "example": { + "name": "Updated Folder Name" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "UpdateFolderresponse", + "required": [ + "id", + "name", + "orderindex", + "override_statuses", + "hidden", + "space", + "task_count" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "override_statuses": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "task_count": { + "type": "string" + } + }, + "examples": [ + { + "id": "457", + "name": "Updated Folder Name", + "orderindex": 0, + "override_statuses": false, + "hidden": false, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "task_count": "0" + } + ] + }, + "example": { + "id": "457", + "name": "Updated Folder Name", + "orderindex": 0, + "override_statuses": false, + "hidden": false, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "task_count": "0" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 1, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Folder", + "tags": [ + "Folders" + ], + "description": "Delete a Folder from your Workspace.", + "operationId": "DeleteFolder", + "parameters": [ + { + "name": "folder_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 457 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/goal": { + "parameters": [], + "get": { + "summary": "Get Goals", + "tags": [ + "Goals" + ], + "description": "View the Goals available in a Workspace.", + "operationId": "GetGoals", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "include_completed", + "in": "query", + "description": "", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetGoalsresponse", + "required": [ + "goals", + "folders" + ], + "type": "object", + "properties": { + "goals": { + "type": "array", + "items": { + "title": "Goal2", + "required": [ + "id", + "pretty_id", + "name", + "team_id", + "creator", + "owner", + "color", + "date_created", + "start_date", + "due_date", + "description", + "private", + "archived", + "multiple_owners", + "editor_token", + "date_updated", + "last_update", + "folder_id", + "pinned", + "owners", + "key_result_count", + "members", + "group_members", + "percent_completed" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "pretty_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "team_id": { + "type": "string" + }, + "creator": { + "type": "integer", + "contentEncoding": "int32" + }, + "owner": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "due_date": { + "type": "string" + }, + "description": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "multiple_owners": { + "type": "boolean" + }, + "editor_token": { + "type": "string" + }, + "date_updated": { + "type": "string" + }, + "last_update": { + "type": "string" + }, + "folder_id": { + "type": [ + "string", + "null" + ] + }, + "pinned": { + "type": "boolean" + }, + "owners": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "key_result_count": { + "type": "integer", + "contentEncoding": "int32" + }, + "members": { + "type": "array", + "items": { + "title": "Member1", + "required": [ + "id", + "username", + "email", + "color", + "permission_level", + "profilePicture", + "initials", + "isCreator" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "permission_level": { + "type": "string" + }, + "profilePicture": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "isCreator": { + "type": "boolean" + } + }, + "examples": [ + { + "id": 182, + "username": "Jane Doe", + "email": "janedoe@gmail.com", + "color": "#827718", + "permission_level": "edit", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg", + "initials": "JD", + "isCreator": true + } + ] + }, + "description": "" + }, + "group_members": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "percent_completed": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "pretty_id": "6", + "name": "Goal ABC", + "team_id": "512", + "creator": 182, + "owner": null, + "color": "#32a852", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Updated Goal Description", + "private": false, + "archived": false, + "multiple_owners": true, + "editor_token": "goal:792c3027-83a2-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485ed15e675", + "date_updated": "1626130440221", + "last_update": "1626132992152", + "folder_id": null, + "pinned": false, + "owners": [], + "key_result_count": 1, + "members": [ + { + "id": 182, + "username": "Jane Doe", + "email": "janedoe@gmail.com", + "color": "#827718", + "permission_level": "edit", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg", + "initials": "JD", + "isCreator": true + } + ], + "group_members": [], + "percent_completed": 0 + } + ] + }, + "description": "" + }, + "folders": { + "type": "array", + "items": { + "title": "Folder2", + "required": [ + "id", + "name", + "team_id", + "private", + "date_created", + "creator", + "goal_count", + "members", + "goals" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "team_id": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "date_created": { + "type": "string" + }, + "creator": { + "type": "integer", + "contentEncoding": "int32" + }, + "goal_count": { + "type": "integer", + "contentEncoding": "int32" + }, + "members": { + "type": "array", + "items": { + "title": "Member2", + "required": [ + "id", + "email", + "username", + "color", + "permission_level", + "date_added", + "added_by", + "initials", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "email": { + "type": "string" + }, + "username": { + "type": "string" + }, + "color": { + "type": "string" + }, + "permission_level": { + "type": "string" + }, + "date_added": { + "type": "integer", + "contentEncoding": "int64" + }, + "added_by": { + "type": "integer", + "contentEncoding": "int32" + }, + "initials": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 182, + "email": "janedoe@gmail.com", + "username": "Jane Doe", + "color": "#827718", + "permission_level": "read", + "date_added": 1631599941928, + "added_by": 183, + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg" + } + ] + }, + "description": "" + }, + "goals": { + "type": "array", + "items": { + "title": "Goal3", + "required": [ + "id", + "pretty_id", + "name", + "team_id", + "creator", + "owner", + "color", + "date_created", + "start_date", + "due_date", + "description", + "private", + "archived", + "multiple_owners", + "editor_token", + "date_updated", + "last_update", + "folder_id", + "folder_access", + "pinned", + "owners", + "key_result_count", + "members", + "group_members", + "percent_completed" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "pretty_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "team_id": { + "type": "string" + }, + "creator": { + "type": "integer", + "contentEncoding": "int32" + }, + "owner": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "due_date": { + "type": "string" + }, + "description": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "multiple_owners": { + "type": "boolean" + }, + "editor_token": { + "type": "string" + }, + "date_updated": { + "type": "string" + }, + "last_update": { + "type": "string" + }, + "folder_id": { + "type": "string" + }, + "folder_access": { + "type": "boolean" + }, + "pinned": { + "type": "boolean" + }, + "owners": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "key_result_count": { + "type": "integer", + "contentEncoding": "int32" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1goal/get/responses/200/content/application~1json/schema/properties/goals/items/properties/members/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1goal/get/responses/200/content/application~1json/schema/properties/goals/items/properties/members/items" + }, + "description": "" + }, + "group_members": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "percent_completed": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "pretty_id": "8", + "name": "Q1 Goals", + "team_id": "512", + "creator": 182, + "owner": null, + "color": "#32a852", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Goal for Q1", + "private": false, + "archived": false, + "multiple_owners": true, + "editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477", + "date_updated": "1626130440221", + "last_update": "1626132992152", + "folder_id": "05921253-7737-44af-a1aa-36fd11244e6f", + "folder_access": true, + "pinned": false, + "owners": [], + "key_result_count": 1, + "members": [ + { + "id": 182, + "username": "Jane Doe", + "email": "janedoe@gmail.com", + "color": "#827718", + "permission_level": "edit", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg", + "initials": "JD", + "isCreator": true + } + ], + "group_members": [], + "percent_completed": 1 + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "id": "05921253-7737-44af-a1aa-36fd11244e6f", + "name": "Quarterly Goals", + "team_id": "512", + "private": true, + "date_created": "1548802674671", + "creator": 182, + "goal_count": 1, + "members": [ + { + "id": 182, + "email": "janedoe@gmail.com", + "username": "Jane Doe", + "color": "#827718", + "permission_level": "read", + "date_added": 1631599941928, + "added_by": 183, + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg" + } + ], + "goals": [ + { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "pretty_id": "8", + "name": "Q1 Goals", + "team_id": "512", + "creator": 182, + "owner": null, + "color": "#32a852", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Goal for Q1", + "private": false, + "archived": false, + "multiple_owners": true, + "editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477", + "date_updated": "1626130440221", + "last_update": "1626132992152", + "folder_id": "05921253-7737-44af-a1aa-36fd11244e6f", + "folder_access": true, + "pinned": false, + "owners": [], + "key_result_count": 1, + "members": [ + { + "id": 182, + "username": "Jane Doe", + "email": "janedoe@gmail.com", + "color": "#827718", + "permission_level": "edit", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg", + "initials": "JD", + "isCreator": true + } + ], + "group_members": [], + "percent_completed": 1 + } + ] + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "goals": [ + { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "pretty_id": "6", + "name": "Goal ABC", + "team_id": "512", + "creator": 182, + "owner": null, + "color": "#32a852", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Updated Goal Description", + "private": false, + "archived": false, + "multiple_owners": true, + "editor_token": "goal:792c3027-83a2-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485ed15e675", + "date_updated": "1626130440221", + "last_update": "1626132992152", + "folder_id": null, + "pinned": false, + "owners": [], + "key_result_count": 1, + "members": [ + { + "id": 182, + "username": "Jane Doe", + "email": "janedoe@gmail.com", + "color": "#827718", + "permission_level": "edit", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg", + "initials": "JD", + "isCreator": true + } + ], + "group_members": [], + "percent_completed": 0 + } + ], + "folders": [ + { + "id": "05921253-7737-44af-a1aa-36fd11244e6f", + "name": "Quarterly Goals", + "team_id": "512", + "private": true, + "date_created": "1548802674671", + "creator": 182, + "goal_count": 1, + "members": [ + { + "id": 182, + "email": "janedoe@gmail.com", + "username": "Jane Doe", + "color": "#827718", + "permission_level": "read", + "date_added": 1631599941928, + "added_by": 183, + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg" + } + ], + "goals": [ + { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "pretty_id": "8", + "name": "Q1 Goals", + "team_id": "512", + "creator": 182, + "owner": null, + "color": "#32a852", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Goal for Q1", + "private": false, + "archived": false, + "multiple_owners": true, + "editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477", + "date_updated": "1626130440221", + "last_update": "1626132992152", + "folder_id": "05921253-7737-44af-a1aa-36fd11244e6f", + "folder_access": true, + "pinned": false, + "owners": [], + "key_result_count": 1, + "members": [ + { + "id": 182, + "username": "Jane Doe", + "email": "janedoe@gmail.com", + "color": "#827718", + "permission_level": "edit", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg", + "initials": "JD", + "isCreator": true + } + ], + "group_members": [], + "percent_completed": 1 + } + ] + } + ] + } + ] + }, + "example": { + "goals": [ + { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "pretty_id": "6", + "name": "Goal ABC", + "team_id": "512", + "creator": 182, + "owner": null, + "color": "#32a852", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Updated Goal Description", + "private": false, + "archived": false, + "multiple_owners": true, + "editor_token": "goal:792c3027-83a2-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485ed15e675", + "date_updated": "1626130440221", + "last_update": "1626132992152", + "folder_id": null, + "pinned": false, + "owners": [], + "key_result_count": 1, + "members": [ + { + "id": 182, + "username": "Jane Doe", + "email": "janedoe@gmail.com", + "color": "#827718", + "permission_level": "edit", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg", + "initials": "JD", + "isCreator": true + } + ], + "group_members": [], + "percent_completed": 0 + } + ], + "folders": [ + { + "id": "05921253-7737-44af-a1aa-36fd11244e6f", + "name": "Quarterly Goals", + "team_id": "512", + "private": true, + "date_created": "1548802674671", + "creator": 182, + "goal_count": 1, + "members": [ + { + "id": 182, + "email": "janedoe@gmail.com", + "username": "Jane Doe", + "color": "#827718", + "permission_level": "read", + "date_added": 1631599941928, + "added_by": 183, + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg" + } + ], + "goals": [ + { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "pretty_id": "8", + "name": "Q1 Goals", + "team_id": "512", + "creator": 182, + "owner": null, + "color": "#32a852", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Goal for Q1", + "private": false, + "archived": false, + "multiple_owners": true, + "editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477", + "date_updated": "1626130440221", + "last_update": "1626132992152", + "folder_id": "05921253-7737-44af-a1aa-36fd11244e6f", + "folder_access": true, + "pinned": false, + "owners": [], + "key_result_count": 1, + "members": [ + { + "id": 182, + "username": "Jane Doe", + "email": "janedoe@gmail.com", + "color": "#827718", + "permission_level": "edit", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg", + "initials": "JD", + "isCreator": true + } + ], + "group_members": [], + "percent_completed": 1 + } + ] + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Goal", + "tags": [ + "Goals" + ], + "description": "Add a new Goal to a Workspace.", + "operationId": "CreateGoal", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateGoalrequest", + "required": [ + "name", + "due_date", + "description", + "multiple_owners", + "owners", + "color" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "due_date": { + "type": "integer", + "contentEncoding": "int64" + }, + "description": { + "type": "string" + }, + "multiple_owners": { + "type": "boolean" + }, + "owners": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "Array of user IDs." + }, + "color": { + "type": "string" + } + }, + "examples": [ + { + "name": "Goal Name", + "due_date": 1568036964079, + "description": "Goal Description", + "multiple_owners": true, + "owners": [ + 183 + ], + "color": "#32a852" + } + ] + }, + "example": { + "name": "Goal Name", + "due_date": 1568036964079, + "description": "Goal Description", + "multiple_owners": true, + "owners": [ + 183 + ], + "color": "#32a852" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateGoalresponse", + "required": [ + "goal" + ], + "type": "object", + "properties": { + "goal": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal" + } + }, + "examples": [ + { + "goal": { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "Goal Name", + "team_id": "512", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Goal Description", + "private": false, + "archived": false, + "creator": 183, + "color": "#32a852", + "pretty_id": "6", + "multiple_owners": true, + "folder_id": null, + "members": [], + "owners": [ + { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + } + ], + "key_results": [], + "percent_completed": 0, + "history": [], + "pretty_url": "https://app.clickup.com/512/goals/6" + } + } + ] + }, + "example": { + "goal": { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "Goal Name", + "team_id": "512", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Goal Description", + "private": false, + "archived": false, + "creator": 183, + "color": "#32a852", + "pretty_id": "6", + "multiple_owners": true, + "folder_id": null, + "members": [], + "owners": [ + { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + } + ], + "key_results": [], + "percent_completed": 0, + "history": [], + "pretty_url": "https://app.clickup.com/512/goals/6" + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 6, + "x-moar-complexity-skipped": false + } + }, + "/v2/goal/{goal_id}": { + "parameters": [], + "get": { + "summary": "Get Goal", + "tags": [ + "Goals" + ], + "description": "View the details of a Goal including its Targets.", + "operationId": "GetGoal", + "parameters": [ + { + "name": "goal_id", + "in": "path", + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "e53a033c" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetGoalresponse", + "required": [ + "goal" + ], + "type": "object", + "properties": { + "goal": { + "title": "Goal", + "required": [ + "id", + "name", + "team_id", + "date_created", + "start_date", + "due_date", + "description", + "private", + "archived", + "creator", + "color", + "pretty_id", + "multiple_owners", + "folder_id", + "members", + "owners", + "key_results", + "percent_completed", + "history", + "pretty_url" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "team_id": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "due_date": { + "type": "string" + }, + "description": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "creator": { + "type": "integer", + "contentEncoding": "int32" + }, + "color": { + "type": "string" + }, + "pretty_id": { + "type": "string" + }, + "multiple_owners": { + "type": "boolean" + }, + "folder_id": { + "type": [ + "string", + "null" + ] + }, + "members": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "owners": { + "type": "array", + "items": { + "title": "Owner", + "required": [ + "id", + "username", + "initials", + "email", + "color", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + } + ] + }, + "description": "" + }, + "key_results": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "percent_completed": { + "type": "integer", + "contentEncoding": "int32" + }, + "history": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "pretty_url": { + "type": "string" + } + }, + "examples": [ + { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "Goal Name", + "team_id": "512", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Goal Description", + "private": false, + "archived": false, + "creator": 183, + "color": "#32a852", + "pretty_id": "6", + "multiple_owners": true, + "folder_id": null, + "members": [], + "owners": [ + { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + } + ], + "key_results": [], + "percent_completed": 0, + "history": [], + "pretty_url": "https://app.clickup.com/512/goals/6" + } + ] + } + }, + "examples": [ + { + "goal": { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "Updated Goal Name", + "team_id": "512", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Updated Goal Description", + "private": false, + "archived": false, + "creator": 183, + "color": "#32a852", + "pretty_id": "6", + "multiple_owners": true, + "folder_id": null, + "members": [], + "owners": [ + { + "id": 182, + "username": "Jane Doe", + "initials": "JD", + "email": "janedoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg" + } + ], + "key_results": [], + "percent_completed": 0, + "history": [], + "pretty_url": "https://app.clickup.com/512/goals/6" + } + } + ] + }, + "example": { + "goal": { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "Updated Goal Name", + "team_id": "512", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Updated Goal Description", + "private": false, + "archived": false, + "creator": 183, + "color": "#32a852", + "pretty_id": "6", + "multiple_owners": true, + "folder_id": null, + "members": [], + "owners": [ + { + "id": 182, + "username": "Jane Doe", + "initials": "JD", + "email": "janedoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg" + } + ], + "key_results": [], + "percent_completed": 0, + "history": [], + "pretty_url": "https://app.clickup.com/512/goals/6" + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "put": { + "summary": "Update Goal", + "tags": [ + "Goals" + ], + "description": "Rename a Goal, set the due date, replace the description, add or remove owners, and set the Goal color.", + "operationId": "UpdateGoal", + "parameters": [ + { + "name": "goal_id", + "in": "path", + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "e53a033c" + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "UpdateGoalrequest", + "required": [ + "name", + "due_date", + "description", + "rem_owners", + "add_owners", + "color" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "due_date": { + "type": "integer", + "contentEncoding": "int64" + }, + "description": { + "type": "string" + }, + "rem_owners": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "Array of user IDs." + }, + "add_owners": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "Array of user IDs." + }, + "color": { + "type": "string" + } + }, + "examples": [ + { + "name": "Updated Goal Name", + "due_date": 1568036964079, + "description": "Updated Goal Description", + "rem_owners": [ + 183 + ], + "add_owners": [ + 184 + ], + "color": "#32a852" + } + ] + }, + "example": { + "name": "Updated Goal Name", + "due_date": 1568036964079, + "description": "Updated Goal Description", + "rem_owners": [ + 183 + ], + "add_owners": [ + 184 + ], + "color": "#32a852" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "UpdateGoalresponse", + "required": [ + "goal" + ], + "type": "object", + "properties": { + "goal": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal" + } + }, + "examples": [ + { + "goal": { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "Updated Goal Name", + "team_id": "512", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Updated Goal Description", + "private": false, + "archived": false, + "creator": 183, + "color": "#32a852", + "pretty_id": "6", + "multiple_owners": true, + "folder_id": null, + "members": [], + "owners": [ + { + "id": 182, + "username": "Jane Doe", + "initials": "JD", + "email": "janedoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg" + } + ], + "key_results": [], + "percent_completed": 0, + "history": [], + "pretty_url": "https://app.clickup.com/512/goals/6" + } + } + ] + }, + "example": { + "goal": { + "id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "Updated Goal Name", + "team_id": "512", + "date_created": "1568044355026", + "start_date": null, + "due_date": "1568036964079", + "description": "Updated Goal Description", + "private": false, + "archived": false, + "creator": 183, + "color": "#32a852", + "pretty_id": "6", + "multiple_owners": true, + "folder_id": null, + "members": [], + "owners": [ + { + "id": 182, + "username": "Jane Doe", + "initials": "JD", + "email": "janedoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg" + } + ], + "key_results": [], + "percent_completed": 0, + "history": [], + "pretty_url": "https://app.clickup.com/512/goals/6" + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 6, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Goal", + "tags": [ + "Goals" + ], + "description": "Remove a Goal from your Workspace.", + "operationId": "DeleteGoal", + "parameters": [ + { + "name": "goal_id", + "in": "path", + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "e53a033c" + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/goal/{goal_id}/key_result": { + "parameters": [], + "post": { + "summary": "Create Key Result", + "tags": [ + "Goals" + ], + "description": "Add a Target to a Goal.", + "operationId": "CreateKeyResult", + "parameters": [ + { + "name": "goal_id", + "in": "path", + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "e53a033c" + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateKeyResultrequest", + "required": [ + "name", + "owners", + "type", + "steps_start", + "steps_end", + "unit", + "task_ids", + "list_ids" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "owners": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + }, + "type": { + "description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`.", + "type": "string" + }, + "steps_start": { + "type": "integer", + "contentEncoding": "int32" + }, + "steps_end": { + "type": "integer", + "contentEncoding": "int32" + }, + "unit": { + "type": "string" + }, + "task_ids": { + "description": "Enter an array of task IDs to link this target with one or more tasks.", + "type": "array", + "items": { + "type": "string" + } + }, + "list_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Enter an array of List IDs to link this target with one or more Lists." + } + }, + "examples": [ + { + "name": "New Target Name", + "owners": [ + 183 + ], + "type": "number", + "steps_start": 0, + "steps_end": 10, + "unit": "km", + "task_ids": [], + "list_ids": [] + } + ] + }, + "example": { + "name": "New Key Result Name", + "owners": [ + 183 + ], + "type": "number", + "steps_start": 0, + "steps_end": 10, + "unit": "km", + "task_ids": [], + "list_ids": [] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateKeyResultresponse", + "required": [ + "key_result" + ], + "type": "object", + "properties": { + "key_result": { + "title": "KeyResult", + "required": [ + "id", + "goal_id", + "name", + "type", + "unit", + "creator", + "date_created", + "goal_pretty_id", + "percent_completed", + "completed", + "task_ids", + "subcategory_ids", + "owners", + "last_action" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "goal_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "creator": { + "type": "integer", + "contentEncoding": "int32" + }, + "date_created": { + "type": "string" + }, + "goal_pretty_id": { + "type": "string" + }, + "percent_completed": { + "type": [ + "string", + "null" + ] + }, + "completed": { + "type": "boolean" + }, + "task_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "subcategory_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "owners": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal/properties/owners/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal/properties/owners/items" + }, + "description": "" + }, + "last_action": { + "title": "LastAction", + "required": [ + "id", + "key_result_id", + "userid", + "date_modified", + "steps_taken", + "note", + "steps_before", + "steps_current" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "key_result_id": { + "type": "string" + }, + "userid": { + "type": "integer", + "contentEncoding": "int32" + }, + "date_modified": { + "type": "string" + }, + "steps_taken": { + "type": [ + "string", + "null" + ] + }, + "note": { + "type": "string" + }, + "steps_before": { + "type": [ + "string", + "null" + ] + }, + "steps_current": { + "type": [ + "string", + "null" + ] + } + }, + "examples": [ + { + "id": "d3183d0f-5cbd-4158-b015-71465f1df269", + "key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93", + "userid": 183, + "date_modified": "1568062902048", + "steps_taken": null, + "note": "Created Key Result", + "steps_before": null, + "steps_current": null + } + ] + } + }, + "examples": [ + { + "id": "947d46ed-8480-49bc-8c57-e569747efe93", + "goal_id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "New Key Result Name", + "type": "number", + "unit": "km", + "creator": 183, + "date_created": "1568062902048", + "goal_pretty_id": "6", + "percent_completed": null, + "completed": false, + "task_ids": [], + "subcategory_ids": [], + "owners": [ + { + "id": 183, + "username": "John Doe", + "email": "example@email.com", + "color": "#827718", + "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg", + "initials": "JK" + } + ], + "last_action": { + "id": "d3183d0f-5cbd-4158-b015-71465f1df269", + "key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93", + "userid": 183, + "date_modified": "1568062902048", + "steps_taken": null, + "note": "Created Key Result", + "steps_before": null, + "steps_current": null + } + } + ] + } + }, + "examples": [ + { + "key_result": { + "id": "947d46ed-8480-49bc-8c57-e569747efe93", + "goal_id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "New Key Result Name", + "type": "number", + "unit": "km", + "creator": 183, + "date_created": "1568062902048", + "goal_pretty_id": "6", + "percent_completed": null, + "completed": false, + "task_ids": [], + "subcategory_ids": [], + "owners": [ + { + "id": 183, + "username": "John Doe", + "email": "example@email.com", + "color": "#827718", + "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg", + "initials": "JK" + } + ], + "last_action": { + "id": "d3183d0f-5cbd-4158-b015-71465f1df269", + "key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93", + "userid": 183, + "date_modified": "1568062902048", + "steps_taken": null, + "note": "Created Key Result", + "steps_before": null, + "steps_current": null + } + } + } + ] + }, + "example": { + "key_result": { + "id": "947d46ed-8480-49bc-8c57-e569747efe93", + "goal_id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "New Key Result Name", + "type": "number", + "unit": "km", + "creator": 183, + "date_created": "1568062902048", + "goal_pretty_id": "6", + "percent_completed": null, + "completed": false, + "task_ids": [], + "subcategory_ids": [], + "owners": [ + { + "id": 183, + "username": "John Doe", + "email": "example@email.com", + "color": "#827718", + "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg", + "initials": "JK" + } + ], + "last_action": { + "id": "d3183d0f-5cbd-4158-b015-71465f1df269", + "key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93", + "userid": 183, + "date_modified": "1568062902048", + "steps_taken": null, + "note": "Created Key Result", + "steps_before": null, + "steps_current": null + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 8, + "x-moar-complexity-skipped": false + } + }, + "/v2/key_result/{key_result_id}": { + "parameters": [], + "put": { + "summary": "Edit Key Result", + "tags": [ + "Goals" + ], + "description": "Update a Target.", + "operationId": "EditKeyResult", + "parameters": [ + { + "name": "key_result_id", + "in": "path", + "description": "8480-49bc-8c57-e569747efe93 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "947d46ed" + ] + } + } + ], + "requestBody": { + "description": "All properties available in the Create Key Result endpoint may also be used along with the additional properties below.", + "content": { + "application/json": { + "schema": { + "title": "EditKeyResultrequest", + "required": [ + "steps_current", + "note" + ], + "type": "object", + "properties": { + "steps_current": { + "type": "integer", + "contentEncoding": "int32" + }, + "note": { + "type": "string" + } + }, + "examples": [ + { + "steps_current": 5, + "note": "Target achieved" + } + ] + }, + "example": { + "steps_current": 5, + "note": "Target achieved" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "EditKeyResultresponse", + "required": [ + "key_result" + ], + "type": "object", + "properties": { + "key_result": { + "title": "KeyResult1", + "required": [ + "id", + "goal_id", + "name", + "type", + "unit", + "creator", + "date_created", + "goal_pretty_id", + "percent_completed", + "completed", + "task_ids", + "subcategory_ids", + "owners", + "last_action" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "goal_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "creator": { + "type": "integer", + "contentEncoding": "int32" + }, + "date_created": { + "type": "string" + }, + "goal_pretty_id": { + "type": "string" + }, + "percent_completed": { + "type": [ + "string", + "null" + ] + }, + "completed": { + "type": "boolean" + }, + "task_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "subcategory_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "owners": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal/properties/owners/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal/properties/owners/items" + }, + "description": "" + }, + "last_action": { + "title": "LastAction1", + "required": [ + "id", + "key_result_id", + "userid", + "date_modified", + "steps_taken", + "note", + "steps_before", + "steps_current", + "steps_before_float", + "steps_taken_float", + "steps_current_float" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "key_result_id": { + "type": "string" + }, + "userid": { + "type": "integer", + "contentEncoding": "int32" + }, + "date_modified": { + "type": "string" + }, + "steps_taken": { + "type": [ + "string", + "null" + ] + }, + "note": { + "type": "string" + }, + "steps_before": { + "type": [ + "string", + "null" + ] + }, + "steps_current": { + "type": [ + "string", + "null" + ] + }, + "steps_before_float": { + "type": "integer", + "contentEncoding": "int32" + }, + "steps_taken_float": { + "type": "integer", + "contentEncoding": "int32" + }, + "steps_current_float": { + "type": [ + "string", + "null" + ] + } + }, + "examples": [ + { + "id": "e889858b-a023-46cc-968a-cac32fd04c1e", + "key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8", + "userid": 183, + "date_modified": "1568122776851", + "steps_taken": null, + "note": "Target achieved", + "steps_before": null, + "steps_current": null, + "steps_before_float": 0, + "steps_taken_float": 5, + "steps_current_float": null + } + ] + } + }, + "examples": [ + { + "id": "947d46ed-8480-49bc-8c57-e569747efe93", + "goal_id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "New Key Result Name", + "type": "number", + "unit": "km", + "creator": 183, + "date_created": "1568062902048", + "goal_pretty_id": "6", + "percent_completed": null, + "completed": false, + "task_ids": [], + "subcategory_ids": [], + "owners": [ + { + "id": 183, + "username": "John Doe", + "email": "example@email.com", + "color": "#827718", + "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg", + "initials": "JK" + } + ], + "last_action": { + "id": "e889858b-a023-46cc-968a-cac32fd04c1e", + "key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8", + "userid": 183, + "date_modified": "1568122776851", + "steps_taken": null, + "note": "Target achieved", + "steps_before": null, + "steps_current": null, + "steps_before_float": 0, + "steps_taken_float": 5, + "steps_current_float": null + } + } + ] + } + }, + "examples": [ + { + "key_result": { + "id": "947d46ed-8480-49bc-8c57-e569747efe93", + "goal_id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "New Key Result Name", + "type": "number", + "unit": "km", + "creator": 183, + "date_created": "1568062902048", + "goal_pretty_id": "6", + "percent_completed": null, + "completed": false, + "task_ids": [], + "subcategory_ids": [], + "owners": [ + { + "id": 183, + "username": "John Doe", + "email": "example@email.com", + "color": "#827718", + "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg", + "initials": "JK" + } + ], + "last_action": { + "id": "e889858b-a023-46cc-968a-cac32fd04c1e", + "key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8", + "userid": 183, + "date_modified": "1568122776851", + "steps_taken": null, + "note": "Target achieved", + "steps_before": null, + "steps_current": null, + "steps_before_float": 0, + "steps_taken_float": 5, + "steps_current_float": null + } + } + } + ] + }, + "example": { + "key_result": { + "id": "947d46ed-8480-49bc-8c57-e569747efe93", + "goal_id": "e53a033c-900e-462d-a849-4a216b06d930", + "name": "New Key Result Name", + "type": "number", + "unit": "km", + "creator": 183, + "date_created": "1568062902048", + "goal_pretty_id": "6", + "percent_completed": null, + "completed": false, + "task_ids": [], + "subcategory_ids": [], + "owners": [ + { + "id": 183, + "username": "John Doe", + "email": "example@email.com", + "color": "#827718", + "profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg", + "initials": "JK" + } + ], + "last_action": { + "id": "e889858b-a023-46cc-968a-cac32fd04c1e", + "key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8", + "userid": 183, + "date_modified": "1568122776851", + "steps_taken": null, + "note": "Target achieved", + "steps_before": null, + "steps_current": null, + "steps_before_float": 0, + "steps_taken_float": 5, + "steps_current_float": null + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 2, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Key Result", + "tags": [ + "Goals" + ], + "description": "Delete a target from a Goal.", + "operationId": "DeleteKeyResult", + "parameters": [ + { + "name": "key_result_id", + "in": "path", + "description": "8480-49bc-8c57-e569747efe93 (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "947d46ed" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/guest": { + "parameters": [], + "post": { + "summary": "Invite Guest To Workspace", + "tags": [ + "Guests" + ], + "description": "Invite a guest to join a Workspace. To invite a member to your Workspace, use the [Invite User to Workspace](ref:inviteusertoworkspace) endpoint. \\\n \\\nYou'll also need to grant the guest access to specific items using the following endpoints: [Add Guest to Folder](ref:addguesttofolder), [Add Guest to List](ref:addguesttolist), or [Add Guest to Task](ref:addguesttotask). \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "InviteGuestToWorkspace", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "InviteGuestToWorkspacerequest", + "required": [ + "email" + ], + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "can_edit_tags": { + "type": "boolean" + }, + "can_see_time_spent": { + "type": "boolean" + }, + "can_see_time_estimated": { + "type": "boolean" + }, + "can_create_views": { + "type": "boolean" + }, + "can_see_points_estimated": { + "type": "boolean" + }, + "custom_role_id": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "email": "guest@example.com", + "can_edit_tags": true, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_create_views": true, + "can_see_points_estimated": true, + "custom_role_id": 12345 + } + ] + }, + "example": { + "email": "guest@example.com", + "can_edit_tags": true, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_create_views": true, + "custom_role_id": 12345 + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "InviteGuestToWorkspaceresponse", + "required": [ + "team" + ], + "type": "object", + "properties": { + "team": { + "title": "Team1", + "required": [ + "id", + "name", + "color", + "avatar", + "members", + "roles" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "avatar": { + "type": [ + "string", + "null" + ] + }, + "members": { + "type": "array", + "items": { + "title": "Member4", + "required": [ + "user", + "invited_by", + "can_see_time_spent", + "can_see_time_estimated", + "can_edit_tags", + "can_create_views" + ], + "type": "object", + "properties": { + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1guest~1%7Bguest_id%7D/put/responses/200/content/application~1json/schema/properties/guest/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1guest~1%7Bguest_id%7D/put/responses/200/content/application~1json/schema/properties/guest/properties/user" + }, + "invited_by": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by" + }, + "can_see_time_spent": { + "type": "boolean" + }, + "can_see_time_estimated": { + "type": "boolean" + }, + "can_edit_tags": { + "type": "boolean" + }, + "can_create_views": { + "type": "boolean" + }, + "can_see_points_estimated": { + "type": "boolean" + } + }, + "examples": [ + { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "custom_role": { + "id": 12345, + "name": "guest custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "can_create_views": true, + "can_see_points_estimated": true + } + ] + }, + "description": "" + }, + "roles": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user/post/responses/200/content/application~1json/schema/properties/team/properties/roles/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user/post/responses/200/content/application~1json/schema/properties/team/properties/roles/items" + }, + "description": "" + } + }, + "examples": [ + { + "id": "333", + "name": "Team Name", + "color": "#8D00D4", + "avatar": null, + "members": [ + { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "custom_role": { + "id": 12345, + "name": "guest custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_see_points_estimated": true, + "can_edit_tags": true, + "can_create_views": true + } + ], + "roles": [ + { + "id": 1, + "name": "owner", + "custom": false + }, + { + "id": 2, + "name": "admin", + "custom": false + }, + { + "id": 3, + "name": "member", + "custom": false + }, + { + "id": 4, + "name": "guest", + "custom": false + }, + { + "id": 998877, + "name": "member custom", + "inherited_role": 3, + "custom": true + }, + { + "id": 112233, + "name": "admin custom", + "inherited_role": 2, + "custom": true + }, + { + "id": 12345, + "name": "guest custom", + "inherited_role": 4, + "custom": true + } + ] + } + ] + } + }, + "examples": [ + { + "team": { + "id": "333", + "name": "Team Name", + "color": "#8D00D4", + "avatar": null, + "members": [ + { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "custom_role": { + "id": 12345, + "name": "guest custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_see_points_estimated": true, + "can_edit_tags": true, + "can_create_views": true + } + ], + "roles": [ + { + "id": 1, + "name": "owner", + "custom": false + }, + { + "id": 2, + "name": "admin", + "custom": false + }, + { + "id": 3, + "name": "member", + "custom": false + }, + { + "id": 4, + "name": "guest", + "custom": false + }, + { + "id": 998877, + "name": "member custom", + "inherited_role": 3, + "custom": true + }, + { + "id": 112233, + "name": "admin custom", + "inherited_role": 2, + "custom": true + }, + { + "id": 12345, + "name": "guest custom", + "inherited_role": 4, + "custom": true + } + ] + } + } + ] + }, + "example": { + "team": { + "id": "333", + "name": "Team Name", + "color": "#8D00D4", + "avatar": null, + "members": [ + { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "custom_role": { + "id": 12345, + "name": "guest custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "can_create_views": true, + "can_see_points_estimated": true + } + ], + "roles": [ + { + "id": 1, + "name": "owner", + "custom": false + }, + { + "id": 2, + "name": "admin", + "custom": false + }, + { + "id": 3, + "name": "member", + "custom": false + }, + { + "id": 4, + "name": "guest", + "custom": false + }, + { + "id": 998877, + "name": "member custom", + "inherited_role": 3, + "custom": true + }, + { + "id": 112233, + "name": "admin custom", + "inherited_role": 2, + "custom": true + }, + { + "id": 12345, + "name": "guest custom", + "inherited_role": 4, + "custom": true + } + ] + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 7, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/guest/{guest_id}": { + "parameters": [], + "get": { + "summary": "Get Guest", + "tags": [ + "Guests" + ], + "description": "View information about a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "GetGuest", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "guest_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "contentMediaType": "application/json" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "put": { + "summary": "Edit Guest On Workspace", + "tags": [ + "Guests" + ], + "description": "Configure options for a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "EditGuestOnWorkspace", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "guest_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "EditGuestOnWorkspacerequest", + "type": "object", + "properties": { + "can_see_points_estimated": { + "type": "boolean" + }, + "can_edit_tags": { + "type": "boolean" + }, + "can_see_time_spent": { + "type": "boolean" + }, + "can_see_time_estimated": { + "type": "boolean" + }, + "can_create_views": { + "type": "boolean" + }, + "custom_role_id": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "can_see_points_estimated": true, + "can_edit_tags": true, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_create_views": true, + "custom_role_id": 12345 + } + ] + }, + "example": { + "can_edit_tags": true, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_see_points_estimated": true, + "can_create_views": true, + "custom_role_id": 12345 + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "EditGuestOnWorkspaceresponse", + "required": [ + "guest" + ], + "type": "object", + "properties": { + "guest": { + "title": "Guest", + "type": "object", + "properties": { + "user": { + "title": "User5", + "required": [ + "id", + "username", + "email", + "color", + "profilePicture", + "initials", + "role", + "custom_role", + "last_active", + "date_joined", + "date_invited" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": "string" + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "profilePicture": { + "type": [ + "string", + "null" + ] + }, + "initials": { + "type": "string" + }, + "role": { + "type": "integer", + "contentEncoding": "int32" + }, + "custom_role": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/user/properties/custom_role", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/user/properties/custom_role" + }, + "last_active": { + "type": [ + "string", + "null" + ] + }, + "date_joined": { + "type": [ + "string", + "null" + ] + }, + "date_invited": { + "type": "string" + } + }, + "examples": [ + { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "custom_role": { + "id": 12345, + "name": "guest custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + } + ] + }, + "invited_by": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by" + }, + "can_see_time_spent": { + "type": "boolean" + }, + "can_see_time_estimated": { + "type": "boolean" + }, + "can_see_points_estimated": { + "type": "boolean" + }, + "can_edit_tags": { + "type": "boolean" + }, + "can_create_views": { + "type": "boolean" + }, + "shared": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/shared", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/shared" + } + }, + "examples": [ + { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "custom_role": { + "id": 12345, + "name": "guest custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_see_points_estimated": true, + "can_edit_tags": true, + "can_create_views": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + ] + } + }, + "examples": [ + { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "custom_role": { + "id": 12345, + "name": "guest custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "can_create_views": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + ] + }, + "example": { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "custom_role": { + "id": 12345, + "name": "guest custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "can_create_views": true, + "can_see_points_estimated": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 6, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Remove Guest From Workspace", + "tags": [ + "Guests" + ], + "description": "Revoke a guest's access to a Workspace. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "RemoveGuestFromWorkspace", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "guest_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "RemoveGuestFromWorkspaceresponse", + "required": [ + "team" + ], + "type": "object", + "properties": { + "team": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/delete/responses/200/content/application~1json/schema/properties/team", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/delete/responses/200/content/application~1json/schema/properties/team" + } + }, + "examples": [ + { + "team": { + "id": "333", + "name": "Team Name", + "color": "#8D00D4", + "avatar": null, + "members": [] + } + } + ] + }, + "example": { + "team": { + "id": "333", + "name": "Team Name", + "color": "#8D00D4", + "avatar": null, + "members": [] + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/guest/{guest_id}": { + "parameters": [], + "post": { + "summary": "Add Guest To Task", + "tags": [ + "Guests" + ], + "description": "Share a task with a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "AddGuestToTask", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "c04" + ] + } + }, + { + "name": "guest_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + }, + { + "name": "include_shared", + "in": "query", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "AddGuestToTaskrequest", + "required": [ + "permission_level" + ], + "type": "object", + "properties": { + "permission_level": { + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).", + "type": "string" + } + }, + "examples": [ + { + "permission_level": "read" + } + ] + }, + "example": { + "permission_level": "read" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "AddGuestToTaskresponse", + "required": [ + "guest" + ], + "type": "object", + "properties": { + "guest": { + "title": "Guest1", + "required": [ + "user", + "invited_by", + "can_see_time_spent", + "can_see_time_estimated", + "can_edit_tags", + "shared" + ], + "type": "object", + "properties": { + "user": { + "title": "User7", + "required": [ + "id", + "username", + "email", + "color", + "profilePicture", + "initials", + "role", + "last_active", + "date_joined", + "date_invited" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": "string" + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "profilePicture": { + "type": [ + "string", + "null" + ] + }, + "initials": { + "type": "string" + }, + "role": { + "type": "integer", + "contentEncoding": "int32" + }, + "last_active": { + "type": [ + "string", + "null" + ] + }, + "date_joined": { + "type": [ + "string", + "null" + ] + }, + "date_invited": { + "type": "string" + } + }, + "examples": [ + { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + } + ] + }, + "invited_by": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by" + }, + "can_see_time_spent": { + "type": "boolean" + }, + "can_see_time_estimated": { + "type": "boolean" + }, + "can_edit_tags": { + "type": "boolean" + }, + "shared": { + "title": "Shared1", + "required": [ + "tasks", + "lists", + "folders" + ], + "type": "object", + "properties": { + "tasks": { + "type": "array", + "items": { + "title": "Task2", + "required": [ + "id", + "name", + "status", + "orderindex", + "date_created", + "date_updated", + "date_closed", + "archived", + "creator", + "assignees", + "checklists", + "tags", + "parent", + "priority", + "due_date", + "start_date", + "points", + "time_estimate", + "custom_fields", + "dependencies", + "team_id", + "url", + "permission_level", + "list", + "folder", + "space" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "orderindex": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "date_updated": { + "type": "string" + }, + "date_closed": { + "type": [ + "string", + "null" + ] + }, + "archived": { + "type": "boolean" + }, + "creator": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator" + }, + "assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "checklists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "parent": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority" + }, + "due_date": { + "type": "string" + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "points": { + "type": [ + "string", + "null" + ] + }, + "time_estimate": { + "type": [ + "string", + "null" + ] + }, + "custom_fields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "dependencies": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "team_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "permission_level": { + "type": "string" + }, + "list": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1task/get/responses/200/content/application~1json/schema/properties/tasks/items/properties/list", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1task/get/responses/200/content/application~1json/schema/properties/tasks/items/properties/list" + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space" + } + }, + "examples": [ + { + "id": "c04", + "name": "Task Name", + "status": { + "status": "Open", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "orderindex": "0", + "date_created": "1574718405408", + "date_updated": "1574722145869", + "date_closed": null, + "archived": false, + "creator": { + "id": 183, + "username": "Jerry", + "color": "#827718", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": { + "id": "1", + "priority": "urgent", + "color": "#f50000", + "orderindex": "1" + }, + "due_date": "1508369194377", + "start_date": null, + "points": null, + "time_estimate": null, + "custom_fields": [], + "dependencies": [], + "team_id": "108", + "url": "https://app.clickup.com/t/c04", + "permission_level": "read", + "list": { + "id": "1752", + "name": "Shared with me", + "access": false + }, + "folder": { + "id": "1217", + "name": "Shared with me", + "hidden": false, + "access": false + }, + "space": { + "id": "380" + } + } + ] + }, + "description": "" + }, + "lists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "folders": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + } + }, + "examples": [ + { + "tasks": [ + { + "id": "c04", + "name": "Task Name", + "status": { + "status": "Open", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "orderindex": "0", + "date_created": "1574718405408", + "date_updated": "1574722145869", + "date_closed": null, + "archived": false, + "creator": { + "id": 183, + "username": "Jerry", + "color": "#827718", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": { + "id": "1", + "priority": "urgent", + "color": "#f50000", + "orderindex": "1" + }, + "due_date": "1508369194377", + "start_date": null, + "points": null, + "time_estimate": null, + "custom_fields": [], + "dependencies": [], + "team_id": "108", + "url": "https://app.clickup.com/t/c04", + "permission_level": "read", + "list": { + "id": "1752", + "name": "Shared with me", + "access": false + }, + "folder": { + "id": "1217", + "name": "Shared with me", + "hidden": false, + "access": false + }, + "space": { + "id": "380" + } + } + ], + "lists": [], + "folders": [] + } + ] + } + }, + "examples": [ + { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [ + { + "id": "c04", + "name": "Task Name", + "status": { + "status": "Open", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "orderindex": "0", + "date_created": "1574718405408", + "date_updated": "1574722145869", + "date_closed": null, + "archived": false, + "creator": { + "id": 183, + "username": "Jerry", + "color": "#827718", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": { + "id": "1", + "priority": "urgent", + "color": "#f50000", + "orderindex": "1" + }, + "due_date": "1508369194377", + "start_date": null, + "points": null, + "time_estimate": null, + "custom_fields": [], + "dependencies": [], + "team_id": "108", + "url": "https://app.clickup.com/t/c04", + "permission_level": "read", + "list": { + "id": "1752", + "name": "Shared with me", + "access": false + }, + "folder": { + "id": "1217", + "name": "Shared with me", + "hidden": false, + "access": false + }, + "space": { + "id": "380" + } + } + ], + "lists": [], + "folders": [] + } + } + ] + } + }, + "examples": [ + { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [ + { + "id": "c04", + "name": "Task Name", + "status": { + "status": "Open", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "orderindex": "0", + "date_created": "1574718405408", + "date_updated": "1574722145869", + "date_closed": null, + "archived": false, + "creator": { + "id": 183, + "username": "Jerry", + "color": "#827718", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": { + "id": "1", + "priority": "urgent", + "color": "#f50000", + "orderindex": "1" + }, + "due_date": "1508369194377", + "start_date": null, + "points": null, + "time_estimate": null, + "custom_fields": [], + "dependencies": [], + "team_id": "108", + "url": "https://app.clickup.com/t/c04", + "permission_level": "read", + "list": { + "id": "1752", + "name": "Shared with me", + "access": false + }, + "folder": { + "id": "1217", + "name": "Shared with me", + "hidden": false, + "access": false + }, + "space": { + "id": "380" + } + } + ], + "lists": [], + "folders": [] + } + } + } + ] + }, + "example": { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [ + { + "id": "c04", + "name": "Task Name", + "status": { + "status": "Open", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "orderindex": "0", + "date_created": "1574718405408", + "date_updated": "1574722145869", + "date_closed": null, + "archived": false, + "creator": { + "id": 183, + "username": "Jerry", + "color": "#827718", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": { + "id": "1", + "priority": "urgent", + "color": "#f50000", + "orderindex": "1" + }, + "due_date": "1508369194377", + "start_date": null, + "points": null, + "time_estimate": null, + "custom_fields": [], + "dependencies": [], + "team_id": "108", + "url": "https://app.clickup.com/t/c04", + "permission_level": "read", + "list": { + "id": "1752", + "name": "Shared with me", + "access": false + }, + "folder": { + "id": "1217", + "name": "Shared with me", + "hidden": false, + "access": false + }, + "space": { + "id": "380" + } + } + ], + "lists": [], + "folders": [] + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 1, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Remove Guest From Task", + "tags": [ + "Guests" + ], + "description": "Revoke a guest's access to a task. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "RemoveGuestFromTask", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "c04" + ] + } + }, + { + "name": "guest_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + }, + { + "name": "include_shared", + "in": "query", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "RemoveGuestFromTaskresponse", + "required": [ + "guest" + ], + "type": "object", + "properties": { + "guest": { + "title": "Guest2", + "required": [ + "user", + "invited_by", + "can_see_time_spent", + "can_see_time_estimated", + "can_edit_tags", + "shared" + ], + "type": "object", + "properties": { + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/post/responses/200/content/application~1json/schema/properties/guest/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/post/responses/200/content/application~1json/schema/properties/guest/properties/user" + }, + "invited_by": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by" + }, + "can_see_time_spent": { + "type": "boolean" + }, + "can_see_time_estimated": { + "type": "boolean" + }, + "can_edit_tags": { + "type": "boolean" + }, + "shared": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/shared", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/shared" + } + }, + "examples": [ + { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + ] + } + }, + "examples": [ + { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + ] + }, + "example": { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/list/{list_id}/guest/{guest_id}": { + "parameters": [], + "post": { + "summary": "Add Guest To List", + "tags": [ + "Guests" + ], + "description": "Share a List with a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "AddGuestToList", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 1427 + ] + } + }, + { + "name": "guest_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + }, + { + "name": "include_shared", + "in": "query", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "AddGuestToListrequest", + "required": [ + "permission_level" + ], + "type": "object", + "properties": { + "permission_level": { + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).", + "type": "string" + } + }, + "examples": [ + { + "permission_level": "read" + } + ] + }, + "example": { + "permission_level": "read" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "AddGuestToListresponse", + "required": [ + "guest" + ], + "type": "object", + "properties": { + "guest": { + "title": "Guest3", + "required": [ + "user", + "invited_by", + "can_see_time_spent", + "can_see_time_estimated", + "can_edit_tags", + "shared" + ], + "type": "object", + "properties": { + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/post/responses/200/content/application~1json/schema/properties/guest/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/post/responses/200/content/application~1json/schema/properties/guest/properties/user" + }, + "invited_by": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by" + }, + "can_see_time_spent": { + "type": "boolean" + }, + "can_see_time_estimated": { + "type": "boolean" + }, + "can_edit_tags": { + "type": "boolean" + }, + "shared": { + "title": "Shared3", + "required": [ + "tasks", + "lists", + "folders" + ], + "type": "object", + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "lists": { + "type": "array", + "items": { + "title": "List3", + "required": [ + "id", + "name", + "orderindex", + "status", + "priority", + "assignee", + "task_count", + "due_date", + "start_date", + "archived", + "override_statuses", + "statuses", + "permission_level" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "status": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "type": [ + "string", + "null" + ] + }, + "task_count": { + "type": "string" + }, + "due_date": { + "type": [ + "string", + "null" + ] + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "archived": { + "type": "boolean" + }, + "override_statuses": { + "type": "boolean" + }, + "statuses": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "description": "" + }, + "permission_level": { + "type": "string" + } + }, + "examples": [ + { + "id": "1427", + "name": "List Name", + "orderindex": 1, + "status": null, + "priority": null, + "assignee": null, + "task_count": "5", + "due_date": null, + "start_date": null, + "archived": false, + "override_statuses": true, + "statuses": [ + { + "status": "Open", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "Closed", + "orderindex": 5, + "color": "#6bc950", + "type": "closed" + } + ], + "permission_level": "read" + } + ] + }, + "description": "" + }, + "folders": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + } + }, + "examples": [ + { + "tasks": [], + "lists": [ + { + "id": "1427", + "name": "List Name", + "orderindex": 1, + "status": null, + "priority": null, + "assignee": null, + "task_count": "5", + "due_date": null, + "start_date": null, + "archived": false, + "override_statuses": true, + "statuses": [ + { + "status": "Open", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "Closed", + "orderindex": 5, + "color": "#6bc950", + "type": "closed" + } + ], + "permission_level": "read" + } + ], + "folders": [] + } + ] + } + }, + "examples": [ + { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [ + { + "id": "1427", + "name": "List Name", + "orderindex": 1, + "status": null, + "priority": null, + "assignee": null, + "task_count": "5", + "due_date": null, + "start_date": null, + "archived": false, + "override_statuses": true, + "statuses": [ + { + "status": "Open", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "Closed", + "orderindex": 5, + "color": "#6bc950", + "type": "closed" + } + ], + "permission_level": "read" + } + ], + "folders": [] + } + } + ] + } + }, + "examples": [ + { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [ + { + "id": "1427", + "name": "List Name", + "orderindex": 1, + "status": null, + "priority": null, + "assignee": null, + "task_count": "5", + "due_date": null, + "start_date": null, + "archived": false, + "override_statuses": true, + "statuses": [ + { + "status": "Open", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "Closed", + "orderindex": 5, + "color": "#6bc950", + "type": "closed" + } + ], + "permission_level": "read" + } + ], + "folders": [] + } + } + } + ] + }, + "example": { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [ + { + "id": "1427", + "name": "List Name", + "orderindex": 1, + "status": null, + "priority": null, + "assignee": null, + "task_count": "5", + "due_date": null, + "start_date": null, + "archived": false, + "override_statuses": true, + "statuses": [ + { + "status": "Open", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "Closed", + "orderindex": 5, + "color": "#6bc950", + "type": "closed" + } + ], + "permission_level": "read" + } + ], + "folders": [] + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 1, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Remove Guest From List", + "tags": [ + "Guests" + ], + "description": "Revoke a guest's access to a List.\\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "RemoveGuestFromList", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 1427 + ] + } + }, + { + "name": "guest_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + }, + { + "name": "include_shared", + "in": "query", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "RemoveGuestFromListresponse", + "required": [ + "guest" + ], + "type": "object", + "properties": { + "guest": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/delete/responses/200/content/application~1json/schema/properties/guest", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/delete/responses/200/content/application~1json/schema/properties/guest" + } + }, + "examples": [ + { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + ] + }, + "example": { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/folder/{folder_id}/guest/{guest_id}": { + "parameters": [], + "post": { + "summary": "Add Guest To Folder", + "tags": [ + "Guests" + ], + "description": "Share a Folder with a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "AddGuestToFolder", + "parameters": [ + { + "name": "folder_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 1057 + ] + } + }, + { + "name": "guest_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + }, + { + "name": "include_shared", + "in": "query", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "AddGuestToFolderrequest", + "required": [ + "permission_level" + ], + "type": "object", + "properties": { + "permission_level": { + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).", + "type": "string" + } + }, + "examples": [ + { + "permission_level": "read" + } + ] + }, + "example": { + "permission_level": "read" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "AddGuestToFolderresponse", + "required": [ + "guest" + ], + "type": "object", + "properties": { + "guest": { + "title": "Guest5", + "required": [ + "user", + "invited_by", + "can_see_time_spent", + "can_see_time_estimated", + "can_edit_tags", + "shared" + ], + "type": "object", + "properties": { + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/post/responses/200/content/application~1json/schema/properties/guest/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/post/responses/200/content/application~1json/schema/properties/guest/properties/user" + }, + "invited_by": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by" + }, + "can_see_time_spent": { + "type": "boolean" + }, + "can_see_time_estimated": { + "type": "boolean" + }, + "can_edit_tags": { + "type": "boolean" + }, + "shared": { + "title": "Shared5", + "required": [ + "tasks", + "lists", + "folders" + ], + "type": "object", + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "lists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "folders": { + "type": "array", + "items": { + "title": "Folder4", + "required": [ + "id", + "name", + "orderindex", + "override_statuses", + "hidden", + "task_count", + "archived", + "statuses", + "lists", + "permission_level" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "override_statuses": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + }, + "task_count": { + "type": "string" + }, + "archived": { + "type": "boolean" + }, + "statuses": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "description": "" + }, + "lists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "permission_level": { + "type": "string" + } + }, + "examples": [ + { + "id": "1057", + "name": "Folder Name", + "orderindex": 5, + "override_statuses": true, + "hidden": false, + "task_count": "20", + "archived": false, + "statuses": [ + { + "status": "Open", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "Closed", + "orderindex": 5, + "color": "#6bc950", + "type": "closed" + } + ], + "lists": [], + "permission_level": "read" + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "tasks": [], + "lists": [], + "folders": [ + { + "id": "1057", + "name": "Folder Name", + "orderindex": 5, + "override_statuses": true, + "hidden": false, + "task_count": "20", + "archived": false, + "statuses": [ + { + "status": "Open", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "Closed", + "orderindex": 5, + "color": "#6bc950", + "type": "closed" + } + ], + "lists": [], + "permission_level": "read" + } + ] + } + ] + } + }, + "examples": [ + { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [ + { + "id": "1057", + "name": "Folder Name", + "orderindex": 5, + "override_statuses": true, + "hidden": false, + "task_count": "20", + "archived": false, + "statuses": [ + { + "status": "Open", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "Closed", + "orderindex": 5, + "color": "#6bc950", + "type": "closed" + } + ], + "lists": [], + "permission_level": "read" + } + ] + } + } + ] + } + }, + "examples": [ + { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [ + { + "id": "1057", + "name": "Folder Name", + "orderindex": 5, + "override_statuses": true, + "hidden": false, + "task_count": "20", + "archived": false, + "statuses": [ + { + "status": "Open", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "Closed", + "orderindex": 5, + "color": "#6bc950", + "type": "closed" + } + ], + "lists": [], + "permission_level": "read" + } + ] + } + } + } + ] + }, + "example": { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [ + { + "id": "1057", + "name": "Folder Name", + "orderindex": 5, + "override_statuses": true, + "hidden": false, + "task_count": "20", + "archived": false, + "statuses": [ + { + "status": "Open", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "Closed", + "orderindex": 5, + "color": "#6bc950", + "type": "closed" + } + ], + "lists": [], + "permission_level": "read" + } + ] + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 1, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Remove Guest From Folder", + "tags": [ + "Guests" + ], + "description": "Revoke a guest's access to a Folder. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "RemoveGuestFromFolder", + "parameters": [ + { + "name": "folder_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 1057 + ] + } + }, + { + "name": "guest_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + }, + { + "name": "include_shared", + "in": "query", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "RemoveGuestFromFolderresponse", + "required": [ + "guest" + ], + "type": "object", + "properties": { + "guest": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/delete/responses/200/content/application~1json/schema/properties/guest", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/delete/responses/200/content/application~1json/schema/properties/guest" + } + }, + "examples": [ + { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + ] + }, + "example": { + "guest": { + "user": { + "id": 184, + "username": null, + "email": "guest@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 4, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "can_see_time_spent": true, + "can_see_time_estimated": true, + "can_edit_tags": true, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/folder/{folder_id}/list": { + "parameters": [], + "get": { + "summary": "Get Lists", + "tags": [ + "Lists" + ], + "description": "View the Lists within a Folder.", + "operationId": "GetLists", + "parameters": [ + { + "name": "folder_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 456 + ] + } + }, + { + "name": "archived", + "in": "query", + "description": "", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetListsresponse", + "required": [ + "lists" + ], + "type": "object", + "properties": { + "lists": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1list/get/responses/200/content/application~1json/schema/properties/lists/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D~1list/get/responses/200/content/application~1json/schema/properties/lists/items" + }, + "description": "" + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create List", + "tags": [ + "Lists" + ], + "description": "Add a new List to a Folder.", + "operationId": "CreateList", + "parameters": [ + { + "name": "folder_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 456 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateListrequest", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "content": { + "type": "string" + }, + "markdown_content": { + "type": "string", + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "due_date": { + "type": "integer", + "contentEncoding": "int64" + }, + "due_date_time": { + "type": "boolean" + }, + "priority": { + "type": "integer", + "contentEncoding": "int32" + }, + "assignee": { + "description": "Include a `user_id` to assign this List.", + "type": "integer", + "contentEncoding": "int32" + }, + "status": { + "description": "**Status** refers to the List color rather than the task Statuses available in the List.", + "type": "string" + } + }, + "examples": [ + { + "name": "New List Name", + "content": "New List Content", + "markdown_content": "# This is markdown\n ***bold and italicized text***", + "due_date": 1567780450202, + "due_date_time": false, + "priority": 1, + "assignee": 183, + "status": "red" + } + ] + }, + "example": { + "name": "New List Name", + "content": "New List Content", + "markdown_content": "# This is markdown\n ***bold and italicized text***", + "due_date": 1567780450202, + "due_date_time": false, + "priority": 1, + "assignee": 183, + "status": "red" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateListresponse", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "content": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "priority": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/priority", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/priority" + }, + "assignee": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1list/post/responses/200/content/application~1json/schema/properties/assignee", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D~1list/post/responses/200/content/application~1json/schema/properties/assignee" + }, + "task_count": { + "type": [ + "string", + "null" + ] + }, + "due_date": { + "type": "string" + }, + "due_date_time": { + "type": "boolean" + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "start_date_time": { + "type": [ + "string", + "null" + ] + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "statuses": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "description": "" + }, + "inbound_address": { + "type": "string" + } + }, + "examples": [ + { + "id": "124", + "name": "New List Name", + "orderindex": 1, + "content": "New List Content", + "status": { + "status": "red", + "color": "#e50000", + "hide_label": true + }, + "priority": { + "priority": "urgent", + "color": "#f50000" + }, + "assignee": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "task_count": null, + "due_date": "1567780450202", + "due_date_time": false, + "start_date": null, + "start_date_time": null, + "folder": { + "id": "456", + "name": "Folder Name", + "hidden": false, + "access": true + }, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "statuses": [ + { + "status": "to do", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "complete", + "orderindex": 1, + "color": "#6bc950", + "type": "closed" + } + ], + "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com" + } + ] + }, + "example": { + "id": "124", + "name": "New List Name", + "orderindex": 1, + "content": "New List Content", + "status": { + "status": "red", + "color": "#e50000", + "hide_label": true + }, + "priority": { + "priority": "urgent", + "color": "#f50000" + }, + "assignee": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "task_count": null, + "due_date": "1567780450202", + "due_date_time": false, + "start_date": null, + "start_date_time": null, + "folder": { + "id": "456", + "name": "Folder Name", + "hidden": false, + "access": true + }, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "statuses": [ + { + "status": "to do", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "complete", + "orderindex": 1, + "color": "#6bc950", + "type": "closed" + } + ], + "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 8, + "x-moar-complexity-skipped": false + } + }, + "/v2/space/{space_id}/folder_template/{template_id}": { + "post": { + "summary": "Create Folder from template", + "description": "Create a new Folder using a Folder template within a Space. This endpoint allows you to create a folder with all its nested assets (lists, tasks, etc.) from a predefined template available in your Workspace. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\nThis request can be run asynchronously or synchronously via the `return_immediately` parameter.\n", + "operationId": "CreateFolderFromTemplate", + "tags": [ + "Folders" + ], + "parameters": [ + { + "in": "path", + "name": "space_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "ID of the Space where the Folder will be created" + }, + { + "in": "path", + "name": "template_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "ID of the Folder template to use." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the new Folder" + }, + "options": { + "type": "object", + "description": "Options for creating the Folder", + "properties": { + "return_immediately": { + "type": "boolean", + "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n", + "default": true + }, + "content": { + "type": "string", + "description": "List description" + }, + "time_estimate": { + "type": "boolean", + "description": "Include time (hours, minutes and seconds)" + }, + "automation": { + "type": "boolean", + "description": "Import automation options" + }, + "include_views": { + "type": "boolean", + "description": "Import views" + }, + "old_due_date": { + "type": "boolean", + "description": "Import tasks due dates" + }, + "old_start_date": { + "type": "boolean", + "description": "Import tasks start dates" + }, + "old_followers": { + "type": "boolean", + "description": "Import tasks watchers" + }, + "comment_attachments": { + "type": "boolean", + "description": "Import tasks comment attachments" + }, + "recur_settings": { + "type": "boolean", + "description": "Import tasks recurring settings" + }, + "old_tags": { + "type": "boolean", + "description": "Import tasks tags" + }, + "old_statuses": { + "type": "boolean", + "description": "Import tasks status settings" + }, + "subtasks": { + "type": "boolean", + "description": "Import tasks subtasks" + }, + "custom_type": { + "type": "boolean", + "description": "Import tasks types" + }, + "old_assignees": { + "type": "boolean", + "description": "Import tasks assignees" + }, + "attachments": { + "type": "boolean", + "description": "Import tasks attachments" + }, + "comment": { + "type": "boolean", + "description": "Import tasks comments" + }, + "old_status": { + "type": "boolean", + "description": "Import tasks current statuses" + }, + "external_dependencies": { + "type": "boolean", + "description": "Import tasks external dependencies" + }, + "internal_dependencies": { + "type": "boolean", + "description": "Import tasks internal dependencies" + }, + "priority": { + "type": "boolean", + "description": "Import tasks priority" + }, + "custom_fields": { + "type": "boolean", + "description": "Import tasks Custom Fields" + }, + "old_checklists": { + "type": "boolean", + "description": "Import tasks checklists" + }, + "relationships": { + "type": "boolean", + "description": "Import tasks relationships" + }, + "old_subtask_assignees": { + "type": "boolean", + "description": "Import tasks subtasks and assignees combination" + }, + "start_date": { + "type": "string", + "format": "date-time", + "description": "Project start date for remapping dates" + }, + "due_date": { + "type": "string", + "format": "date-time", + "description": "Project due date for remapping dates" + }, + "remap_start_date": { + "type": "boolean", + "description": "Remap start dates" + }, + "skip_weekends": { + "type": "boolean", + "description": "Skip weekends when remapping dates" + }, + "archived": { + "type": "integer", + "enum": [ + 1, + 2, + null + ], + "description": "Include archived tasks (1 or 2 or null)" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Folder created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the created Folder" + }, + "folder": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the Folder" + }, + "name": { + "type": "string", + "description": "Name of the Folder" + }, + "orderindex": { + "type": "integer", + "description": "Order index of the Folder" + }, + "override_statuses": { + "type": "boolean", + "description": "Whether the Folder overrides default statuses" + }, + "hidden": { + "type": "boolean", + "description": "Whether the Folder is hidden" + }, + "space": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the Space containing the Folder" + }, + "name": { + "type": "string", + "description": "Name of the Space" + }, + "access": { + "type": "boolean", + "description": "Whether the user has access to the Space" + } + } + }, + "task_count": { + "type": "string", + "description": "Number of tasks in the Folder" + }, + "archived": { + "type": "boolean", + "description": "Whether the Folder is archived" + }, + "statuses": { + "type": "array", + "description": "List of statuses available in the Folder", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the status" + }, + "status": { + "type": "string", + "description": "Name of the status" + }, + "orderindex": { + "type": "integer", + "description": "Order index of the status" + }, + "color": { + "type": "string", + "description": "Color code for the status" + }, + "type": { + "type": "string", + "description": "Type of the status (closed, custom, open)" + } + } + } + }, + "lists": { + "type": "array", + "description": "Lists contained in the Folder", + "items": { + "type": "object" + } + }, + "permission_level": { + "type": "string", + "description": "Permission level for the current user" + } + } + } + }, + "example": { + "id": 90114316773, + "folder": { + "id": "90114316773", + "name": "Projects", + "orderindex": 0, + "override_statuses": true, + "hidden": false, + "space": { + "id": "90112667046", + "name": "Client Facing", + "access": true + }, + "task_count": "0", + "archived": false, + "statuses": [ + { + "id": "c90114316773_syqLtYOY", + "status": "complete", + "orderindex": 2, + "color": "#008844", + "type": "closed" + }, + { + "id": "c90114316773_g9uxhsQM", + "status": "in progress", + "orderindex": 1, + "color": "#1090e0", + "type": "custom" + }, + { + "id": "c90114316773_DCnaeiSB", + "status": "to do", + "orderindex": 0, + "color": "#87909e", + "type": "open" + } + ], + "lists": [], + "permission_level": "create" + } + } + } + } + } + }, + "400": { + "description": "Bad request - Name is required", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "Name is required" + }, + "ECODE": { + "type": "string", + "example": "OAUTH_119" + } + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Template or space not found" + }, + "500": { + "description": "Internal server error" + } + }, + "x-moar-primitive-count": 31, + "x-moar-complexity-skipped": false + } + }, + "/v2/space/{space_id}/list": { + "parameters": [], + "get": { + "summary": "Get Folderless Lists", + "tags": [ + "Lists" + ], + "description": "View the Lists in a Space that aren't located in a Folder.", + "operationId": "GetFolderlessLists", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 789 + ] + } + }, + { + "name": "archived", + "in": "query", + "description": "", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetFolderlessListsresponse", + "required": [ + "lists" + ], + "type": "object", + "properties": { + "lists": { + "type": "array", + "items": { + "title": "List4", + "required": [ + "id", + "name", + "orderindex", + "content", + "status", + "priority", + "assignee", + "task_count", + "due_date", + "start_date", + "folder", + "space", + "archived", + "override_statuses", + "permission_level" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "content": { + "type": "string" + }, + "status": { + "oneOf": [ + { + "title": "Status11", + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "color": { + "type": "string" + }, + "hide_label": { + "type": "boolean" + } + }, + "examples": [ + { + "status": "red", + "color": "#e50000", + "hide_label": true + } + ] + }, + { + "type": [ + "string", + "null" + ] + }, + {} + ], + "examples": [ + { + "status": "red", + "color": "#e50000", + "hide_label": true + } + ] + }, + "priority": { + "oneOf": [ + { + "title": "Priority4", + "type": "object", + "properties": { + "priority": { + "type": "string" + }, + "color": { + "type": "string" + } + }, + "examples": [ + { + "priority": "high", + "color": "#f50000" + } + ] + }, + { + "type": [ + "string", + "null" + ] + }, + {} + ], + "examples": [ + { + "priority": "high", + "color": "#f50000" + } + ] + }, + "assignee": { + "type": [ + "string", + "null" + ] + }, + "task_count": { + "type": [ + "string", + "null" + ] + }, + "due_date": { + "type": [ + "string", + "null" + ] + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "archived": { + "type": "boolean" + }, + "override_statuses": { + "type": "boolean" + }, + "permission_level": { + "type": "string" + } + }, + "examples": [ + { + "id": "124", + "name": "Updated List Name", + "orderindex": 1, + "content": "Updated List Content", + "status": { + "status": "red", + "color": "#e50000", + "hide_label": true + }, + "priority": { + "priority": "high", + "color": "#f50000" + }, + "assignee": null, + "task_count": null, + "due_date": "1567780450202", + "start_date": null, + "folder": { + "id": "456", + "name": "Folder Name", + "hidden": false, + "access": true + }, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "archived": false, + "override_statuses": false, + "permission_level": "create" + } + ] + }, + "description": "" + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Folderless List", + "tags": [ + "Lists" + ], + "description": "Add a new List in a Space.", + "operationId": "CreateFolderlessList", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 789 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateFolderlessListrequest", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "content": { + "type": "string" + }, + "markdown_content": { + "type": "string", + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "due_date": { + "type": "integer", + "contentEncoding": "int64" + }, + "due_date_time": { + "type": "boolean" + }, + "priority": { + "type": "integer", + "contentEncoding": "int32" + }, + "assignee": { + "description": "Include a `user_id` to add a List owner.", + "type": "integer", + "contentEncoding": "int32" + }, + "status": { + "description": "**Status** refers to the List color rather than the task Statuses available in the List.", + "type": "string" + } + }, + "examples": [ + { + "name": "New List Name", + "content": "New List Content", + "due_date": 1567780450202, + "due_date_time": false, + "priority": 1, + "assignee": 183, + "status": "red" + } + ] + }, + "example": { + "name": "New List Name", + "content": "New List Content", + "markdown_content": "# This is markdown\n ***bold and italicized text***", + "due_date": 1567780450202, + "due_date_time": false, + "priority": 1, + "assignee": 183, + "status": "red" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateFolderlessListresponse", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "content": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "priority": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/priority", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/priority" + }, + "assignee": { + "title": "Assignee3", + "required": [ + "id", + "color", + "username", + "initials", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "color": { + "type": "string" + }, + "username": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 183, + "color": "#827718", + "username": "John Doe", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + } + ] + }, + "task_count": { + "type": [ + "string", + "null" + ] + }, + "due_date": { + "type": "string" + }, + "due_date_time": { + "type": "boolean" + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "start_date_time": { + "type": [ + "string", + "null" + ] + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "statuses": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "description": "" + }, + "inbound_address": { + "type": "string" + } + }, + "examples": [ + { + "id": "124", + "name": "New List Name", + "orderindex": 1, + "content": "New List Content", + "status": { + "status": "red", + "color": "#e50000", + "hide_label": true + }, + "priority": { + "priority": "urgent", + "color": "#f50000" + }, + "assignee": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "task_count": null, + "due_date": "1567780450202", + "due_date_time": false, + "start_date": null, + "start_date_time": null, + "folder": { + "id": "457", + "name": "hidden", + "hidden": true, + "access": true + }, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "statuses": [ + { + "status": "to do", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "complete", + "orderindex": 1, + "color": "#6bc950", + "type": "closed" + } + ], + "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com" + } + ] + }, + "example": { + "id": "124", + "name": "New List Name", + "orderindex": 1, + "content": "New List Content", + "status": { + "status": "red", + "color": "#e50000", + "hide_label": true + }, + "priority": { + "priority": "urgent", + "color": "#f50000" + }, + "assignee": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "task_count": null, + "due_date": "1567780450202", + "due_date_time": false, + "start_date": null, + "start_date_time": null, + "folder": { + "id": "457", + "name": "hidden", + "hidden": true, + "access": true + }, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "statuses": [ + { + "status": "to do", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "complete", + "orderindex": 1, + "color": "#6bc950", + "type": "closed" + } + ], + "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 8, + "x-moar-complexity-skipped": false + } + }, + "/v2/list/{list_id}": { + "parameters": [], + "get": { + "summary": "Get List", + "tags": [ + "Lists" + ], + "description": "View information about a List.", + "operationId": "GetList", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "The List ID. To find the List ID, right-click the List in your Sidebar, select Copy link, and paste the link in your URL. The last string in the URL is your List ID.", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 124 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetListresponse", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "content": { + "type": "string" + }, + "status": { + "title": "Status5", + "required": [ + "status", + "color", + "hide_label" + ], + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "color": { + "type": "string" + }, + "hide_label": { + "type": "boolean" + } + }, + "examples": [ + { + "status": "red", + "color": "#e50000", + "hide_label": true + } + ] + }, + "priority": { + "title": "Priority1", + "required": [ + "priority", + "color" + ], + "type": "object", + "properties": { + "priority": { + "type": "string" + }, + "color": { + "type": "string" + } + }, + "examples": [ + { + "priority": "urgent", + "color": "#f50000" + } + ] + }, + "assignee": { + "type": [ + "string", + "null" + ] + }, + "task_count": { + "type": [ + "string", + "null" + ] + }, + "due_date": { + "type": "string" + }, + "due_date_time": { + "type": "boolean" + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "start_date_time": { + "type": [ + "string", + "null" + ] + }, + "folder": { + "title": "Folder3", + "required": [ + "id", + "name", + "hidden", + "access" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "hidden": { + "type": "boolean" + }, + "access": { + "type": "boolean" + } + }, + "examples": [ + { + "id": "1217", + "name": "Shared with me", + "hidden": false, + "access": false + } + ] + }, + "space": { + "title": "Space2", + "required": [ + "id", + "name", + "access" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "access": { + "type": "boolean" + } + }, + "examples": [ + { + "id": "789", + "name": "Space Name", + "access": true + } + ] + }, + "inbound_address": { + "type": "string" + }, + "archived": { + "type": "boolean" + }, + "override_statuses": { + "type": "boolean" + }, + "statuses": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "description": "" + }, + "permission_level": { + "type": "string" + } + }, + "examples": [ + { + "id": "124", + "name": "Updated List Name", + "orderindex": 1, + "content": "Updated List Content", + "status": { + "status": "red", + "color": "#e50000", + "hide_label": true + }, + "priority": { + "priority": "high", + "color": "#f50000" + }, + "assignee": null, + "due_date": "1567780450202", + "due_date_time": true, + "start_date": null, + "start_date_time": null, + "folder": { + "id": "456", + "name": "Folder Name", + "hidden": false, + "access": true + }, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "inbound_address": "add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com", + "archived": false, + "override_statuses": false, + "statuses": [ + { + "status": "to do", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "complete", + "orderindex": 1, + "color": "#6bc950", + "type": "closed" + } + ], + "permission_level": "create" + } + ] + }, + "example": { + "id": "124", + "name": "Updated List Name", + "orderindex": 1, + "content": "Updated List Content", + "status": { + "status": "red", + "color": "#e50000", + "hide_label": true + }, + "priority": { + "priority": "high", + "color": "#f50000" + }, + "assignee": null, + "task_count": 10, + "due_date": "1567780450202", + "due_date_time": true, + "start_date": null, + "start_date_time": null, + "folder": { + "id": "456", + "name": "Folder Name", + "hidden": false, + "access": true + }, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "inbound_address": "add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com", + "archived": false, + "override_statuses": false, + "statuses": [ + { + "status": "to do", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "complete", + "orderindex": 1, + "color": "#6bc950", + "type": "closed" + } + ], + "permission_level": "create" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "put": { + "summary": "Update List", + "tags": [ + "Lists" + ], + "description": "Rename a List, update the List Info description, set a due date/time, set the List's priority, set an assignee, set or remove the List color.", + "operationId": "UpdateList", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "124" + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "UpdateListrequest", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "content": { + "type": "string" + }, + "markdown_content": { + "type": "string", + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "due_date": { + "type": "integer", + "contentEncoding": "int64" + }, + "due_date_time": { + "type": "boolean" + }, + "priority": { + "type": "integer", + "contentEncoding": "int32" + }, + "assignee": { + "type": "string" + }, + "status": { + "description": "**Status** refers to the List color rather than the task Statuses available in the List.", + "type": "string" + }, + "unset_status": { + "description": "By default, this is `false.` To remove the List color use `unset_status: true`.", + "type": "boolean" + } + }, + "examples": [ + { + "name": "Updated List Name", + "content": "Updated List Content", + "markdown_content": "# This is markdown\n ***bold and italicized text***", + "due_date": 1567780450202, + "due_date_time": true, + "priority": 2, + "assignee": "none", + "status": "red", + "unset_status": true + } + ] + }, + "example": { + "name": "Updated List Name", + "content": "Updated List Content", + "markdown_content": "# This is markdown\n ***bold and italicized text***", + "due_date": 1567780450202, + "due_date_time": true, + "priority": 2, + "assignee": "none", + "status": "red", + "unset_status": true + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "UpdateListresponse", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "content": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "priority": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/priority", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/priority" + }, + "assignee": { + "type": [ + "string", + "null" + ] + }, + "task_count": { + "type": [ + "string", + "null" + ] + }, + "due_date": { + "type": "string" + }, + "due_date_time": { + "type": "boolean" + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "start_date_time": { + "type": [ + "string", + "null" + ] + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "statuses": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "description": "" + }, + "inbound_address": { + "type": "string" + } + }, + "examples": [ + { + "id": "124", + "name": "Updated List Name", + "orderindex": 1, + "content": "Updated List Content", + "status": { + "status": "red", + "color": "#e50000", + "hide_label": true + }, + "priority": { + "priority": "high", + "color": "#f50000" + }, + "assignee": null, + "task_count": null, + "due_date": "1567780450202", + "due_date_time": true, + "start_date": null, + "start_date_time": null, + "folder": { + "id": "456", + "name": "Folder Name", + "hidden": false, + "access": true + }, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "statuses": [ + { + "status": "to do", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "complete", + "orderindex": 1, + "color": "#6bc950", + "type": "closed" + } + ], + "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com" + } + ] + }, + "example": { + "id": "124", + "name": "Updated List Name", + "orderindex": 1, + "content": "Updated List Content", + "status": { + "status": "red", + "color": "#e50000", + "hide_label": true + }, + "priority": { + "priority": "high", + "color": "#f50000" + }, + "assignee": null, + "task_count": null, + "due_date": "1567780450202", + "due_date_time": true, + "start_date": null, + "start_date_time": null, + "folder": { + "id": "456", + "name": "Folder Name", + "hidden": false, + "access": true + }, + "space": { + "id": "789", + "name": "Space Name", + "access": true + }, + "statuses": [ + { + "status": "to do", + "orderindex": 0, + "color": "#d3d3d3", + "type": "open" + }, + { + "status": "complete", + "orderindex": 1, + "color": "#6bc950", + "type": "closed" + } + ], + "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 9, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete List", + "tags": [ + "Lists" + ], + "description": "Delete a List from your Workspace.", + "operationId": "DeleteList", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 124 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/list/{list_id}/task/{task_id}": { + "parameters": [], + "post": { + "summary": "Add Task To List", + "tags": [ + "Lists" + ], + "description": "Add a task to an additional List. \\\n \\\n***Note:** This endpoint requires the [Tasks in Multiple List ClickApp](https://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists) to be enabled.*", + "operationId": "AddTaskToList", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Remove Task From List", + "tags": [ + "Lists" + ], + "description": "Remove a task from an additional List. You can't remove a task from its home List. \\\n \\\n***Note:** This endpoint requires the [Tasks in Multiple List ClickApp](https://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists) to be enabled.*", + "operationId": "RemoveTaskFromList", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/member": { + "parameters": [], + "get": { + "summary": "Get Task Members", + "tags": [ + "Members" + ], + "description": "View the people who have access to a task. Responses do not include people with inherited Hierarchy permission to the task.", + "operationId": "GetTaskMembers", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetTaskMembersresponse", + "required": [ + "members" + ], + "type": "object", + "properties": { + "members": { + "type": "array", + "items": { + "title": "Member5", + "required": [ + "id", + "username", + "email", + "color", + "initials", + "profilePicture", + "profileInfo" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "initials": { + "type": "string" + }, + "profilePicture": { + "type": "string" + }, + "profileInfo": { + "title": "ProfileInfo", + "required": [ + "display_profile", + "verified_ambassador", + "verified_consultant", + "top_tier_user", + "viewed_verified_ambassador", + "viewed_verified_consultant", + "viewed_top_tier_user" + ], + "type": "object", + "properties": { + "display_profile": { + "type": [ + "string", + "null" + ] + }, + "verified_ambassador": { + "type": [ + "string", + "null" + ] + }, + "verified_consultant": { + "type": [ + "string", + "null" + ] + }, + "top_tier_user": { + "type": [ + "string", + "null" + ] + }, + "viewed_verified_ambassador": { + "type": [ + "string", + "null" + ] + }, + "viewed_verified_consultant": { + "type": [ + "string", + "null" + ] + }, + "viewed_top_tier_user": { + "type": [ + "string", + "null" + ] + } + }, + "examples": [ + { + "display_profile": null, + "verified_ambassador": null, + "verified_consultant": null, + "top_tier_user": null, + "viewed_verified_ambassador": null, + "viewed_verified_consultant": null, + "viewed_top_tier_user": null + } + ] + } + }, + "examples": [ + { + "id": 812, + "username": "John Doe", + "email": "john@example.com", + "color": "#FFFFFF", + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg", + "profileInfo": { + "display_profile": null, + "verified_ambassador": null, + "verified_consultant": null, + "top_tier_user": null, + "viewed_verified_ambassador": null, + "viewed_verified_consultant": null, + "viewed_top_tier_user": null + } + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "members": [ + { + "id": 812, + "username": "John Doe", + "email": "john@example.com", + "color": "#FFFFFF", + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg", + "profileInfo": { + "display_profile": null, + "verified_ambassador": null, + "verified_consultant": null, + "top_tier_user": null, + "viewed_verified_ambassador": null, + "viewed_verified_consultant": null, + "viewed_top_tier_user": null + } + }, + { + "id": 813, + "username": "Jane Doe", + "email": "jane@example.com", + "color": null, + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg", + "profileInfo": { + "display_profile": null, + "verified_ambassador": null, + "verified_consultant": null, + "top_tier_user": null, + "viewed_verified_ambassador": null, + "viewed_verified_consultant": null, + "viewed_top_tier_user": null + } + } + ] + } + ] + }, + "example": { + "members": [ + { + "id": 812, + "username": "John Doe", + "email": "john@example.com", + "color": "#FFFFFF", + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg", + "profileInfo": { + "display_profile": null, + "verified_ambassador": null, + "verified_consultant": null, + "top_tier_user": null, + "viewed_verified_ambassador": null, + "viewed_verified_consultant": null, + "viewed_top_tier_user": null + } + }, + { + "id": 813, + "username": "Jane Doe", + "email": "jane@example.com", + "color": null, + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg", + "profileInfo": { + "display_profile": null, + "verified_ambassador": null, + "verified_consultant": null, + "top_tier_user": null, + "viewed_verified_ambassador": null, + "viewed_verified_consultant": null, + "viewed_top_tier_user": null + } + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/list/{list_id}/member": { + "parameters": [], + "get": { + "summary": "Get List Members", + "tags": [ + "Members" + ], + "description": "Get Workspace members who have access to a List.", + "operationId": "GetListMembers", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetListMembersresponse", + "required": [ + "members" + ], + "type": "object", + "properties": { + "members": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1member/get/responses/200/content/application~1json/schema/properties/members/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1member/get/responses/200/content/application~1json/schema/properties/members/items" + }, + "description": "" + } + }, + "examples": [ + { + "members": [ + { + "id": 812, + "username": "John Doe", + "email": "john@example.com", + "color": "#FFFFFF", + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg", + "profileInfo": { + "display_profile": null, + "verified_ambassador": null, + "verified_consultant": null, + "top_tier_user": null, + "viewed_verified_ambassador": null, + "viewed_verified_consultant": null, + "viewed_top_tier_user": null + } + }, + { + "id": 813, + "username": "Jane Doe", + "email": "jane@example.com", + "color": null, + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg", + "profileInfo": { + "display_profile": null, + "verified_ambassador": null, + "verified_consultant": null, + "top_tier_user": null, + "viewed_verified_ambassador": null, + "viewed_verified_consultant": null, + "viewed_top_tier_user": null + } + } + ] + } + ] + }, + "example": { + "members": [ + { + "id": 812, + "username": "John Doe", + "email": "john@example.com", + "color": "#FFFFFF", + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg", + "profileInfo": { + "display_profile": null, + "verified_ambassador": null, + "verified_consultant": null, + "top_tier_user": null, + "viewed_verified_ambassador": null, + "viewed_verified_consultant": null, + "viewed_top_tier_user": null + } + }, + { + "id": 813, + "username": "Jane Doe", + "email": "jane@example.com", + "color": null, + "initials": "JD", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg", + "profileInfo": { + "display_profile": null, + "verified_ambassador": null, + "verified_consultant": null, + "top_tier_user": null, + "viewed_verified_ambassador": null, + "viewed_verified_consultant": null, + "viewed_top_tier_user": null + } + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/customroles": { + "parameters": [], + "get": { + "summary": "Get Custom Roles", + "tags": [ + "Roles" + ], + "description": "View the Custom Roles available in a Workspace.", + "operationId": "GetCustomRoles", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "include_members", + "in": "query", + "description": "", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetCustomRolesresponse", + "required": [ + "custom_roles" + ], + "type": "object", + "properties": { + "custom_roles": { + "type": "array", + "items": { + "title": "CustomRole2", + "required": [ + "id", + "team_id", + "name", + "inherited_role", + "date_created", + "members" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "team_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "inherited_role": { + "type": "integer", + "contentEncoding": "int32" + }, + "date_created": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + } + }, + "examples": [ + { + "id": 4547089, + "team_id": "301539", + "name": "guest custom", + "inherited_role": 4, + "date_created": "1651189835671", + "members": [ + 12345, + 67899 + ] + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "custom_roles": [ + { + "id": 4547089, + "team_id": "301539", + "name": "guest custom", + "inherited_role": 4, + "date_created": "1651189835671", + "members": [ + 12345, + 67899 + ] + }, + { + "id": 6715664, + "team_id": "301539", + "name": "member custom", + "inherited_role": 3, + "date_created": "1651189901020", + "members": [ + 5553, + 98989 + ] + }, + { + "id": 2957195, + "team_id": "301539", + "name": "admin custom", + "inherited_role": 2, + "date_created": "1651189904868", + "members": [ + 47474, + 818181 + ] + } + ] + } + ] + }, + "example": { + "custom_roles": [ + { + "id": 4547089, + "team_id": "301539", + "name": "guest custom", + "inherited_role": 4, + "date_created": "1651189835671", + "members": [ + 12345, + 67899 + ] + }, + { + "id": 6715664, + "team_id": "301539", + "name": "member custom", + "inherited_role": 3, + "date_created": "1651189901020", + "members": [ + 5553, + 98989 + ] + }, + { + "id": 2957195, + "team_id": "301539", + "name": "admin custom", + "inherited_role": 2, + "date_created": "1651189904868", + "members": [ + 47474, + 818181 + ] + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/shared": { + "parameters": [], + "get": { + "summary": "Shared Hierarchy", + "tags": [ + "Shared Hierarchy" + ], + "description": "View the tasks, Lists, and Folders that have been shared with the authenticated user.", + "operationId": "SharedHierarchy", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "SharedHierarchyresponse", + "required": [ + "shared" + ], + "type": "object", + "properties": { + "shared": { + "title": "Shared7", + "required": [ + "tasks", + "lists", + "folders" + ], + "type": "object", + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "lists": { + "type": "array", + "items": { + "title": "List6", + "required": [ + "id", + "name", + "orderindex", + "content", + "status", + "priority", + "assignee", + "task_count", + "due_date", + "start_date", + "archived" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "content": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "type": [ + "string", + "null" + ] + }, + "assignee": { + "type": [ + "string", + "null" + ] + }, + "task_count": { + "type": "string" + }, + "due_date": { + "type": [ + "string", + "null" + ] + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "archived": { + "type": "boolean" + } + }, + "examples": [ + { + "id": "1421", + "name": "Shared List", + "orderindex": 0, + "content": null, + "status": null, + "priority": null, + "assignee": null, + "task_count": "0", + "due_date": null, + "start_date": null, + "archived": false + } + ] + }, + "description": "" + }, + "folders": { + "type": "array", + "items": { + "title": "Folder11", + "required": [ + "id", + "name", + "orderindex", + "content", + "task_count", + "due_date", + "archived" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "content": { + "type": [ + "string", + "null" + ] + }, + "task_count": { + "type": "string" + }, + "due_date": { + "type": [ + "string", + "null" + ] + }, + "archived": { + "type": "boolean" + } + }, + "examples": [ + { + "id": "1058", + "name": "Shared Folder", + "orderindex": 0, + "content": null, + "task_count": "0", + "due_date": null, + "archived": false + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "tasks": [], + "lists": [ + { + "id": "1421", + "name": "Shared List", + "orderindex": 0, + "content": null, + "status": null, + "priority": null, + "assignee": null, + "task_count": "0", + "due_date": null, + "start_date": null, + "archived": false + } + ], + "folders": [ + { + "id": "1058", + "name": "Shared Folder", + "orderindex": 0, + "content": null, + "task_count": "0", + "due_date": null, + "archived": false + } + ] + } + ] + } + }, + "examples": [ + { + "shared": { + "tasks": [], + "lists": [ + { + "id": "1421", + "name": "Shared List", + "orderindex": 0, + "content": null, + "status": null, + "priority": null, + "assignee": null, + "task_count": "0", + "due_date": null, + "start_date": null, + "archived": false + } + ], + "folders": [ + { + "id": "1058", + "name": "Shared Folder", + "orderindex": 0, + "content": null, + "task_count": "0", + "due_date": null, + "archived": false + } + ] + } + } + ] + }, + "example": { + "shared": { + "tasks": [], + "lists": [ + { + "id": "1421", + "name": "Shared List", + "orderindex": 0, + "content": null, + "status": null, + "priority": null, + "assignee": null, + "task_count": "0", + "due_date": null, + "start_date": null, + "archived": false + } + ], + "folders": [ + { + "id": "1058", + "name": "Shared Folder", + "orderindex": 0, + "content": null, + "task_count": "0", + "due_date": null, + "archived": false + } + ] + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/space": { + "parameters": [], + "get": { + "summary": "Get Spaces", + "tags": [ + "Spaces" + ], + "description": "View the Spaces avialable in a Workspace. You can only get member info in private Spaces.", + "operationId": "GetSpaces", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "archived", + "in": "query", + "description": "", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetSpacesresponse", + "required": [ + "spaces" + ], + "type": "object", + "properties": { + "spaces": { + "type": "array", + "items": { + "title": "Space13", + "required": [ + "id", + "name", + "private", + "statuses", + "multiple_assignees", + "features" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "color": { + "type": "string" + }, + "avatar": { + "type": "string" + }, + "admin_can_manage": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team/get/responses/200/content/application~1json/schema/properties/teams/items/properties/members/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team/get/responses/200/content/application~1json/schema/properties/teams/items/properties/members/items" + }, + "description": "", + "user": { + "id": { + "type": "string" + }, + "username": { + "type": "string" + }, + "color": { + "type": "string" + }, + "profilePicture": { + "type": "string" + }, + "initials": { + "type": "string" + } + } + }, + "statuses": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "description": "" + }, + "multiple_assignees": { + "type": "boolean" + }, + "features": { + "title": "Features4", + "required": [ + "due_dates", + "time_tracking", + "tags", + "time_estimates", + "checklists" + ], + "type": "object", + "properties": { + "due_dates": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/due_dates", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/due_dates" + }, + "time_tracking": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/time_tracking", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/time_tracking" + }, + "tags": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/tags", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/tags" + }, + "time_estimates": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/time_estimates", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/time_estimates" + }, + "checklists": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/checklists", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/checklists" + }, + "custom_fields": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/custom_fields", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/custom_fields" + }, + "remap_dependencies": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/remap_dependencies", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/remap_dependencies" + }, + "dependency_warning": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/dependency_warning", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/dependency_warning" + }, + "portfolios": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/portfolios", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/portfolios" + } + }, + "examples": [ + { + "due_dates": { + "enabled": false, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": false + }, + "time_estimates": { + "enabled": false + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": false + }, + "dependency_warning": { + "enabled": false + }, + "portfolios": { + "enabled": false + } + } + ] + } + }, + "examples": [ + { + "id": "790", + "name": "Updated Space Name", + "private": false, + "color": null, + "avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg", + "admin_can_manage": true, + "archived": false, + "members": [ + { + "user": { + "id": 12312312, + "username": "John Jones", + "color": null, + "profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg", + "initials": "JJ" + } + } + ], + "statuses": [ + { + "status": "to do", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + }, + { + "status": "complete", + "type": "closed", + "orderindex": 1, + "color": "#6bc950" + } + ], + "multiple_assignees": false, + "features": { + "due_dates": { + "enabled": false, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": false + }, + "time_estimates": { + "enabled": false + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": false + }, + "dependency_warning": { + "enabled": false + }, + "portfolios": { + "enabled": false + } + } + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "spaces": [ + { + "id": "790", + "name": "Updated Space Name", + "private": false, + "color": null, + "avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg", + "admin_can_manage": true, + "archived": false, + "members": [ + { + "user": { + "id": "12312312,", + "username": "John Jones,", + "color": null, + "profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg,", + "initials": "JJ" + } + } + ], + "statuses": [ + { + "status": "to do", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + }, + { + "status": "complete", + "type": "closed", + "orderindex": 1, + "color": "#6bc950" + } + ], + "multiple_assignees": false, + "features": { + "due_dates": { + "enabled": false, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": false + }, + "time_estimates": { + "enabled": false + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": false + }, + "dependency_warning": { + "enabled": false + }, + "portfolios": { + "enabled": false + } + } + }, + { + "id": "791", + "name": "Second Space Name", + "private": false, + "statuses": [ + { + "status": "Open", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + }, + { + "status": "Closed", + "type": "closed", + "orderindex": 1, + "color": "#6bc950" + } + ], + "multiple_assignees": true, + "features": { + "due_dates": { + "enabled": true, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": true + }, + "tags": { + "enabled": true + }, + "time_estimates": { + "enabled": true + }, + "checklists": { + "enabled": true + } + } + } + ] + } + ] + }, + "example": { + "spaces": [ + { + "id": "790", + "name": "Updated Space Name", + "private": false, + "color": null, + "avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg", + "admin_can_manage": true, + "archived": false, + "members": [ + { + "user": { + "id": "12312312,", + "username": "John Jones,", + "color": null, + "profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg,", + "initials": "JJ" + } + } + ], + "statuses": [ + { + "status": "to do", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + }, + { + "status": "complete", + "type": "closed", + "orderindex": 1, + "color": "#6bc950" + } + ], + "multiple_assignees": false, + "features": { + "due_dates": { + "enabled": false, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": false + }, + "time_estimates": { + "enabled": false + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": false + }, + "dependency_warning": { + "enabled": false + }, + "portfolios": { + "enabled": false + } + } + }, + { + "id": "791", + "name": "Second Space Name", + "private": false, + "statuses": [ + { + "status": "Open", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + }, + { + "status": "Closed", + "type": "closed", + "orderindex": 1, + "color": "#6bc950" + } + ], + "multiple_assignees": true, + "features": { + "due_dates": { + "enabled": true, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": true + }, + "tags": { + "enabled": true + }, + "time_estimates": { + "enabled": true + }, + "checklists": { + "enabled": true + } + } + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Space", + "tags": [ + "Spaces" + ], + "description": "Add a new Space to a Workspace.", + "operationId": "CreateSpace", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateSpacerequest", + "required": [ + "name", + "multiple_assignees", + "features" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "multiple_assignees": { + "type": "boolean" + }, + "features": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features" + } + }, + "examples": [ + { + "name": "New Space Name", + "multiple_assignees": true, + "features": { + "due_dates": { + "enabled": true, + "start_date": false, + "remap_due_dates": true, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": true + }, + "time_estimates": { + "enabled": true + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": true + }, + "dependency_warning": { + "enabled": true + }, + "portfolios": { + "enabled": true + } + } + } + ] + }, + "example": { + "name": "New Space Name", + "multiple_assignees": true, + "features": { + "due_dates": { + "enabled": true, + "start_date": false, + "remap_due_dates": true, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": true + }, + "time_estimates": { + "enabled": true + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": true + }, + "dependency_warning": { + "enabled": true + }, + "portfolios": { + "enabled": true + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateSpaceresponse", + "required": [ + "id", + "name", + "private", + "statuses", + "multiple_assignees", + "features", + "archived" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "statuses": { + "type": "array", + "items": { + "title": "Status15", + "required": [ + "id", + "status", + "type", + "orderindex", + "color" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "type": "string" + }, + "type": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "color": { + "type": "string" + } + }, + "examples": [ + { + "id": "p16911531_p8y2WNC6", + "status": "to do", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + } + ] + }, + "description": "" + }, + "multiple_assignees": { + "type": "boolean" + }, + "features": { + "title": "Features1", + "required": [ + "due_dates", + "sprints", + "points", + "custom_items", + "tags", + "time_estimates", + "checklists", + "zoom", + "milestones", + "custom_fields", + "remap_dependencies", + "dependency_warning", + "multiple_assignees", + "portfolios", + "emails" + ], + "type": "object", + "properties": { + "due_dates": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/due_dates", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/due_dates" + }, + "sprints": { + "title": "Sprints", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": false + } + ] + }, + "points": { + "title": "Points", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": false + } + ] + }, + "custom_items": { + "title": "CustomItems", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": false + } + ] + }, + "tags": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/tags", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/tags" + }, + "time_estimates": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/time_estimates", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/time_estimates" + }, + "checklists": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/checklists", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/checklists" + }, + "zoom": { + "title": "Zoom", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": false + } + ] + }, + "milestones": { + "title": "Milestones", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": false + } + ] + }, + "custom_fields": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/custom_fields", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/custom_fields" + }, + "remap_dependencies": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/remap_dependencies", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/remap_dependencies" + }, + "dependency_warning": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/dependency_warning", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/dependency_warning" + }, + "multiple_assignees": { + "title": "MultipleAssignees", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": true + } + ] + }, + "portfolios": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/portfolios", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/portfolios" + }, + "emails": { + "title": "Emails", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": true + } + ] + } + }, + "examples": [ + { + "due_dates": { + "enabled": true, + "start_date": false, + "remap_due_dates": true, + "remap_closed_due_date": false + }, + "sprints": { + "enabled": false + }, + "points": { + "enabled": false + }, + "custom_items": { + "enabled": false + }, + "tags": { + "enabled": true + }, + "time_estimates": { + "enabled": true + }, + "checklists": { + "enabled": true + }, + "zoom": { + "enabled": false + }, + "milestones": { + "enabled": false + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": true + }, + "dependency_warning": { + "enabled": true + }, + "multiple_assignees": { + "enabled": true + }, + "portfolios": { + "enabled": true + }, + "emails": { + "enabled": true + } + } + ] + }, + "archived": { + "type": "boolean" + } + }, + "examples": [ + { + "id": "790", + "name": "New Space Name", + "private": false, + "statuses": [ + { + "id": "p16911531_p8y2WNC6", + "status": "to do", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + }, + { + "id": "p17911545_ABo7jSsf", + "status": "complete", + "type": "closed", + "orderindex": 1, + "color": "#6bc950" + } + ], + "multiple_assignees": true, + "features": { + "due_dates": { + "enabled": true, + "start_date": false, + "remap_due_dates": true, + "remap_closed_due_date": false + }, + "sprints": { + "enabled": false + }, + "points": { + "enabled": false + }, + "custom_items": { + "enabled": false + }, + "tags": { + "enabled": true + }, + "time_estimates": { + "enabled": true + }, + "checklists": { + "enabled": true + }, + "zoom": { + "enabled": false + }, + "milestones": { + "enabled": false + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": true + }, + "dependency_warning": { + "enabled": true + }, + "multiple_assignees": { + "enabled": true + }, + "portfolios": { + "enabled": true + }, + "emails": { + "enabled": true + } + }, + "archived": false + } + ] + }, + "example": { + "id": "790", + "name": "New Space Name", + "private": false, + "statuses": [ + { + "id": "p16911531_p8y2WNC6", + "status": "to do", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + }, + { + "id": "p17911545_ABo7jSsf", + "status": "complete", + "type": "closed", + "orderindex": 1, + "color": "#6bc950" + } + ], + "multiple_assignees": true, + "features": { + "due_dates": { + "enabled": true, + "start_date": false, + "remap_due_dates": true, + "remap_closed_due_date": false + }, + "sprints": { + "enabled": false + }, + "points": { + "enabled": false + }, + "custom_items": { + "enabled": false + }, + "tags": { + "enabled": true + }, + "time_estimates": { + "enabled": true + }, + "checklists": { + "enabled": true + }, + "zoom": { + "enabled": false + }, + "milestones": { + "enabled": false + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": true + }, + "dependency_warning": { + "enabled": true + }, + "multiple_assignees": { + "enabled": true + }, + "portfolios": { + "enabled": true + }, + "emails": { + "enabled": true + } + }, + "archived": false + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 2, + "x-moar-complexity-skipped": false + } + }, + "/v2/space/{space_id}": { + "parameters": [], + "get": { + "summary": "Get Space", + "tags": [ + "Spaces" + ], + "description": "View the Spaces available in a Workspace.", + "operationId": "GetSpace", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 790 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetSpaceresponse", + "required": [ + "id", + "name", + "private", + "statuses", + "multiple_assignees", + "features" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "statuses": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "description": "" + }, + "multiple_assignees": { + "type": "boolean" + }, + "features": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features" + } + }, + "examples": [ + { + "id": "790", + "name": "Updated Space Name", + "private": false, + "statuses": [ + { + "status": "to do", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + }, + { + "status": "complete", + "type": "closed", + "orderindex": 1, + "color": "#6bc950" + } + ], + "multiple_assignees": false, + "features": { + "due_dates": { + "enabled": false, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": false + }, + "time_estimates": { + "enabled": false + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": false + }, + "dependency_warning": { + "enabled": false + }, + "portfolios": { + "enabled": false + } + } + } + ] + }, + "example": { + "id": "790", + "name": "Updated Space Name", + "private": false, + "statuses": [ + { + "status": "to do", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + }, + { + "status": "complete", + "type": "closed", + "orderindex": 1, + "color": "#6bc950" + } + ], + "multiple_assignees": false, + "features": { + "due_dates": { + "enabled": false, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": false + }, + "time_estimates": { + "enabled": false + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": false + }, + "dependency_warning": { + "enabled": false + }, + "portfolios": { + "enabled": false + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "put": { + "summary": "Update Space", + "tags": [ + "Spaces" + ], + "description": "Rename, set the Space color, and enable ClickApps for a Space.", + "operationId": "UpdateSpace", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 790 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "UpdateSpacerequest", + "required": [ + "name", + "color", + "private", + "admin_can_manage", + "multiple_assignees", + "features" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "admin_can_manage": { + "description": "***Note:** Allowing or restricting admins from managing private Spaces using `\"admin_can_manage\"` is an [Enterprise Plan](https://clickup.com/pricing) feature.*", + "type": "boolean" + }, + "multiple_assignees": { + "type": "boolean" + }, + "features": { + "title": "Features", + "required": [ + "due_dates", + "time_tracking", + "tags", + "time_estimates", + "checklists", + "custom_fields", + "remap_dependencies", + "dependency_warning", + "portfolios" + ], + "type": "object", + "properties": { + "due_dates": { + "title": "DueDates", + "required": [ + "enabled", + "start_date", + "remap_due_dates", + "remap_closed_due_date" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "start_date": { + "type": "boolean" + }, + "remap_due_dates": { + "type": "boolean" + }, + "remap_closed_due_date": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": true, + "start_date": false, + "remap_due_dates": true, + "remap_closed_due_date": false + } + ] + }, + "time_tracking": { + "title": "TimeTracking", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": false + } + ] + }, + "tags": { + "title": "Tags", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": true + } + ] + }, + "time_estimates": { + "title": "TimeEstimates", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": true + } + ] + }, + "checklists": { + "title": "Checklists", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": true + } + ] + }, + "custom_fields": { + "title": "CustomFields", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": true + } + ] + }, + "remap_dependencies": { + "title": "RemapDependencies", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": true + } + ] + }, + "dependency_warning": { + "title": "DependencyWarning", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": true + } + ] + }, + "portfolios": { + "title": "Portfolios", + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "examples": [ + { + "enabled": true + } + ] + } + }, + "examples": [ + { + "due_dates": { + "enabled": true, + "start_date": false, + "remap_due_dates": true, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": true + }, + "time_estimates": { + "enabled": true + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": true + }, + "dependency_warning": { + "enabled": true + }, + "portfolios": { + "enabled": true + } + } + ] + } + }, + "examples": [ + { + "name": "Updated Space Name", + "color": "#7B68EE", + "private": false, + "admin_can_manage": false, + "multiple_assignees": false, + "features": { + "due_dates": { + "enabled": false, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": false + }, + "time_estimates": { + "enabled": false + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": false + }, + "dependency_warning": { + "enabled": false + }, + "portfolios": { + "enabled": false + } + } + } + ] + }, + "example": { + "name": "Updated Space Name", + "color": "#7B68EE", + "private": false, + "admin_can_manage": false, + "multiple_assignees": false, + "features": { + "due_dates": { + "enabled": false, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": false + }, + "time_estimates": { + "enabled": false + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": false + }, + "dependency_warning": { + "enabled": false + }, + "portfolios": { + "enabled": false + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "UpdateSpaceresponse", + "required": [ + "id", + "name", + "private", + "statuses", + "multiple_assignees", + "features" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "statuses": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "description": "" + }, + "multiple_assignees": { + "type": "boolean" + }, + "features": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features" + } + }, + "examples": [ + { + "id": "790", + "name": "Updated Space Name", + "private": false, + "statuses": [ + { + "status": "to do", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + }, + { + "status": "complete", + "type": "closed", + "orderindex": 1, + "color": "#6bc950" + } + ], + "multiple_assignees": false, + "features": { + "due_dates": { + "enabled": false, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": false + }, + "time_estimates": { + "enabled": false + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": false + }, + "dependency_warning": { + "enabled": false + }, + "portfolios": { + "enabled": false + } + } + } + ] + }, + "example": { + "id": "790", + "name": "Updated Space Name", + "private": false, + "statuses": [ + { + "status": "to do", + "type": "open", + "orderindex": 0, + "color": "#d3d3d3" + }, + { + "status": "complete", + "type": "closed", + "orderindex": 1, + "color": "#6bc950" + } + ], + "multiple_assignees": false, + "features": { + "due_dates": { + "enabled": false, + "start_date": false, + "remap_due_dates": false, + "remap_closed_due_date": false + }, + "time_tracking": { + "enabled": false + }, + "tags": { + "enabled": false + }, + "time_estimates": { + "enabled": false + }, + "checklists": { + "enabled": true + }, + "custom_fields": { + "enabled": true + }, + "remap_dependencies": { + "enabled": false + }, + "dependency_warning": { + "enabled": false + }, + "portfolios": { + "enabled": false + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 17, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Space", + "tags": [ + "Spaces" + ], + "description": "Delete a Space from your Workspace.", + "operationId": "DeleteSpace", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 790 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/space/{space_id}/tag": { + "parameters": [], + "get": { + "summary": "Get Space Tags", + "tags": [ + "Tags" + ], + "description": "View the task Tags available in a Space.", + "operationId": "GetSpaceTags", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 512 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetSpaceTagsresponse", + "required": [ + "tags" + ], + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items" + }, + "description": "" + } + }, + "examples": [ + { + "tags": [ + { + "name": "Tag name", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + ] + } + ] + }, + "example": { + "tags": [ + { + "name": "Tag name", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Space Tag", + "tags": [ + "Tags" + ], + "description": "Add a new task Tag to a Space.", + "operationId": "CreateSpaceTag", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 512 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateSpaceTagrequest", + "required": [ + "tag" + ], + "type": "object", + "properties": { + "tag": { + "title": "Tag", + "required": [ + "name", + "tag_fg", + "tag_bg" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "tag_fg": { + "type": "string" + }, + "tag_bg": { + "type": "string" + } + }, + "examples": [ + { + "name": "Tag Name", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + ] + } + }, + "examples": [ + { + "tag": { + "name": "Tag Name", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + } + ] + }, + "example": { + "tag": { + "name": "Tag Name", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 3, + "x-moar-complexity-skipped": false + } + }, + "/v2/space/{space_id}/tag/{tag_name}": { + "parameters": [], + "put": { + "summary": "Edit Space Tag", + "tags": [ + "Tags" + ], + "description": "Update a task Tag.", + "operationId": "EditSpaceTag", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 512 + ] + } + }, + { + "name": "tag_name", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "name" + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "EditSpaceTagrequest", + "required": [ + "tag" + ], + "type": "object", + "properties": { + "tag": { + "title": "Tag1", + "required": [ + "name", + "fg_color", + "bg_color" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "fg_color": { + "type": "string" + }, + "bg_color": { + "type": "string" + } + }, + "examples": [ + { + "name": "Updated Tag", + "fg_color": "#ffffff", + "bg_color": "#ffffff" + } + ] + } + }, + "examples": [ + { + "tag": { + "name": "Updated Tag", + "fg_color": "#ffffff", + "bg_color": "#ffffff" + } + } + ] + }, + "example": { + "tag": { + "name": "Tag name", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "EditSpaceTagresponse", + "required": [ + "tag" + ], + "type": "object", + "properties": { + "tag": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1tag~1%7Btag_name%7D/put/requestBody/content/application~1json/schema/properties/tag", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D~1tag~1%7Btag_name%7D/put/requestBody/content/application~1json/schema/properties/tag" + } + }, + "examples": [ + { + "tag": { + "name": "Updated Tag", + "fg_color": "#ffffff", + "bg_color": "#ffffff" + } + } + ] + }, + "example": { + "tag": { + "name": "Updated Tag", + "fg_color": "#ffffff", + "bg_color": "#ffffff" + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 3, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Space Tag", + "tags": [ + "Tags" + ], + "description": "Delete a task Tag from a Space.", + "operationId": "DeleteSpaceTag", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 512 + ] + } + }, + { + "name": "tag_name", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "name" + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "DeleteSpaceTagrequest", + "required": [ + "tag" + ], + "type": "object", + "properties": { + "tag": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag" + } + }, + "examples": [ + { + "tag": { + "name": "Tag name", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + } + ] + }, + "example": { + "tag": { + "name": "Tag name", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/tag/{tag_name}": { + "parameters": [], + "post": { + "summary": "Add Tag To Task", + "tags": [ + "Tags" + ], + "description": "Add a Tag to a task.", + "operationId": "AddTagToTask", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "abc" + ] + } + }, + { + "name": "tag_name", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "name" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Remove Tag From Task", + "tags": [ + "Tags" + ], + "description": "Remove a Tag from a task. This does not delete the Tag from the Space.", + "operationId": "RemoveTagFromTask", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "abc" + ] + } + }, + { + "name": "tag_name", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "name" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/list/{list_id}/task": { + "parameters": [], + "get": { + "summary": "Get Tasks", + "tags": [ + "Tasks" + ], + "description": "View the tasks in a List. Responses are limited to 100 tasks per page. You can only view task information of tasks you can access. \\\n \\\nThis endpoint only includes tasks where the specified `list_id` is their home List. Tasks added to the `list_id` with a different home List are not included in the response by default. To include tasks that exist in multiple lists, use the `include_timl` parameter. \\\n \\\nThe `time_spent` field displays time tracked in milliseconds, and is only included in the response for tasks with time entries.", + "operationId": "GetTasks", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "To find the list_id: \\ 1. In the Sidebar, hover over the List and click the **ellipsis ...** menu. \\ 2. Select **Copy link.** \\ 3. Use the copied URL to find the list_id. The list_id is the number that follows /li in the URL.", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "archived", + "in": "query", + "description": "", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + }, + { + "name": "include_markdown_description", + "in": "query", + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "page", + "in": "query", + "description": "Page to fetch (starts at 0).", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "order_by", + "in": "query", + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + }, + { + "name": "reverse", + "in": "query", + "description": "Tasks are displayed in reverse order.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "subtasks", + "in": "query", + "description": "Include or exclude subtasks. By default, subtasks are excluded.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "statuses", + "in": "query", + "description": "Filter by statuses. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "include_closed", + "in": "query", + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "include_timl", + "in": "query", + "description": "Include Tasks in Multiple Lists. By default, tasks that exist in multiple lists are excluded from the response.\\\n \\\nTo include tasks that exist in multiple lists, use `include_timl: true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "assignees", + "in": "query", + "description": "Filter by Assignees. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "watchers", + "in": "query", + "description": "Filter by watchers.", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "tags", + "in": "query", + "description": "Filter by tags. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "due_date_gt", + "in": "query", + "description": "Filter by due date greater than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "due_date_lt", + "in": "query", + "description": "Filter by due date less than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "date_created_gt", + "in": "query", + "description": "Filter by date created greater than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "date_created_lt", + "in": "query", + "description": "Filter by date created less than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "date_updated_gt", + "in": "query", + "description": "Filter by date updated greater than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "date_updated_lt", + "in": "query", + "description": "Filter by date updated less than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "date_done_gt", + "in": "query", + "description": "Filter by date done greater than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "date_done_lt", + "in": "query", + "description": "Filter by date done less than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "custom_fields", + "in": "query", + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "custom_field", + "in": "query", + "description": "Include tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship.", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "custom_items", + "in": "query", + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace.", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "number" + } + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "example": [ + { + "tasks": [ + { + "id": "9hx", + "name": "New Task Name", + "status": { + "status": "Open", + "color": "#d3d3d3", + "orderindex": 0, + "type": "open" + }, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "date_done": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "watchers": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": { + "color": "#f8ae00", + "id": "2", + "orderindex": "2", + "priority": "high" + }, + "due_date": null, + "start_date": null, + "time_estimate": null, + "time_spent": 7200000, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hx" + }, + { + "id": "9hz", + "name": "Second task", + "status": { + "status": "Open", + "color": "#d3d3d3", + "orderindex": 0, + "type": "open" + }, + "orderindex": "2.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "date_done": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "watchers": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": null, + "due_date": null, + "points": 3, + "time_estimate": null, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hz" + } + ] + } + ], + "title": "GetTasksresponse", + "type": "object", + "properties": { + "tasks": { + "type": "array", + "items": { + "title": "TaskWithMixedOrderIndexType", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "custom_item_id": { + "type": [ + "number", + "null" + ] + }, + "name": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "markdown_description": { + "type": "string" + }, + "orderindex": { + "type": [ + "string", + "number" + ] + }, + "date_created": { + "type": "string" + }, + "date_updated": { + "type": "string" + }, + "date_closed": { + "type": [ + "string", + "null" + ] + }, + "date_done": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator" + }, + "assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "watchers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "checklists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "parent": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority" + }, + "due_date": { + "type": [ + "string", + "null" + ] + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "points": { + "type": [ + "number" + ] + }, + "time_estimate": { + "type": [ + "string", + "null" + ] + }, + "time_spent": { + "type": [ + "string" + ] + }, + "custom_fields": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items" + }, + "list": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list" + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "url": { + "type": "string" + } + }, + "examples": [ + { + "id": "9hx", + "name": "New Task Name", + "custom_item_id": null, + "status": { + "status": "Open", + "color": "#d3d3d3", + "orderindex": 0, + "type": "open" + }, + "markdown_description": "Task description", + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "date_done": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "watchers": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": { + "color": "#f8ae00", + "id": "3", + "orderindex": "3", + "priority": "normal" + }, + "due_date": null, + "start_date": null, + "time_estimate": null, + "time_spent": 7200000, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hx" + } + ] + }, + "description": "" + }, + "last_page": { + "type": "boolean" + } + }, + "examples": [ + { + "tasks": [ + { + "id": "9hx", + "custom_item_id": null, + "name": "New Task Name", + "status": { + "status": "Open", + "color": "#d3d3d3", + "orderindex": 0, + "type": "open" + }, + "markdown_description": "Task description", + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "date_done": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "watchers": [], + "checklists": { + "id": "595495f8-4557-41b7-a527-f808664816a0", + "task_id": "86cv5pkvr", + "name": "Checklist on a task", + "date_created": "1714661812846", + "orderindex": "1", + "creator": 2770032, + "resolved": 0, + "unresolved": 2, + "items": [] + }, + "tags": [], + "parent": null, + "priority": { + "color": "#f8ae00", + "id": "2", + "orderindex": "2", + "priority": "high" + }, + "due_date": null, + "start_date": null, + "points": 3, + "time_estimate": null, + "time_spent": 7200000, + "custom_fields": { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "name": "My Text Custom field", + "type": "text", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": { + "value": "This is a string of text added to a Custom Field." + }, + "required": true + }, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hx" + }, + { + "id": "9hz", + "custom_item_id": null, + "name": "Second task", + "status": { + "status": "Open", + "color": "#d3d3d3", + "orderindex": 0, + "type": "open" + }, + "orderindex": "2.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "date_done": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "watchers": [], + "checklists": { + "id": "de159781-452c-4ef3-a3ac-0df4bf18aae2", + "name": "Checklist item 1", + "orderindex": 0, + "assignee": null, + "group_assignee": null, + "resolved": false, + "parent": null, + "date_created": "1714661817234", + "children": [] + }, + "tags": [], + "parent": null, + "priority": null, + "due_date": null, + "start_date": null, + "points": 3, + "time_estimate": null, + "custom_fields": { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "name": "My Text Custom field", + "type": "text", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": { + "value": "This is a string of text added to a Custom Field." + }, + "required": true + }, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hz" + } + ] + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Task", + "tags": [ + "Tasks" + ], + "description": "Create a new task.", + "operationId": "CreateTask", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateTaskrequest", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "assignees": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + }, + "archived": { + "type": "boolean" + }, + "group_assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Assign multiple user groups to the task." + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "status": { + "type": "string" + }, + "priority": { + "type": [ + "integer", + "null" + ], + "contentEncoding": "int32" + }, + "due_date": { + "type": "integer", + "contentEncoding": "int64" + }, + "due_date_time": { + "type": "boolean" + }, + "time_estimate": { + "type": "integer", + "contentEncoding": "int32" + }, + "start_date": { + "type": "integer", + "contentEncoding": "int64" + }, + "start_date_time": { + "type": "boolean" + }, + "points": { + "type": "number", + "description": "Add Sprint Points to the task." + }, + "notify_all": { + "type": "boolean", + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "parent": { + "description": "You can create a subtask by including an existing task ID.\\\n \\\nThe `parent` task ID you include can be a subtask, but must be in the same List specified in the path parameter.", + "type": [ + "string", + "null" + ] + }, + "markdown_content": { + "type": "string", + "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`." + }, + "links_to": { + "description": "Include a task ID to create a linked dependency with your new task.", + "type": [ + "string", + "null" + ] + }, + "check_required_custom_fields": { + "description": "When creating a task via API any required Custom Fields are ignored by default (`false`).\\\n \\\nYou can enforce required Custom Fields by including `check_required_custom_fields: true`.", + "type": "boolean" + }, + "custom_fields": { + "type": "array", + "items": { + "title": "SetCustomFieldValueOnCreateTaskrequest", + "anyOf": [ + { + "type": "object", + "title": "URL Custom Field", + "description": "The `value` must be a string with a valid URL.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "string", + "null" + ], + "example": "https://clickup.com/api" + } + } + }, + { + "type": "object", + "title": "Dropdown Custom Field", + "description": "Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "string", + "null" + ], + "example": "uuid1234" + } + } + }, + { + "type": "object", + "title": "Email Custom Field", + "description": "The `value` must be a string with a valid email address.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "string", + "null" + ], + "example": "user@company.com" + } + } + }, + { + "type": "object", + "title": "Phone Custom Field", + "description": "The `value` must be a string with a valid country code.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "string", + "null" + ], + "example": "+1 123 456 7890" + } + } + }, + { + "type": "object", + "title": "Date Custom Field", + "description": "The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "integer", + "null" + ], + "format": "int32", + "example": 1667367645000 + }, + "value_options": { + "type": "object", + "properties": { + "time": { + "type": "boolean", + "example": true + } + } + } + } + }, + { + "type": "object", + "title": "Short or Long Text Custom Field", + "description": "Enter a string of text.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "string", + "null" + ], + "example": "This is short or long text in a Custom Field." + } + } + }, + { + "type": "object", + "title": "Number Custom Field", + "description": "Enter a number.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "number", + "null" + ], + "example": -28 + } + } + }, + { + "type": "object", + "title": "Money Custom Field", + "description": "You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "number", + "null" + ], + "example": 8000 + } + } + }, + { + "type": "object", + "title": "Task Relationship Custom Field", + "description": "Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship. Task Relationship Custom Fields are nullable: `\"value\": null`.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "string" + } + }, + "rem": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "type": "object", + "title": "People Custom Field", + "description": "Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams) People Custom Fields are nullable: `\"value\": null`.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "number" + } + }, + "rem": { + "type": "array", + "items": { + "type": "number" + } + } + } + } + } + }, + { + "type": "object", + "title": "Emoji (Rating) Custom Field", + "description": "Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "integer", + "null" + ], + "format": "int32", + "example": 4 + } + } + }, + { + "type": "object", + "title": "Manual Progress Custom Field", + "description": "Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) Manual Progress Custom Fields are nullable: `\"value\": null`.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "object", + "required": [ + "current" + ], + "properties": { + "current": { + "type": "number", + "example": 20 + } + } + } + } + }, + { + "type": "object", + "title": "Label Custom Field", + "description": "Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) Label Custom Fields are nullable: `\"value\": null`.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "type": "string", + "example": [ + "uuid1234", + "uuid9876" + ] + } + } + } + }, + { + "type": "object", + "title": "Location Custom Field", + "description": "Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": "object", + "properties": { + "location": { + "type": "object", + "properties": { + "lat": { + "type": "number" + }, + "lng": { + "type": "number" + } + } + }, + "formatted_address": { + "type": "string" + } + } + } + } + }, + { + "type": "object", + "title": "Button Custom Field", + "description": "Set a button Custom Field to `true` to \"click\" it. This will trigger the button's action as if it was clicked in the UI.", + "required": [ + "id", + "value" + ], + "properties": { + "id": { + "type": "string" + }, + "value": { + "type": [ + "boolean", + "null" + ], + "example": true + } + } + } + ] + }, + "description": "You can include one or more Custom Fields to set them when creating a new task.\\\n \\\nCustom Fields that use object and array type values are nullable by sending `\"value\": null`." + }, + "custom_item_id": { + "type": "number", + "description": "The custom task type ID for this task. A value of `null` (default) creates a standard task type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + } + }, + "examples": [ + { + "name": "New Task Name", + "description": "New Task Description", + "assignees": [ + 183 + ], + "archived": false, + "group_assignees": [ + "dd01f92f-48ca-446d-88a1-0beb0e8f5f14" + ], + "tags": [ + "tag name 1" + ], + "status": "Open", + "priority": 3, + "due_date": 1508369194377, + "due_date_time": false, + "time_estimate": 8640000, + "start_date": 1567780450202, + "start_date_time": false, + "points": 3, + "notify_all": true, + "parent": null, + "links_to": null, + "check_required_custom_fields": true, + "custom_fields": [ + { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "value": 23 + }, + { + "id": "03efda77-c7a0-42d3-8afd-fd546353c2f5", + "value": "Text field input" + } + ] + } + ] + }, + "example": { + "name": "New Task Name", + "description": "New Task Description", + "markdown_description": "New Task Description", + "assignees": [ + 183 + ], + "archived": false, + "group_assignees": [ + "dd01f92f-48ca-446d-88a1-0beb0e8f5f14" + ], + "email_assignees": [ + "dd01f92f-48ca-446d-88a1-0beb0e8f5f13" + ], + "tags": [ + "tag name 1" + ], + "status": "Open", + "priority": 3, + "due_date": 1508369194377, + "due_date_time": false, + "time_estimate": 8640000, + "start_date": 1567780450202, + "start_date_time": false, + "points": 3, + "notify_all": true, + "parent": null, + "links_to": null, + "check_required_custom_fields": true, + "custom_fields": [ + { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "value": "This is a string of text added to a Custom Field." + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateTaskresponse.yaml", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "custom_id": { + "type": [ + "string", + "null" + ] + }, + "custom_item_id": { + "type": [ + "number", + "null" + ], + "description": "The custom task type ID for this task. A value of `null` (default) creates a standard task type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + }, + "name": { + "type": "string" + }, + "text_content": { + "type": "string" + }, + "description": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "orderindex": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "date_updated": { + "type": "string" + }, + "date_closed": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator" + }, + "assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "archived": { + "type": "boolean" + }, + "group_assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "email_assignees": { + "type": "string" + }, + "checklists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "parent": { + "type": [ + "string", + "null" + ] + }, + "priority": [ + { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority" + } + ], + "due_date": { + "type": [ + "string", + "null" + ] + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "points": { + "type": [ + "number" + ] + }, + "time_estimate": { + "type": [ + "string", + "null" + ] + }, + "time_spent": { + "type": [ + "string", + "null" + ] + }, + "custom_fields": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items" + }, + "description": "" + }, + "list": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list" + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "url": { + "type": "string" + } + } + }, + "example": { + "id": "9hx", + "custom_id": null, + "custom_item_id": null, + "name": "New Task Name", + "text_content": "New Task Content", + "description": "New Task Content", + "markdown_description": "New Task Content", + "status": { + "status": "in progress", + "color": "#d3d3d3", + "orderindex": 1, + "type": "custom" + }, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "date_done": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "archived": false, + "group_assignees": [], + "email_assignees": [], + "checklists": [], + "tags": [], + "parent": "abc1234", + "priority": { + "color": "6fddff", + "id": "3", + "orderindex": "3", + "priority": "normal" + }, + "due_date": null, + "start_date": null, + "points": 3, + "time_estimate": null, + "time_spent": null, + "custom_fields": [ + { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "name": "My Text Custom field", + "type": "text", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": { + "value": "This is a string of text added to a Custom Field." + }, + "required": true + } + ], + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hx" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 42, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}": { + "parameters": [], + "get": { + "summary": "Get Task", + "tags": [ + "Tasks" + ], + "description": "View information about a task. You can only view task information of tasks you can access. \\\n \\\nTasks with attachments will return an \"attachments\" response. \\\n \\\nDocs attached to a task are not returned.", + "operationId": "GetTask", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by its custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "include_subtasks", + "in": "query", + "description": "Include subtasks, default false", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "include_markdown_description", + "in": "query", + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "custom_fields", + "in": "query", + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:filtertasks)", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetTaskresponse", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "custom_id": { + "type": [ + "string", + "null" + ] + }, + "custom_item_id": { + "type": [ + "number", + "null" + ], + "description": "The custom task type ID for this task. A value of `null` represents task type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + }, + "name": { + "type": "string" + }, + "text_content": { + "type": "string" + }, + "description": { + "type": "string" + }, + "status": { + "title": "Status", + "required": [ + "status", + "color", + "orderindex", + "type" + ], + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "color": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "type": { + "type": "string" + } + }, + "examples": [ + { + "status": "in progress", + "color": "#d3d3d3", + "orderindex": 1, + "type": "custom" + } + ] + }, + "orderindex": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "date_updated": { + "type": "string" + }, + "date_closed": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "title": "Creator", + "required": [ + "id", + "username", + "color", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "color": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + } + ] + }, + "assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "watchers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "checklists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "parent": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "title": "Priority", + "type": [ + "object", + "null" + ], + "properties": { + "color": { + "type": "string" + }, + "id": { + "type": "string" + }, + "orderindex": { + "type": "string" + }, + "priority": { + "type": "string" + } + }, + "examples": [ + { + "color": "#f8ae00", + "id": "3", + "orderindex": "3", + "priority": "normal" + } + ] + }, + "due_date": { + "type": [ + "string", + "null" + ] + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "points": { + "type": [ + "number" + ] + }, + "time_estimate": { + "type": [ + "string", + "null" + ] + }, + "time_spent": { + "type": [ + "string", + "null" + ] + }, + "custom_fields": { + "type": "array", + "items": { + "title": "CustomFields8", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "type_config": { + "title": "TypeConfig1", + "type": "object", + "properties": { + "single_user": { + "type": "boolean" + }, + "include_groups": { + "type": "boolean" + }, + "include_guests": { + "type": "boolean" + }, + "include_team_members": { + "type": "boolean" + } + }, + "examples": [ + {} + ] + }, + "date_created": { + "type": "string" + }, + "hide_from_guests": { + "type": "boolean" + }, + "value": { + "oneOf": [ + { + "title": "Value", + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "profilePicture": { + "type": [ + "string", + "null" + ] + } + } + }, + { + "title": "Value1", + "required": [ + "id", + "username", + "email", + "color", + "initials", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "profilePicture": { + "type": [ + "string", + "null" + ] + } + }, + "examples": [ + { + "id": 183, + "username": "John Doe", + "email": "john@example.com", + "color": "#7b68ee", + "initials": "JD", + "profilePicture": null + } + ] + }, + { + "title": "Value2", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "string" + } + }, + "example": [ + "This is a text CF" + ] + } + ], + "examples": [ + { + "id": 183, + "username": "John Doe", + "email": "john@example.com", + "color": "#7b68ee", + "initials": "JD", + "profilePicture": null + }, + { + "value": null + } + ] + }, + "value_richtext": { + "type": "string" + }, + "value_markdown": { + "type": "string" + }, + "required": { + "type": "boolean" + } + } + }, + "description": "" + }, + "list": { + "title": "List", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "examples": [ + { + "id": "123" + } + ] + }, + "folder": { + "title": "Folder", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "examples": [ + { + "id": "456" + } + ] + }, + "space": { + "title": "Space", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "examples": [ + { + "id": "789" + } + ] + }, + "url": { + "type": "string" + }, + "markdown_description": { + "type": "string" + }, + "attachments": { + "type": "array", + "items": { + "title": "Attachment", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "date": { + "type": "bigint" + }, + "title": { + "type": "string" + }, + "type": { + "type": "int" + }, + "source": { + "type": "int" + }, + "version": { + "type": "int" + }, + "extension": { + "type": "string" + }, + "thumbnail_small": { + "type": "string" + }, + "thumbnail_medium": { + "type": "string" + }, + "thumbnail_large": { + "type": "string" + }, + "is_folder": { + "type": "boolean" + }, + "mimetype": { + "type": "string" + }, + "hidden": { + "type": "boolean" + }, + "parent_id": { + "type": "string" + }, + "size": { + "type": "bigint" + }, + "total_comments": { + "type": "int" + }, + "resolved_comments": { + "type": "int" + }, + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user" + }, + "deleted": { + "type": "boolean" + }, + "orientation": { + "type": "string" + }, + "url": { + "type": "string" + }, + "email_data": { + "type": "object" + }, + "url_w_query": { + "type": "string" + }, + "url_w_host": { + "type": "string" + } + }, + "examples": [ + { + "id": "62447c77-2086-4cda-b274-f53eccf0547b.csv", + "date": 1711570108374, + "title": "Canny - Exported posts - 2024-03-09.csv", + "type": 1, + "source": 1, + "version": 0, + "extension": "csv", + "thumbnail_small": null, + "thumbnail_medium": null, + "thumbnail_large": null, + "is_folder": null, + "mimetype": "text/csv", + "hidden": false, + "parent_id": "36fjfqy", + "size": 140970, + "total_comments": 0, + "resolved_comments": 0, + "user": [ + { + "id": [ + { + "type": "integer", + "contentEncoding": "int32" + } + ], + "username": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + } + ], + "deleted": false, + "orientation": null, + "url": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv", + "email_data": null, + "url_w_query": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv?view=open", + "url_w_host": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv" + } + ] + } + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "put": { + "summary": "Update Task", + "tags": [ + "Tasks" + ], + "description": "Update a task by including one or more fields in the request body.", + "operationId": "UpdateTask", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hx" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by its custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "***Note:** To update Custom Fields on a task, you must use the Set Custom Field endpoint.*", + "content": { + "application/json": { + "schema": { + "title": "UpdateTaskrequest", + "type": "object", + "properties": { + "custom_item_id": { + "type": [ + "number", + "null" + ], + "description": "The custom task type ID for this task. A value of `null` (default) sets the task type to type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + }, + "name": { + "type": "string" + }, + "description": { + "description": "To clear the task description, include `Description` with `\" \"`.", + "type": "string" + }, + "markdown_content": { + "type": "string", + "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`." + }, + "status": { + "type": "string" + }, + "priority": { + "type": "integer", + "contentEncoding": "int32" + }, + "due_date": { + "type": "integer", + "contentEncoding": "int64" + }, + "due_date_time": { + "type": "boolean" + }, + "parent": { + "description": "You can move a subtask to another parent task by including `\"parent\"` with a valid `task id`.\\\n \\\nYou cannot convert a subtask to a task by setting `\"parent\"` to `null`.", + "type": "string" + }, + "time_estimate": { + "type": "integer", + "contentEncoding": "int32" + }, + "start_date": { + "type": "integer", + "contentEncoding": "int64" + }, + "start_date_time": { + "type": "boolean" + }, + "points": { + "type": "number", + "description": "Update the task's Sprint Points." + }, + "assignees": { + "title": "Assignees", + "required": [ + "add", + "rem" + ], + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + }, + "rem": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + } + }, + "examples": [ + { + "add": [ + 182 + ], + "rem": [ + 183 + ] + } + ] + }, + "group_assignees": { + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + }, + "rem": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + } + } + }, + "watchers": { + "title": "Watchers", + "required": [ + "add", + "rem" + ], + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + }, + "rem": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + } + }, + "examples": [ + { + "add": [ + 182, + 121 + ], + "rem": [ + 183, + 122 + ] + } + ] + }, + "archived": { + "type": "boolean" + } + }, + "examples": [ + { + "name": "Updated Task Name", + "description": "Updated Task Content", + "status": "in progress", + "priority": 1, + "due_date": 1508369194377, + "due_date_time": false, + "parent": "abc1234", + "time_estimate": 8640000, + "start_date": 1567780450202, + "start_date_time": false, + "points": 3, + "assignees": { + "add": [ + 182 + ], + "rem": [ + 183 + ] + }, + "group_assignees": { + "add": [ + "dd01f92f-48ca-446d-88a1-0beb0e8f5f14" + ], + "rem": [ + "dd01f92f-48ca-446d-88a1-0beb0e8f5f13" + ] + }, + "watchers": { + "add": [ + 182 + ], + "rem": [ + 183 + ] + }, + "archived": false + } + ] + }, + "example": { + "name": "Updated Task Name", + "description": "Updated Task Content", + "status": "in progress", + "priority": 3, + "due_date": 1508369194377, + "due_date_time": false, + "parent": "abc1234", + "time_estimate": 8640000, + "start_date": 1567780450202, + "start_date_time": false, + "points": 3, + "assignees": { + "add": [ + 182 + ], + "rem": [ + 183 + ] + }, + "group_assignees": { + "add": [ + "dd01f92f-48ca-446d-88a1-0beb0e8f5f14" + ], + "rem": [ + "dd01f92f-48ca-446d-88a1-0beb0e8f5f13" + ] + }, + "archived": false + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "UpdateTaskresponse", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "custom_id": { + "type": [ + "string", + "null" + ] + }, + "custom_item_id": { + "type": [ + "number", + "null" + ] + }, + "name": { + "type": "string" + }, + "text_content": { + "type": "string" + }, + "description": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "archived": { + "type": "boolean" + }, + "orderindex": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "date_updated": { + "type": "string" + }, + "date_closed": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator" + }, + "assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "group_assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "checklists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "parent": { + "type": "string" + }, + "priority": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority" + }, + "due_date": { + "type": [ + "string", + "null" + ] + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "points": { + "type": [ + "number" + ] + }, + "time_estimate": { + "type": [ + "string", + "null" + ] + }, + "time_spent": { + "type": [ + "string", + "null" + ] + }, + "custom_fields": { + "type": "array", + "items": { + "title": "CustomFields7", + "required": [ + "id", + "name", + "type", + "type_config", + "date_created", + "hide_from_guests", + "required" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "type_config": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items/properties/type_config", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items/properties/type_config" + }, + "date_created": { + "type": "string" + }, + "hide_from_guests": { + "type": "boolean" + }, + "value": { + "type": "string" + }, + "required": { + "type": "boolean" + } + }, + "examples": [ + { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "name": "My Number field", + "type": "checkbox", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": "23", + "required": true + } + ] + }, + "description": "" + }, + "list": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list" + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "url": { + "type": "string" + } + }, + "examples": [ + { + "id": "9hx", + "custom_id": null, + "name": "Updated Task Name", + "text_content": "Updated Task Content", + "description": "Updated Task Content", + "status": { + "status": "in progress", + "color": "#d3d3d3", + "orderindex": 1, + "type": "custom" + }, + "archived": false, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "group_assignees": [], + "checklists": [], + "tags": [], + "parent": "abc1234", + "priority": { + "color": "#f8ae00", + "id": "3", + "orderindex": "3", + "priority": "normal" + }, + "due_date": null, + "start_date": null, + "points": 3, + "time_estimate": null, + "time_spent": null, + "custom_fields": [ + { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "name": "My Number field", + "type": "checkbox", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": "23", + "required": true + }, + { + "id": "03efda77-c7a0-42d3-8afd-fd546353c2f5", + "name": "My Text field", + "type": "short_text", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": "Text field input", + "required": false + }, + { + "id": "f4d2a20d-6759-4420-b853-222dbe2589d5", + "name": "My People", + "type": "users", + "type_config": { + "single_user": true, + "include_groups": true, + "include_guests": true, + "include_team_members": true + }, + "date_created": "1618440378816", + "hide_from_guests": false, + "required": false + } + ], + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hx" + } + ] + }, + "example": { + "id": "9hx", + "custom_id": null, + "custom_item_id": null, + "name": "Updated Task Name", + "text_content": "Updated Task Content", + "description": "Updated Task Content", + "markdown_description": "Updates Task Content", + "status": { + "status": "in progress", + "color": "#d3d3d3", + "orderindex": 1, + "type": "custom" + }, + "archived": false, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "group_assignees": [], + "checklists": [], + "tags": [], + "parent": "abc1234", + "priority": { + "color": "#f8ae00", + "id": "3", + "orderindex": "3", + "priority": "normal" + }, + "due_date": null, + "start_date": null, + "points": 3, + "time_estimate": null, + "time_spent": null, + "custom_fields": [ + { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "name": "My Number field", + "type": "checkbox", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": "23", + "required": true + }, + { + "id": "03efda77-c7a0-42d3-8afd-fd546353c2f5", + "name": "My Text field", + "type": "short_text", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": "Text field input", + "required": false + }, + { + "id": "f4d2a20d-6759-4420-b853-222dbe2589d5", + "name": "My People", + "type": "users", + "type_config": { + "single_user": true, + "include_groups": true, + "include_guests": true, + "include_team_members": true + }, + "date_created": "1618440378816", + "hide_from_guests": false, + "required": false + } + ], + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hx" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 19, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Task", + "tags": [ + "Tasks" + ], + "description": "Delete a task from your Workspace.", + "operationId": "DeleteTask", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9xh" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by its custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "204": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_Id}/task": { + "parameters": [], + "get": { + "summary": "Get Filtered Team Tasks", + "tags": [ + "Tasks" + ], + "description": "View the tasks that meet specific criteria from a Workspace. Responses are limited to 100 tasks per page. \\\n \\\nYou can only view task information of tasks you can access. \\\n \\\n Our Try It modal currently supports filtering by two or more Lists, Folders, or Spaces. To filter by a single List, Folder, or Space, we recommend using a free app like [Postman](https://www.postman.com/) to test our public API.", + "operationId": "GetFilteredTeamTasks", + "parameters": [ + { + "name": "team_Id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "page", + "in": "query", + "description": "Page to fetch (starts at 0).", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32" + } + }, + { + "name": "order_by", + "in": "query", + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + }, + { + "name": "reverse", + "in": "query", + "description": "Tasks are displayed in reverse order.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "subtasks", + "in": "query", + "description": "Include or exclude subtasks. By default, subtasks are excluded.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "space_ids[]", + "in": "query", + "description": "Filter by Spaces. For example: \\\n \\\n`?space_ids[]=1234&space_ids[]=6789`", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "project_ids[]", + "in": "query", + "description": "Filter by Folders. For example: \\\n \\\n`?project_ids[]=1234&project_ids[]=6789`", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "list_ids[]", + "in": "query", + "description": "Filter by Lists. For example: \\\n \\\n`?list_ids[]=1234&list_ids[]=6789` ", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "statuses[]", + "in": "query", + "description": "Filter by statuses. Use `%20` to represent a space character. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "include_closed", + "in": "query", + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "assignees[]", + "in": "query", + "description": "Filter by Assignees using people's ClickUp user id. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "tags[]", + "in": "query", + "description": "Filter by tags. User `%20` to represent a space character. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "due_date_gt", + "in": "query", + "description": "Filter by due date greater than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int64" + } + }, + { + "name": "due_date_lt", + "in": "query", + "description": "Filter by due date less than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int64" + } + }, + { + "name": "date_created_gt", + "in": "query", + "description": "Filter by date created greater than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int64" + } + }, + { + "name": "date_created_lt", + "in": "query", + "description": "Filter by date created less than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int64" + } + }, + { + "name": "date_updated_gt", + "in": "query", + "description": "Filter by date updated greater than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int64" + } + }, + { + "name": "date_updated_lt", + "in": "query", + "description": "Filter by date updated less than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int64" + } + }, + { + "name": "date_done_gt", + "in": "query", + "description": "Filter by date done greater than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int64" + } + }, + { + "name": "date_done_lt", + "in": "query", + "description": "Filter by date done less than Unix time in milliseconds.", + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int64" + } + }, + { + "name": "custom_fields", + "in": "query", + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"}{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. The `=` operator isn't supported with Label Custom Fields.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "parent", + "in": "query", + "description": "Include the parent task ID to return subtasks.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + }, + { + "name": "include_markdown_description", + "in": "query", + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "custom_items[]", + "in": "query", + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace.", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "number" + } + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetFilteredTeamTasksresponse", + "required": [ + "tasks" + ], + "type": "object", + "properties": { + "tasks": { + "type": "array", + "items": { + "title": "Task3", + "required": [ + "id", + "custom_id", + "name", + "text_content", + "description", + "status", + "orderindex", + "date_created", + "date_updated", + "date_closed", + "date_done", + "creator", + "assignees", + "watchers", + "checklists", + "tags", + "parent", + "priority", + "due_date", + "start_date", + "points", + "time_estimate", + "custom_fields", + "dependencies", + "linked_tasks", + "team_id", + "url", + "permission_level", + "list", + "project", + "folder", + "space" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "custom_id": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "text_content": { + "type": "string" + }, + "description": { + "type": "string" + }, + "markdown_description": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "orderindex": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "date_updated": { + "type": "string" + }, + "date_closed": { + "type": "string" + }, + "date_done": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "title": "Creator5", + "required": [ + "id", + "username", + "color", + "email", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "color": { + "type": "string" + }, + "email": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + } + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "Assignees1", + "required": [ + "id", + "username", + "color", + "email", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "color": { + "type": "string" + }, + "email": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + } + ] + }, + "description": "" + }, + "watchers": { + "type": "array", + "items": { + "title": "Watchers1", + "required": [ + "id", + "username", + "color", + "email", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "color": { + "type": "string" + }, + "email": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + } + ] + }, + "description": "" + }, + "checklists": { + "type": "array", + "items": { + "title": "Checklists6", + "required": [ + "id", + "task_id", + "name", + "date_created", + "orderindex", + "creator", + "resolved", + "unresolved", + "items" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "task_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + }, + "creator": { + "type": "integer", + "contentEncoding": "int32" + }, + "resolved": { + "type": "integer", + "contentEncoding": "int32" + }, + "unresolved": { + "type": "integer", + "contentEncoding": "int32" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1checklist~1%7Bchecklist_id%7D~1checklist_item~1%7Bchecklist_item_id%7D/put/responses/200/content/application~1json/schema/properties/checklist/properties/items/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1checklist~1%7Bchecklist_id%7D~1checklist_item~1%7Bchecklist_item_id%7D/put/responses/200/content/application~1json/schema/properties/checklist/properties/items/items" + }, + "description": "" + } + }, + "examples": [ + { + "id": "d41340bc-2f17-43cc-ae71-86628f45825f", + "task_id": "3cxv9f", + "name": "Checklist", + "date_created": "1618455803730", + "orderindex": 1, + "creator": 2770032, + "resolved": 0, + "unresolved": 1, + "items": [ + { + "id": "9398cb3d-55a4-4c45-ab46-2a47a371e375", + "name": "checklist item 1", + "orderindex": 0, + "assignee": null, + "resolved": false, + "parent": null, + "date_created": "1618455810454", + "children": [] + } + ] + } + ] + }, + "description": "" + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items" + }, + "description": "" + }, + "parent": { + "type": "string" + }, + "priority": { + "type": "integer", + "contentEncoding": "int32" + }, + "due_date": { + "type": "string" + }, + "start_date": { + "type": "string" + }, + "points": { + "type": "number" + }, + "time_estimate": { + "type": "number" + }, + "custom_fields": { + "type": "array", + "items": { + "title": "CustomFields9", + "required": [ + "id", + "name", + "type", + "type_config", + "date_created", + "hide_from_guests", + "required" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "type_config": { + "type": "object" + }, + "date_created": { + "type": "string" + }, + "hide_from_guests": { + "type": "boolean" + }, + "required": { + "type": "boolean" + } + }, + "examples": [ + { + "id": "be43f58e-989e-4233-9f25-27584f094b74", + "name": "Location type Custom Field", + "type": "location", + "type_config": {}, + "date_created": "1617765143523", + "hide_from_guests": false, + "required": false + } + ] + }, + "description": "" + }, + "dependencies": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "linked_tasks": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "team_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "permission_level": { + "type": "string" + }, + "list": { + "title": "List2", + "required": [ + "id", + "name", + "access" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "access": { + "type": "boolean" + } + }, + "examples": [ + { + "id": "1752", + "name": "Shared with me", + "access": false + } + ] + }, + "project": { + "title": "Project", + "required": [ + "id", + "name", + "hidden", + "access" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "hidden": { + "type": "boolean" + }, + "access": { + "type": "boolean" + } + }, + "examples": [ + { + "id": "1", + "name": "Folder", + "hidden": false, + "access": true + } + ] + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space" + } + }, + "examples": [ + { + "id": "av1", + "custom_id": null, + "name": "My First Task", + "text_content": "Task description", + "description": "Task description", + "markdown_description": "Task description", + "status": { + "status": "Open", + "type": "open", + "orderindex": 1, + "color": "#000000" + }, + "orderindex": "1.0000", + "date_created": "1508369194377", + "date_updated": "1508369194377", + "date_closed": "1508369194377", + "creator": { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + }, + "assignees": [ + { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + } + ], + "watchers": [ + { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + } + ], + "checklists": [ + { + "id": "d41340bc-2f17-43cc-ae71-86628f45825f", + "task_id": "3cxv9f", + "name": "Checklist", + "date_created": "1618455803730", + "orderindex": 1, + "creator": 2770032, + "resolved": 0, + "unresolved": 1, + "items": [ + { + "id": "9398cb3d-55a4-4c45-ab46-2a47a371e375", + "name": "checklist item 1", + "orderindex": 0, + "assignee": null, + "resolved": false, + "parent": null, + "date_created": "1618455810454", + "children": [] + } + ] + } + ], + "tags": [ + { + "name": "tagged", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + ], + "parent": "av2", + "priority": 1, + "due_date": "1508369194377", + "start_date": "1508369194377", + "points": 3, + "time_estimate": 1.2, + "custom_fields": [ + { + "id": "be43f58e-989e-4233-9f25-27584f094b74", + "name": "Location type Custom Field", + "type": "location", + "type_config": {}, + "date_created": "1617765143523", + "hide_from_guests": false, + "required": false + } + ], + "dependencies": [], + "linked_tasks": [], + "team_id": "1234", + "url": "https://app.clickup.com/t/av1", + "permission_level": "create", + "list": { + "id": "1", + "name": "List", + "access": true + }, + "project": { + "id": "1", + "name": "Folder", + "hidden": false, + "access": true + }, + "folder": { + "id": "1", + "name": "Folder", + "hidden": false, + "access": true + }, + "space": { + "id": "1" + } + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "tasks": [ + { + "id": "av1", + "custom_id": null, + "name": "My First Task", + "text_content": "Task description", + "description": "Task description", + "markdown_description": "Task description", + "status": { + "status": "Open", + "type": "open", + "orderindex": 1, + "color": "#000000" + }, + "orderindex": "1.0000", + "date_created": "1508369194377", + "date_updated": "1508369194377", + "date_closed": "1508369194377", + "date_done": "1508369194377", + "creator": { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + }, + "assignees": [ + { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + } + ], + "watchers": [ + { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + } + ], + "checklists": [ + { + "id": "d41340bc-2f17-43cc-ae71-86628f45825f", + "task_id": "3cxv9f", + "name": "Checklist", + "date_created": "1618455803730", + "orderindex": 1, + "creator": 2770032, + "resolved": 0, + "unresolved": 1, + "items": [ + { + "id": "9398cb3d-55a4-4c45-ab46-2a47a371e375", + "name": "checklist item 1", + "orderindex": 0, + "assignee": null, + "resolved": false, + "parent": null, + "date_created": "1618455810454", + "children": [] + } + ] + } + ], + "tags": [ + { + "name": "tagged", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + ], + "parent": "av2", + "priority": 1, + "due_date": "1508369194377", + "start_date": "1508369194377", + "points": 3, + "time_estimate": 1.2, + "custom_fields": [ + { + "id": "be43f58e-989e-4233-9f25-27584f094b74", + "name": "Location type Custom Field", + "type": "location", + "type_config": {}, + "date_created": "1617765143523", + "hide_from_guests": false, + "required": false + } + ], + "dependencies": [], + "linked_tasks": [], + "team_id": "1234", + "url": "https://app.clickup.com/t/av1", + "permission_level": "create", + "list": { + "id": "1", + "name": "List", + "access": true + }, + "project": { + "id": "1", + "name": "Folder", + "hidden": false, + "access": true + }, + "folder": { + "id": "1", + "name": "Folder", + "hidden": false, + "access": true + }, + "space": { + "id": "1" + } + } + ] + } + ] + }, + "example": { + "tasks": [ + { + "id": "av1", + "custom_id": null, + "name": "My First Task", + "text_content": "Task description", + "description": "Task description", + "markdown_description": "Task description", + "status": { + "status": "Open", + "type": "open", + "orderindex": 1, + "color": "#000000" + }, + "orderindex": "1.0000", + "date_created": "1508369194377", + "date_updated": "1508369194377", + "date_closed": "1508369194377", + "date_done": "1508369194377", + "creator": { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + }, + "assignees": [ + { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + } + ], + "watchers": [ + { + "id": 123, + "username": "John Doe", + "color": "#000000", + "email": "johndoe@website.com", + "profilePicture": "https://clickup.com/avatar.jpg" + } + ], + "checklists": [ + { + "id": "d41340bc-2f17-43cc-ae71-86628f45825f", + "task_id": "3cxv9f", + "name": "Checklist", + "date_created": "1618455803730", + "orderindex": 1, + "creator": 2770032, + "resolved": 0, + "unresolved": 1, + "items": [ + { + "id": "9398cb3d-55a4-4c45-ab46-2a47a371e375", + "name": "checklist item 1", + "orderindex": 0, + "assignee": null, + "resolved": false, + "parent": null, + "date_created": "1618455810454", + "children": [] + } + ] + } + ], + "tags": [ + { + "name": "tagged", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + ], + "parent": "av2", + "priority": 1, + "due_date": "1508369194377", + "start_date": "1508369194377", + "points": 3, + "time_estimate": 1.2, + "custom_fields": [ + { + "id": "be43f58e-989e-4233-9f25-27584f094b74", + "name": "Location type Custom Field", + "type": "location", + "type_config": {}, + "date_created": "1617765143523", + "hide_from_guests": false, + "required": false + } + ], + "dependencies": [], + "linked_tasks": [], + "team_id": "1234", + "url": "https://app.clickup.com/t/av1", + "permission_level": "create", + "list": { + "id": "1", + "name": "List", + "access": true + }, + "project": { + "id": "1", + "name": "Folder", + "hidden": false, + "access": true + }, + "folder": { + "id": "1", + "name": "Folder", + "hidden": false, + "access": true + }, + "space": { + "id": "1" + } + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/merge": { + "post": { + "summary": "Merge Tasks", + "description": "Merge multiple tasks into a target task. The target task is specified by the task_id parameter, while the source tasks to be merged are provided in the request body. Custom Task IDs are not supported.", + "tags": [ + "Tasks" + ], + "operationId": "mergeTasks", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "ID of the target task that other tasks will be merged into.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "source_task_ids" + ], + "properties": { + "source_task_ids": { + "type": "array", + "description": "Array of task IDs to merge into the target task.", + "items": { + "type": "string" + }, + "examples": [ + [ + "abc123", + "def456" + ] + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Tasks merged successfully" + }, + "400": { + "description": "Bad request - invalid task IDs or other validation errors" + }, + "403": { + "description": "Unauthorized to merge these tasks" + }, + "404": { + "description": "One or more tasks not found" + } + }, + "x-moar-primitive-count": 1, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/time_in_status": { + "parameters": [], + "get": { + "summary": "Get Task's Time in Status", + "tags": [ + "Tasks" + ], + "description": "View how long a task has been in each status. The Total time in Status ClickApp must first be enabled by the Workspace owner or an admin.", + "operationId": "GetTask'sTimeinStatus", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetTasksTimeinStatusresponse", + "required": [ + "current_status", + "status_history" + ], + "type": "object", + "properties": { + "current_status": { + "title": "CurrentStatus", + "required": [ + "status", + "color", + "total_time" + ], + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "color": { + "type": "string" + }, + "total_time": { + "title": "TotalTime", + "required": [ + "by_minute", + "since" + ], + "type": "object", + "properties": { + "by_minute": { + "type": "integer", + "contentEncoding": "int32" + }, + "since": { + "type": "string" + } + }, + "examples": [ + { + "by_minute": 21708, + "since": "1604004423494" + } + ] + } + }, + "examples": [ + { + "status": "open", + "color": "#d3d3d3", + "total_time": { + "by_minute": 21708, + "since": "1604004423494" + } + } + ] + }, + "status_history": { + "type": "array", + "items": { + "title": "StatusHistory", + "required": [ + "status", + "color", + "type", + "total_time", + "orderindex" + ], + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "color": { + "type": "string" + }, + "type": { + "type": "string" + }, + "total_time": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/current_status/properties/total_time", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/current_status/properties/total_time" + }, + "orderindex": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "status": "open", + "color": "#d3d3d3", + "type": "open", + "total_time": { + "by_minute": 21707, + "since": "1604004423494" + }, + "orderindex": 0 + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "current_status": { + "status": "open", + "color": "#d3d3d3", + "total_time": { + "by_minute": 21708, + "since": "1604004423494" + } + }, + "status_history": [ + { + "status": "open", + "color": "#d3d3d3", + "type": "open", + "total_time": { + "by_minute": 21707, + "since": "1604004423494" + }, + "orderindex": 0 + }, + { + "status": "active status", + "color": "#5CF1D4", + "type": "custom", + "total_time": { + "by_minute": 23274, + "since": "1602607941692" + }, + "orderindex": 4 + } + ] + } + ] + }, + "example": { + "current_status": { + "status": "open", + "color": "#d3d3d3", + "total_time": { + "by_minute": 21708, + "since": "1604004423494" + } + }, + "status_history": [ + { + "status": "open", + "color": "#d3d3d3", + "type": "open", + "total_time": { + "by_minute": 21707, + "since": "1604004423494" + }, + "orderindex": 0 + }, + { + "status": "active status", + "color": "#5CF1D4", + "type": "custom", + "total_time": { + "by_minute": 23274, + "since": "1602607941692" + }, + "orderindex": 4 + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/bulk_time_in_status/task_ids": { + "parameters": [], + "get": { + "summary": "Get Bulk Tasks' Time in Status", + "tags": [ + "Tasks" + ], + "description": "View how long two or more tasks have been in each status. The Total time in Status ClickApp must first be enabled by the Workspace owner or an admin.", + "operationId": "GetBulkTasks'TimeinStatus", + "parameters": [ + { + "name": "task_ids", + "in": "query", + "description": "Include this paramater once per `task_id`.\nYou can include up to 100 task ids per request.\nFor example: `task_ids=3cuh&task_ids=g4fs`", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetBulkTasksTimeinStatusresponse", + "required": [ + "27075wz", + "20bbn28" + ], + "type": "object", + "properties": { + "27075wz": { + "title": "27075wz", + "required": [ + "current_status", + "status_history" + ], + "type": "object", + "properties": { + "current_status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/current_status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/current_status" + }, + "status_history": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/status_history/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/status_history/items" + }, + "description": "" + } + }, + "examples": [ + { + "current_status": { + "status": "open", + "color": "#d3d3d3", + "total_time": { + "by_minute": 21830, + "since": "1604004423496" + } + }, + "status_history": [ + { + "status": "open", + "color": "#d3d3d3", + "type": "open", + "total_time": { + "by_minute": 21829, + "since": "1604004423494" + }, + "orderindex": 0 + }, + { + "status": "active status #2", + "color": "#5CF1D4", + "type": "custom", + "total_time": { + "by_minute": 23274, + "since": "1602607941692" + }, + "orderindex": 4 + } + ] + } + ] + }, + "20bbn28": { + "title": "20bbn28", + "required": [ + "current_status", + "status_history" + ], + "type": "object", + "properties": { + "current_status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/current_status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/current_status" + }, + "status_history": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/status_history/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/status_history/items" + }, + "description": "" + } + }, + "examples": [ + { + "current_status": { + "status": "open", + "color": "#d3d3d3", + "total_time": { + "by_minute": 21830, + "since": "1604004420924" + } + }, + "status_history": [ + { + "status": "open", + "color": "#d3d3d3", + "type": "open", + "total_time": { + "by_minute": 22276, + "since": "1604004420925" + }, + "orderindex": 0 + }, + { + "status": "active status #2", + "color": "#5CF1D4", + "type": "custom", + "total_time": { + "by_minute": 40109, + "since": "1601597828835" + }, + "orderindex": 4 + } + ] + } + ] + } + }, + "examples": [ + { + "27075wz": { + "current_status": { + "status": "open", + "color": "#d3d3d3", + "total_time": { + "by_minute": 21830, + "since": "1604004423494" + } + }, + "status_history": [ + { + "status": "open", + "color": "#d3d3d3", + "type": "open", + "total_time": { + "by_minute": 21829, + "since": "1604004423494" + }, + "orderindex": 0 + }, + { + "status": "active status #2", + "color": "#5CF1D4", + "type": "custom", + "total_time": { + "by_minute": 23274, + "since": "1602607941692" + }, + "orderindex": 4 + } + ] + }, + "20bbn28": { + "current_status": { + "status": "open", + "color": "#d3d3d3", + "total_time": { + "by_minute": 21830, + "since": "1604004420925" + } + }, + "status_history": [ + { + "status": "open", + "color": "#d3d3d3", + "type": "open", + "total_time": { + "by_minute": 22276, + "since": "1604004420925" + }, + "orderindex": 0 + }, + { + "status": "active status #2", + "color": "#5CF1D4", + "type": "custom", + "total_time": { + "by_minute": 40109, + "since": "1601597828835" + }, + "orderindex": 4 + } + ] + } + } + ] + }, + "example": { + "27075wz": { + "current_status": { + "status": "open", + "color": "#d3d3d3", + "total_time": { + "by_minute": 21830, + "since": "1604004423494" + } + }, + "status_history": [ + { + "status": "open", + "color": "#d3d3d3", + "type": "open", + "total_time": { + "by_minute": 21829, + "since": "1604004423494" + }, + "orderindex": 0 + }, + { + "status": "active status #2", + "color": "#5CF1D4", + "type": "custom", + "total_time": { + "by_minute": 23274, + "since": "1602607941692" + }, + "orderindex": 4 + } + ] + }, + "20bbn28": { + "current_status": { + "status": "open", + "color": "#d3d3d3", + "total_time": { + "by_minute": 21830, + "since": "1604004420925" + } + }, + "status_history": [ + { + "status": "open", + "color": "#d3d3d3", + "type": "open", + "total_time": { + "by_minute": 22276, + "since": "1604004420925" + }, + "orderindex": 0 + }, + { + "status": "active status #2", + "color": "#5CF1D4", + "type": "custom", + "total_time": { + "by_minute": 40109, + "since": "1601597828835" + }, + "orderindex": 4 + } + ] + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/taskTemplate": { + "parameters": [], + "get": { + "summary": "Get Task Templates", + "tags": [ + "Templates" + ], + "description": "View the task templates available in a Workspace.", + "operationId": "GetTaskTemplates", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "page", + "in": "query", + "description": "", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32", + "examples": [ + 0 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetTaskTemplatesresponse", + "required": [ + "templates" + ], + "type": "object", + "properties": { + "templates": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + } + }, + "examples": [ + { + "templates": [] + } + ] + }, + "example": { + "templates": [] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/list/{list_id}/taskTemplate/{template_id}": { + "parameters": [], + "post": { + "summary": "Create Task From Template", + "description": "Create a new task using a task template defined in your workspace. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\n", + "operationId": "CreateTaskFromTemplate", + "tags": [ + "Tasks" + ], + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 512 + ] + } + }, + { + "name": "template_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hz" + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateTaskFromTemplaterequest", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "examples": [ + { + "name": "New task name" + } + ] + }, + "example": { + "name": "New task name" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "contentMediaType": "application/json" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 1, + "x-moar-complexity-skipped": false + } + }, + "/v2/folder/{folder_id}/list_template/{template_id}": { + "post": { + "summary": "Create List From Template in Folder", + "tags": [ + "Lists" + ], + "description": "Create a new list using a list template in a Folder. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\nThis request runs synchronously by default with `return_immediately=true`.\nThe request returns the future List ID immediatly, but the List may not be created when the response is sent.\nSmall templates can be applied synchronously, which guarantees that all sub objects are created.\nIn case of a timeout on synchronous requests, the objects from the template will continue to be created past the timeout.\n", + "operationId": "CreateFolderListFromTemplate", + "parameters": [ + { + "in": "path", + "name": "folder_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "ID of the Folder where the List will be created" + }, + { + "in": "path", + "name": "template_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "ID of the template to use" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the new List" + }, + "options": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "List created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/responses/200/content/application~1json/schema", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/responses/200/content/application~1json/schema" + } + } + } + }, + "400": { + "description": "Bad request - Name is required", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "Name is required" + }, + "ECODE": { + "type": "string", + "example": "OAUTH_117" + } + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Template, folder, or space not found" + }, + "500": { + "description": "Internal server error" + } + }, + "x-moar-primitive-count": 1, + "x-moar-complexity-skipped": false + } + }, + "/v2/space/{space_id}/list_template/{template_id}": { + "post": { + "summary": "Create List From Template in Space.", + "tags": [ + "Lists" + ], + "description": "Create a new List using a List template within a Space. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\nThis request can be run asynchronously or synchronously via the `return_immediately` parameter.\n", + "operationId": "CreateSpaceListFromTemplate", + "parameters": [ + { + "in": "path", + "name": "space_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "ID of the Space where the List will be created" + }, + { + "in": "path", + "name": "template_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "ID of the template to use" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the new List" + }, + "options": { + "type": "object", + "description": "Options for creating the List", + "properties": { + "return_immediately": { + "type": "boolean", + "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n", + "default": true + }, + "content": { + "type": "string", + "description": "List description" + }, + "time_estimate": { + "type": "number", + "description": "Include time (hours, minutes and seconds)" + }, + "automation": { + "type": "boolean", + "description": "Import automation settings" + }, + "include_views": { + "type": "boolean", + "description": "Import views" + }, + "old_due_date": { + "type": "boolean", + "description": "Import tasks' due dates" + }, + "old_start_date": { + "type": "boolean", + "description": "Import tasks' start dates" + }, + "old_followers": { + "type": "boolean", + "description": "Import tasks' watchers" + }, + "comment_attachments": { + "type": "boolean", + "description": "Import tasks' comment attachments" + }, + "recur_settings": { + "type": "boolean", + "description": "Import tasks' recurring settings" + }, + "old_tags": { + "type": "boolean", + "description": "Import tasks' tags" + }, + "old_statuses": { + "type": "boolean", + "description": "Import tasks' status settings" + }, + "subtasks": { + "type": "boolean", + "description": "Import tasks' subtasks" + }, + "custom_type": { + "type": "boolean", + "description": "Import tasks' task types" + }, + "old_assignees": { + "type": "boolean", + "description": "Import tasks' assignees" + }, + "attachments": { + "type": "boolean", + "description": "Import tasks' attachments" + }, + "comment": { + "type": "boolean", + "description": "Import tasks' comments" + }, + "old_status": { + "type": "boolean", + "description": "Import tasks' current statuses" + }, + "external_dependencies": { + "type": "boolean", + "description": "Import tasks' external dependencies" + }, + "internal_dependencies": { + "type": "boolean", + "description": "Import tasks' internal dependencies" + }, + "priority": { + "type": "boolean", + "description": "Import tasks' priorities" + }, + "custom_fields": { + "type": "boolean", + "description": "Import tasks' Custom Fields" + }, + "old_checklists": { + "type": "boolean", + "description": "Import tasks' checklists" + }, + "relationships": { + "type": "boolean", + "description": "Import tasks' relationships" + }, + "old_subtask_assignees": { + "type": "boolean", + "description": "Import tasks' subtask assignees" + }, + "start_date": { + "type": "string", + "format": "date-time", + "description": "Project start date for remapping dates" + }, + "due_date": { + "type": "string", + "format": "date-time", + "description": "Project due date for remapping dates" + }, + "remap_start_date": { + "type": "boolean", + "description": "Remap start dates" + }, + "skip_weekends": { + "type": "boolean", + "description": "Skip weekends when remapping dates" + }, + "archived": { + "type": "integer", + "enum": [ + 1, + 2, + null + ], + "description": "Include archived tasks" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "List created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Response object returned when a new List is created from a template in a Folder or Space.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the newly created List", + "example": "901107394085" + }, + "list": { + "type": "object", + "description": "Detailed information about the created List", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the List (matches parent id)", + "example": "901107394085" + }, + "name": { + "type": "string", + "description": "Display name of the List", + "example": "API Folder in Space" + }, + "deleted": { + "type": "boolean", + "description": "Indicates if the List has been marked as deleted", + "example": true + }, + "orderindex": { + "type": "integer", + "description": "Position of the List relative to other Lists in the same container", + "example": 0 + }, + "priority": { + "type": "string", + "description": "Priority level of the List, if applicable", + "nullable": true, + "example": null + }, + "assignee": { + "type": "string", + "description": "Default assignee for the List, if applicable", + "nullable": true, + "example": null + }, + "due_date": { + "type": "string", + "format": "date-time", + "description": "Default due date for tasks in the List", + "nullable": true, + "example": null + }, + "start_date": { + "type": "string", + "format": "date-time", + "description": "Default start date for tasks in the List", + "nullable": true, + "example": null + }, + "folder": { + "type": "object", + "description": "Information about the parent Folder containing this List, if applicable", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the parent Folder", + "example": "90114317916" + }, + "name": { + "type": "string", + "description": "Display name of the parent Folder", + "example": "hidden" + }, + "hidden": { + "type": "boolean", + "description": "Indicates if the Folder is hidden from standard views", + "example": true + }, + "access": { + "type": "boolean", + "description": "Indicates if the current user has access to this Folder", + "example": true + } + } + }, + "space": { + "type": "object", + "description": "Information about the Workspace Space containing this List", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the Space", + "example": "90112667046" + }, + "name": { + "type": "string", + "description": "Display name of the Space", + "example": "API Test Space" + }, + "access": { + "type": "boolean", + "description": "Indicates if the current user has access to this Space", + "example": true + } + } + }, + "inbound_address": { + "type": "string", + "description": "Email address that can be used to create tasks in this List via email", + "example": "abc-list@tasks.clickup.com" + }, + "archived": { + "type": "boolean", + "description": "Indicates if the List is archived", + "example": false + }, + "override_statuses": { + "type": "boolean", + "description": "Indicates if this List uses custom statuses instead of Space default statuses", + "example": true + }, + "statuses": { + "type": "array", + "description": "List of available statuses for tasks in this List", + "items": { + "type": "object", + "description": "Status configuration object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the status", + "example": "sc901107394085_DCnaeiSB" + }, + "status": { + "type": "string", + "description": "Display name of the status", + "example": "to do" + }, + "orderindex": { + "type": "integer", + "description": "Position of this status in the status list", + "example": 0 + }, + "color": { + "type": "string", + "description": "Color code associated with this status", + "example": "#87909e" + }, + "type": { + "type": "string", + "description": "Category of the status (e.g., open, closed, in progress)", + "example": "open" + }, + "status_group": { + "type": "string", + "description": "TODO - Identifier for grouping related statuses", + "example": "subcat_901107394085" + } + } + } + }, + "permission_level": { + "type": "string", + "description": "Access level the current user has for this List (e.g., create, edit, view)", + "example": "create" + } + } + } + } + } + } + } + }, + "400": { + "description": "Bad request - Name is required, or is already taken", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "Name is required" + }, + "ECODE": { + "type": "string", + "example": "OAUTH_117" + } + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Template, folder, or space not found" + }, + "500": { + "description": "Internal server error" + } + }, + "x-moar-primitive-count": 31, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/seats": { + "parameters": [], + "get": { + "summary": "Get Workspace seats", + "tags": [ + "Workspaces" + ], + "description": "View the used, total, and available member and guest seats for a Workspace.", + "operationId": "GetWorkspaceseats", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetWorkspaceseatsresponse", + "required": [ + "members", + "guests" + ], + "type": "object", + "properties": { + "members": { + "title": "Members", + "required": [ + "filled_members_seats", + "total_member_seats", + "empty_member_seats" + ], + "type": "object", + "properties": { + "filled_members_seats": { + "type": "integer", + "contentEncoding": "int32" + }, + "total_member_seats": { + "type": "integer", + "contentEncoding": "int32" + }, + "empty_member_seats": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "filled_members_seats": 9, + "total_member_seats": 9, + "empty_member_seats": 0 + } + ] + }, + "guests": { + "title": "Guests", + "required": [ + "filled_guest_seats", + "total_guest_seats", + "empty_guest_seats" + ], + "type": "object", + "properties": { + "filled_guest_seats": { + "type": "integer", + "contentEncoding": "int32" + }, + "total_guest_seats": { + "oneOf": [ + { + "type": "integer", + "contentEncoding": "int32" + }, + { + "type": "string", + "enum": [ + "Infinity" + ] + } + ] + }, + "empty_guest_seats": { + "oneOf": [ + { + "type": "integer", + "contentEncoding": "int32" + }, + { + "type": "string", + "enum": [ + "Infinity" + ] + } + ] + } + }, + "examples": [ + { + "filled_guest_seats": 2, + "total_guest_seats": 50, + "empty_guest_seats": 48 + }, + { + "filled_guest_seats": 2, + "total_guest_seats": "Infinity", + "empty_guest_seats": "Infinity" + } + ] + } + }, + "examples": [ + { + "members": { + "filled_members_seats": 9, + "total_member_seats": 9, + "empty_member_seats": 0 + }, + "guests": { + "filled_guest_seats": 2, + "total_guest_seats": 50, + "empty_guest_seats": 48 + } + }, + { + "members": { + "filled_members_seats": 9, + "total_member_seats": 9, + "empty_member_seats": 0 + }, + "guests": { + "filled_guest_seats": 2, + "total_guest_seats": "Infinity", + "empty_guest_seats": "Infinity" + } + } + ] + }, + "example": { + "members": { + "filled_members_seats": 9, + "total_member_seats": 9, + "empty_member_seats": 0 + }, + "guests": { + "filled_guest_seats": 2, + "total_guest_seats": 50, + "empty_guest_seats": 48 + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/plan": { + "parameters": [], + "get": { + "summary": "Get Workspace Plan", + "tags": [ + "Workspaces" + ], + "description": "View the current [Plan](https://clickup.com/pricing) for the specified Workspace.", + "operationId": "GetWorkspaceplan", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetWorkspaceplanresponse", + "type": "object", + "properties": { + "plan_name": { + "type": "string" + }, + "plan_id": { + "type": "integer" + } + }, + "examples": [ + { + "plan_name": "Enterprise", + "plan_id": 4 + } + ] + }, + "example": { + "plan_name": "Enterprise", + "plan_id": 4 + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/group": { + "parameters": [], + "post": { + "summary": "Create Group", + "tags": [ + "User Groups" + ], + "description": "This endpoint creates a [User Group](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) within a Workspace.\\\n \\\nUser Groups are used to organize and manage users within a Workspace.\\\n \\\nIn the API documentation, `team_id` refers to the Workspace ID, and `group_id` refers to the User Group ID.\\\n \\\n**Note:** Adding a guest with view-only permissions to a Team automatically converts them to a paid guest.\\\n \\\nIf no paid guest seats are available, an additional member seat will be added, increasing the number of paid guest seats.\\\n \\\nThis change incurs a prorated charge based on the billing cycle.", + "operationId": "CreateUserGroup", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateTeamrequest", + "required": [ + "name", + "members" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "handle": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + } + }, + "examples": [ + { + "name": "New team name", + "handle": "newteamname", + "members": [ + 123456, + 987654 + ] + } + ] + }, + "example": { + "name": "New User Group name", + "handle": "newusergroupname", + "members": [ + 123456, + 987654 + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateTeamresponse", + "required": [ + "id", + "team_id", + "userid", + "name", + "handle", + "date_created", + "initials", + "members", + "avatar" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "team_id": { + "type": "string" + }, + "userid": { + "type": "integer", + "contentEncoding": "int32" + }, + "name": { + "type": "string" + }, + "handle": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "title": "Members1", + "required": [ + "id", + "username", + "email", + "color", + "initials", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 185, + "username": "Sam", + "email": "sam@example.com", + "color": "#4169E1", + "initials": "S", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + } + ] + }, + "description": "" + }, + "avatar": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1group~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/properties/avatar", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1group~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/properties/avatar" + } + }, + "examples": [ + { + "id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d", + "team_id": "301540", + "userid": 301828, + "name": "User group", + "handle": "usergroup", + "date_created": "1640122639829", + "initials": "U", + "members": [ + { + "id": 185, + "username": "Sam", + "email": "sam@example.com", + "color": "#4169E1", + "initials": "S", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + { + "id": 186, + "username": "Alex", + "email": "alex@example.com", + "color": "#4169E1", + "initials": "A", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + } + ], + "avatar": { + "attachment_id": null, + "color": null, + "source": null, + "icon": null + } + } + ] + }, + "example": { + "id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d", + "team_id": "301540", + "userid": 301828, + "name": "User group", + "handle": "usergroup", + "date_created": "1640122639829", + "initials": "U", + "members": [ + { + "id": 185, + "username": "Sam", + "email": "sam@example.com", + "color": "#4169E1", + "initials": "S", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + { + "id": 186, + "username": "Alex", + "email": "alex@example.com", + "color": "#4169E1", + "initials": "A", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + } + ], + "avatar": { + "attachment_id": null, + "color": null, + "source": null, + "icon": null + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 3, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/custom_item": { + "get": { + "summary": "Get Custom Task Types", + "tags": [ + "Custom Task Types" + ], + "description": "View the custom task types available in a Workspace.", + "operationId": "GetCustomItems", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetCustomItemsResponse", + "type": "object", + "properties": { + "custom_items": { + "type": "array", + "items": { + "title": "Custom Item", + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32", + "description": "Custom task type ID." + }, + "name": { + "type": "string", + "description": "Custom task type name." + }, + "name_plural": { + "type": "string", + "description": "Custom task type plural name." + }, + "description": { + "type": "string", + "description": "Custom task type description." + } + }, + "examples": [ + { + "id": 1300, + "name": "Bug", + "name_plural": "Bugs", + "description": "Custom task type for bugs." + } + ] + }, + "description": "Array of custom task types." + } + }, + "examples": [ + { + "custom_items": [ + { + "id": "1300-900e-462d-a849-4a216b06d930", + "name": "Bug", + "name_plural": "Bugs", + "description": "Custom item type for bugs." + } + ] + } + ] + }, + "example": [ + { + "custom_items": [ + { + "id": 1300, + "name": "Bug", + "name_plural": "Bugs", + "description": "Custom item type for bugs." + } + ] + } + ] + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/group/{group_id}": { + "parameters": [], + "put": { + "summary": "Update Group", + "tags": [ + "User Groups" + ], + "description": "This endpoint is used to manage [User Groups](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups), which are groups of users within your Workspace.\\\n \\\nIn our API, `team_id` in the path refers to the Workspace ID, and `group_id` refers to the ID of a User Group.\\\n \\\n**Note:** Adding a guest with view-only permissions to a User Group automatically converts them to a paid guest.\\\n \\\nIf you don't have any paid guest seats available, a new member seat is automatically added to increase the number of paid guest seats.\\\n \\\nThis incurs a prorated charge based on your billing cycle.", + "operationId": "UpdateTeam", + "parameters": [ + { + "name": "group_id", + "in": "path", + "description": "User Group ID", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "C9C58BE9" + ] + } + } + ], + "requestBody": { + "description": "The group handle can be updated, which is used to @mention a User Group within the Workspace.\\\n \\\nModify Group members by using the \"add\" and \"rem\" parameters with an array of user IDs to include or exclude members.", + "content": { + "application/json": { + "schema": { + "title": "UpdateTeamrequest", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "handle": { + "type": "string" + }, + "members": { + "title": "Members2", + "required": [ + "add", + "rem" + ], + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + }, + "rem": { + "type": "array", + "items": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": "" + } + }, + "examples": [ + { + "add": [ + 123456, + 987654 + ], + "rem": [ + 159753 + ] + } + ] + } + }, + "examples": [ + { + "name": "New User Group Name", + "handle": "newusergroupname", + "members": { + "add": [ + 123456, + 987654 + ], + "rem": [ + 159753 + ] + } + } + ] + }, + "example": { + "name": "New User Group Name", + "handle": "newusergroupname", + "members": { + "add": [ + 123456, + 987654 + ], + "rem": [ + 159753 + ] + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "UpdateTeamresponse", + "required": [ + "id", + "team_id", + "userid", + "name", + "handle", + "date_created", + "initials", + "members", + "avatar" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "team_id": { + "type": "string" + }, + "userid": { + "type": "integer", + "contentEncoding": "int32" + }, + "name": { + "type": "string" + }, + "handle": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "title": "Members3", + "required": [ + "id", + "username", + "email", + "color", + "initials", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "profilePicture": { + "type": [ + "string", + "null" + ] + } + }, + "examples": [ + { + "id": 201, + "username": "Jim Halpert", + "email": "jim@example.com", + "color": "#40BC86", + "initials": "JH", + "profilePicture": null + } + ] + }, + "description": "" + }, + "avatar": { + "title": "Avatar", + "required": [ + "attachment_id", + "color", + "source", + "icon" + ], + "type": "object", + "properties": { + "attachment_id": { + "type": [ + "string", + "null" + ] + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "source": { + "type": [ + "string", + "null" + ] + }, + "icon": { + "type": [ + "string", + "null" + ] + } + }, + "examples": [ + { + "attachment_id": null, + "color": null, + "source": null, + "icon": null + } + ] + } + }, + "examples": [ + { + "id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d", + "team_id": "123456", + "userid": 301828, + "name": "New User Group Name", + "handle": "newusergroupname", + "date_created": "1640122639829", + "initials": "NN", + "members": [ + { + "id": 201, + "username": "Jim Halpert", + "email": "jim@example.com", + "color": "#40BC86", + "initials": "JH", + "profilePicture": null + }, + { + "id": 202, + "username": "Dwight Shrute", + "email": "dwight@example.com", + "color": "#FF8600", + "initials": "DS", + "profilePicture": null + } + ], + "avatar": { + "attachment_id": null, + "color": null, + "source": null, + "icon": null + } + } + ] + }, + "example": { + "id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d", + "team_id": "123456", + "userid": 301828, + "name": "New User Group Name", + "handle": "newusergroupname", + "date_created": "1640122639829", + "initials": "NN", + "members": [ + { + "id": 201, + "username": "Jim Halpert", + "email": "jim@example.com", + "color": "#40BC86", + "initials": "JH", + "profilePicture": null + }, + { + "id": 202, + "username": "Dwight Shrute", + "email": "dwight@example.com", + "color": "#FF8600", + "initials": "DS", + "profilePicture": null + } + ], + "avatar": { + "attachment_id": null, + "color": null, + "source": null, + "icon": null + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 4, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Group", + "tags": [ + "User Groups" + ], + "description": "This endpoint is used to remove a [User Group](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) from your Workspace.\\\n \\\nIn our API documentation, `team_id` refers to the id of a Workspace, and `group_id` refers to the id of a user group.", + "operationId": "DeleteTeam", + "parameters": [ + { + "name": "group_id", + "in": "path", + "description": "User Group ID", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "C9C58BE9" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/group": { + "parameters": [], + "get": { + "summary": "Get Groups", + "tags": [ + "User Groups" + ], + "description": "This endpoint is used to view [User Groups](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) in your Workspace.\\\n \\\nIn our API documentation, `team_id` refers to the ID of a Workspace, and `group_id` refers to the ID of a User Group.", + "operationId": "GetTeams1", + "parameters": [ + { + "name": "team_id", + "in": "query", + "description": "Workspace ID", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "group_ids", + "in": "query", + "description": "Enter one or more User Group IDs to retrieve information about specific User Group.", + "style": "form", + "explode": true, + "schema": { + "type": "string", + "examples": [ + "C9C58BE9-7C73-4002-A6A9-310014852858" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetTeamsresponse", + "required": [ + "groups" + ], + "type": "object", + "properties": { + "groups": { + "type": "array", + "items": { + "title": "Group", + "required": [ + "id", + "team_id", + "userid", + "name", + "handle", + "date_created", + "initials", + "members", + "avatar" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "team_id": { + "type": "string" + }, + "userid": { + "type": "integer", + "contentEncoding": "int32" + }, + "name": { + "type": "string" + }, + "handle": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1group~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/properties/members/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1group~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/properties/members/items" + }, + "description": "" + }, + "avatar": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1group~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/properties/avatar", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1group~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/properties/avatar" + } + }, + "examples": [ + { + "id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d", + "team_id": "123456", + "userid": 301123, + "name": "product team", + "handle": "product", + "date_created": "1640122639829", + "initials": "PT", + "members": [ + { + "id": 183, + "username": "Jerry", + "email": "jerry@example.com", + "color": "#40BC86", + "initials": "J", + "profilePicture": null + }, + { + "id": 184, + "username": "Sam", + "email": "sam@example.com", + "color": "#FF8600", + "initials": "S", + "profilePicture": null + } + ], + "avatar": { + "attachment_id": null, + "color": null, + "source": null, + "icon": null + } + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "groups": [ + { + "id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d", + "team_id": "123456", + "userid": 301123, + "name": "product team", + "handle": "product", + "date_created": "1640122639829", + "initials": "PT", + "members": [ + { + "id": 183, + "username": "Jerry", + "email": "jerry@example.com", + "color": "#40BC86", + "initials": "J", + "profilePicture": null + }, + { + "id": 184, + "username": "Sam", + "email": "sam@example.com", + "color": "#FF8600", + "initials": "S", + "profilePicture": null + } + ], + "avatar": { + "attachment_id": null, + "color": null, + "source": null, + "icon": null + } + }, + { + "id": "fd31be63-41f2-4320-9043-9786fdf643d6", + "team_id": "301540", + "userid": 301828, + "name": "HR department", + "handle": "hr-dept", + "date_created": "1627087990293", + "initials": "HD", + "members": [ + { + "id": 183, + "username": "Jerry", + "email": "jerry@example.com", + "color": "#40BC86", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + } + ], + "avatar": { + "attachment_id": null, + "color": null, + "source": null, + "icon": null + } + } + ] + } + ] + }, + "example": { + "groups": [ + { + "id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d", + "team_id": "123456", + "userid": 301123, + "name": "product managers", + "handle": "product", + "date_created": "1640122639829", + "initials": "PT", + "members": [ + { + "id": 183, + "username": "Jerry", + "email": "jerry@example.com", + "color": "#40BC86", + "initials": "J", + "profilePicture": null + }, + { + "id": 184, + "username": "Sam", + "email": "sam@example.com", + "color": "#FF8600", + "initials": "S", + "profilePicture": null + } + ], + "avatar": { + "attachment_id": null, + "color": null, + "source": null, + "icon": null + } + }, + { + "id": "fd31be63-41f2-4320-9043-9786fdf643d6", + "team_id": "301540", + "userid": 301828, + "name": "HR department", + "handle": "hr-dept", + "date_created": "1627087990293", + "initials": "HD", + "members": [ + { + "id": 183, + "username": "Jerry", + "email": "jerry@example.com", + "color": "#40BC86", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + } + ], + "avatar": { + "attachment_id": null, + "color": null, + "source": null, + "icon": null + } + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/time": { + "parameters": [], + "get": { + "summary": "Get tracked time", + "tags": [ + "Time Tracking (Legacy)" + ], + "description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*", + "operationId": "Gettrackedtime", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "Gettrackedtimeresponse", + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "title": "Datum", + "required": [ + "user", + "time", + "intervals" + ], + "type": "object", + "properties": { + "user": { + "title": "User13", + "required": [ + "id", + "username", + "email", + "color", + "initials", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "profilePicture": { + "type": [ + "string", + "null" + ] + } + }, + "examples": [ + { + "id": 1, + "username": "John Doe", + "email": "johndoe@gmail.com", + "color": "#795548", + "initials": "JD", + "profilePicture": null + } + ] + }, + "time": { + "type": "integer", + "contentEncoding": "int32" + }, + "intervals": { + "type": "array", + "items": { + "title": "Interval", + "required": [ + "id", + "start", + "end", + "time", + "source", + "date_added" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "start": { + "type": [ + "string", + "null" + ] + }, + "end": { + "type": [ + "string", + "null" + ] + }, + "time": { + "type": "string" + }, + "source": { + "type": "string" + }, + "date_added": { + "type": "string" + } + }, + "examples": [ + { + "id": "318", + "start": null, + "end": null, + "time": "1000000", + "source": "chrome", + "date_added": "1569983937761" + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "user": { + "id": 1, + "username": "John Doe", + "email": "johndoe@gmail.com", + "color": "#795548", + "initials": "JD", + "profilePicture": null + }, + "time": 1000000, + "intervals": [ + { + "id": "318", + "start": null, + "end": null, + "time": "1000000", + "source": "chrome", + "date_added": "1569983937761" + } + ] + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "data": [ + { + "user": { + "id": 1, + "username": "John Doe", + "email": "johndoe@gmail.com", + "color": "#795548", + "initials": "JD", + "profilePicture": null + }, + "time": 1000000, + "intervals": [ + { + "id": "318", + "start": null, + "end": null, + "time": "1000000", + "source": "chrome", + "date_added": "1569983937761" + } + ] + } + ] + } + ] + }, + "example": { + "data": [ + { + "user": { + "id": 1, + "username": "John Doe", + "email": "johndoe@gmail.com", + "color": "#795548", + "initials": "JD", + "profilePicture": null + }, + "time": 1000000, + "intervals": [ + { + "id": "318", + "start": null, + "end": null, + "time": "1000000", + "source": "chrome", + "date_added": "1569983937761" + } + ] + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Track time", + "tags": [ + "Time Tracking (Legacy)" + ], + "description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*", + "operationId": "Tracktime", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "Include the total time or the start time and end time.\\\n \\\nThe total time is in milliseconds and `\"start\"` and `\"end\"` values are Unix time in milliseconds.", + "content": { + "application/json": { + "schema": { + "title": "Tracktimerequest", + "required": [ + "start", + "end", + "time" + ], + "type": "object", + "properties": { + "start": { + "type": "integer", + "contentEncoding": "int64" + }, + "end": { + "type": "integer", + "contentEncoding": "int64" + }, + "time": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "start": 1567780450202, + "end": 1508369194377, + "time": 8640000 + } + ] + }, + "example": { + "start": 1567780450202, + "end": 1508369194377, + "time": 8640000 + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "Tracktimeresponse", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "examples": [ + { + "id": "123" + } + ] + }, + "example": { + "id": "123" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 3, + "x-moar-complexity-skipped": false + } + }, + "/v2/task/{task_id}/time/{interval_id}": { + "parameters": [], + "put": { + "summary": "Edit time tracked", + "tags": [ + "Time Tracking (Legacy)" + ], + "description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*", + "operationId": "Edittimetracked", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + }, + { + "name": "interval_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "123" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "Edit the start, end, or total time of a time tracked entry.", + "content": { + "application/json": { + "schema": { + "title": "Edittimetrackedrequest", + "required": [ + "start", + "end", + "time" + ], + "type": "object", + "properties": { + "start": { + "type": "integer", + "contentEncoding": "int64" + }, + "end": { + "type": "integer", + "contentEncoding": "int64" + }, + "time": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "start": 1567780450202, + "end": 1508369194377, + "time": 8640000 + } + ] + }, + "example": { + "start": 1567780450202, + "end": 1508369194377, + "time": 8640000 + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 3, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete time tracked", + "tags": [ + "Time Tracking (Legacy)" + ], + "description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*", + "operationId": "Deletetimetracked", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "9hv" + ] + } + }, + { + "name": "interval_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "123" + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_Id}/time_entries": { + "parameters": [], + "get": { + "summary": "Get time entries within a date range", + "tags": [ + "Time Tracking" + ], + "description": "View time entries filtered by start and end date. \\\n \\\nBy default, this endpoint returns time entries from the last 30 days created by the authenticated user. \\\n \\\nTo retrieve time entries for other users, you must include the `assignee` query parameter. \\\n \\\nOnly one of the following location filters can be included at a time: `space_id`, `folder_id`, `list_id`, or `task_id`. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*", + "operationId": "Gettimeentrieswithinadaterange", + "parameters": [ + { + "name": "team_Id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "start_date", + "in": "query", + "description": "Unix time in milliseconds", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double" + } + }, + { + "name": "end_date", + "in": "query", + "description": "Unix time in milliseconds", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double" + } + }, + { + "name": "assignee", + "in": "query", + "description": "Filter by `user_id`. For multiple assignees, separate `user_id` using commas.\\\n \\\n **Example:** `assignee=1234,9876`\\\n \\\n***Note:** Only Workspace Owners/Admins have access to do this.*", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double" + } + }, + { + "name": "include_task_tags", + "in": "query", + "description": "Include task tags in the response for time entries associated with tasks.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "include_location_names", + "in": "query", + "description": "Include the names of the List, Folder, and Space along with the `list_id`,`folder_id`, and `space_id`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "include_approval_history", + "in": "query", + "description": "Include the history of the approval for each time entry. Adds status changes, notes, and approvers.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "include_approval_details", + "in": "query", + "description": "Include the details of the approval for each time entry. Adds Approver ID, Approved Time, List of Approvers, and Approval Status.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "space_id", + "in": "query", + "description": "Only include time entries associated with tasks in a specific Space.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double" + } + }, + { + "name": "folder_id", + "in": "query", + "description": "Only include time entries associated with tasks in a specific Folder.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double" + } + }, + { + "name": "list_id", + "in": "query", + "description": "Only include time entries associated with tasks in a specific List.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double" + } + }, + { + "name": "task_id", + "in": "query", + "description": "Only include time entries associated with a specific task.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "is_billable", + "in": "query", + "description": "Include only billable time entries by using a value of `true` or only non-billable time entries by using a value of `false`.\\\n \\\nFor example: `?is_billable=true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "If your time entry is associated with a task that uses custom task ids you can expect a `custom_id`` field in the body of the response. The task field will only be included if there is a task associated with a time entry.", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "Gettimeentrieswithinadaterangeresponse", + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "title": "Datum1", + "required": [ + "id", + "task", + "wid", + "user", + "billable", + "start", + "end", + "duration", + "description", + "tags", + "source", + "at", + "task_location", + "task_tags", + "task_url" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "task": { + "title": "Task4", + "required": [ + "id", + "custom_id", + "name", + "status", + "custom_type" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "custom_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "custom_type": { + "type": [ + "string", + "null" + ] + } + }, + "examples": [ + { + "id": "1vwwavv", + "custom_id": "JOSH-917", + "name": "woof", + "status": { + "status": "open yes", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + } + ] + }, + "wid": { + "type": "string" + }, + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user" + }, + "billable": { + "type": "boolean" + }, + "start": { + "type": "string" + }, + "end": { + "type": "string" + }, + "duration": { + "type": "string" + }, + "description": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "source": { + "type": "string" + }, + "at": { + "type": "string" + }, + "approval_id": { + "type": "string", + "description": "ID of the associated approval" + }, + "approval": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval" + }, + "task_location": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1%7Btimer_id%7D/get/responses/200/content/application~1json/schema/properties/data/properties/task_location", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1%7Btimer_id%7D/get/responses/200/content/application~1json/schema/properties/data/properties/task_location" + }, + "task_tags": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1%7Btimer_id%7D/get/responses/200/content/application~1json/schema/properties/data/properties/task_tags/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1%7Btimer_id%7D/get/responses/200/content/application~1json/schema/properties/data/properties/task_tags/items" + }, + "description": "" + }, + "task_url": { + "type": "string" + } + }, + "examples": [ + { + "id": "1963465985517105840", + "task": { + "id": "1vwwavv", + "custom_id": "JOSH-917", + "name": "woof", + "status": { + "status": "open yes", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + }, + "wid": "300702", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1592841559129", + "end": "1592845899021", + "duration": "4339892", + "description": "", + "tags": [], + "source": "clickup", + "at": "1592845899021", + "approval_id": "2d539936-119a-4927-9770-179f0a72e2e5", + "approval": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval" + }, + "task_location": { + "list_id": 1560300071, + "folder_id": 468300080, + "space_id": 22800253, + "list_name": "List", + "folder_name": "Folder", + "space_name": "Space" + }, + "task_tags": [ + { + "name": "content-request", + "tag_fg": "#800000", + "tag_bg": "#2ecd6f", + "creator": 301828 + }, + { + "name": "marketing-okr", + "tag_fg": "#800000", + "tag_bg": "#7C4DFF", + "creator": 301828 + } + ], + "task_url": "https://staging.clickup.com/t/1vwwavv" + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "data": [ + { + "id": "1963465985517105840", + "task": { + "id": "1vwwavv", + "custom_id": "JOSH-917", + "name": "woof", + "status": { + "status": "open yes", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + }, + "wid": "300702", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": 1592841559129, + "end": 1592845899021, + "duration": "4339892", + "description": "", + "tags": [], + "source": "clickup", + "at": "1592845899021", + "approval_id": "2d539936-119a-4927-9770-179f0a72e2e5", + "approval": { + "title": "Approval", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the approval" + }, + "workspace_id": { + "type": "integer", + "description": "ID of the workspace this approval belongs to" + }, + "status": { + "type": "string", + "description": "Current status of the approval (e.g., 'approved', 'pending')" + }, + "data": { + "type": "object", + "properties": { + "end_of_week": { + "type": "integer", + "description": "Timestamp for the end of the week" + }, + "start_of_week": { + "type": "integer", + "description": "Timestamp for the start of the week" + } + } + }, + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1time/get/responses/200/content/application~1json/schema/properties/data/items/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1time/get/responses/200/content/application~1json/schema/properties/data/items/properties/user" + }, + "approvers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the user who can approve the request" + } + } + } + }, + "approver_id": { + "type": "integer", + "description": "ID of the user who approved the request" + }, + "approved_at": { + "type": "integer", + "description": "Timestamp when the approval was granted" + }, + "history": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the history entry" + }, + "field": { + "type": "string", + "description": "Field that was changed" + }, + "before": { + "type": "string", + "description": "Previous value" + }, + "after": { + "type": "string", + "description": "New value" + }, + "created_at": { + "type": "integer", + "description": "Timestamp when the change was made" + }, + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1time/get/responses/200/content/application~1json/schema/properties/data/items/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1time/get/responses/200/content/application~1json/schema/properties/data/items/properties/user" + } + } + } + } + }, + "examples": [ + { + "id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": 12345, + "status": "approved", + "data": { + "end_of_week": 1672531199000, + "start_of_week": 1671926400000 + }, + "user": { + "id": 101, + "username": "john.smith", + "initials": "JS", + "avatar": { + "color": "#4287f5", + "picture_url": null + } + }, + "approvers": [ + { + "id": 101 + }, + { + "id": 102 + } + ], + "approver_id": 101, + "approved_at": 1672012800000, + "history": [ + { + "id": "987fcdeb-51a2-3456-789a-bcdef0123456", + "field": "submission", + "before": null, + "after": null, + "created_at": 1671987600000, + "user": { + "id": 101, + "username": "john.smith", + "role": "submitter" + } + }, + { + "id": "456abcde-f123-4567-89ab-cdef01234567", + "field": "status", + "before": "pending", + "after": "approved", + "created_at": 1672012800000, + "user": { + "id": 102, + "username": "jane.doe", + "role": "approver" + } + } + ] + } + ] + }, + "task_location": { + "list_id": 1560300071, + "folder_id": 468300080, + "space_id": 22800253, + "list_name": "List", + "folder_name": "Folder", + "space_name": "Space" + }, + "task_tags": [ + { + "name": "content-request", + "tag_fg": "#800000", + "tag_bg": "#2ecd6f", + "creator": 301828 + }, + { + "name": "marketing-okr", + "tag_fg": "#800000", + "tag_bg": "#7C4DFF", + "creator": 301828 + } + ], + "task_url": "https://staging.clickup.com/t/1vwwavv" + } + ] + } + ] + }, + "example": { + "data": [ + { + "id": "1963465985517105840", + "task": { + "id": "1vwwavv", + "custom_id": "JOSH-917", + "name": "woof", + "status": { + "status": "open yes", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + }, + "wid": "300702", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": 1592841559129, + "end": 1592845899021, + "duration": "4339892", + "description": "", + "tags": [], + "source": "clickup", + "at": "1592845899021", + "task_location": { + "list_id": 1560300071, + "folder_id": 468300080, + "space_id": 22800253, + "list_name": "List", + "folder_name": "Folder", + "space_name": "Space" + }, + "task_tags": [ + { + "name": "content-request", + "tag_fg": "#800000", + "tag_bg": "#2ecd6f", + "creator": 301828 + }, + { + "name": "marketing-okr", + "tag_fg": "#800000", + "tag_bg": "#7C4DFF", + "creator": 301828 + } + ], + "task_url": "https://staging.clickup.com/t/1vwwavv" + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create a time entry", + "tags": [ + "Time Tracking" + ], + "description": "Create a time entry. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*", + "operationId": "Createatimeentry", + "parameters": [ + { + "name": "team_Id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "Associate a time entry with a task using the `tid` parameter.", + "content": { + "application/json": { + "schema": { + "title": "Createatimeentryrequest", + "required": [ + "start", + "duration" + ], + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "tags": { + "description": "Users on the Business Plan and above can include a time tracking label.", + "type": "array", + "items": { + "title": "Tags6", + "required": [ + "name", + "tag_fg", + "tag_bg" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "tag_fg": { + "type": "string" + }, + "tag_bg": { + "type": "string" + } + }, + "examples": [ + { + "name": "Tag name", + "tag_fg": "#000000", + "tag_bg": "#000000" + } + ] + } + }, + "start": { + "type": "integer", + "contentEncoding": "int64" + }, + "stop": { + "type": "integer", + "contentEncoding": "int64", + "description": "The `duration` parameter can be used instead of the `stop` parameter. " + }, + "end": { + "type": "integer", + "contentEncoding": "int64" + }, + "billable": { + "type": "boolean" + }, + "duration": { + "description": "When there are values for both `start` and `end`, `duration` is ignored. The `stop` parameter can be used instead of the `duration` parameter.", + "type": "integer", + "contentEncoding": "int32" + }, + "assignee": { + "description": "Workspace owners and admins can include any user id. Workspace members can only include their own user id.", + "type": "integer", + "contentEncoding": "int32" + }, + "tid": { + "type": "string" + } + }, + "examples": [ + { + "description": "from api", + "tags": [ + { + "name": "name of tag", + "tag_bg": "#BF55EC", + "tag_fg": "#FFFFFF" + } + ], + "start": 1595282645000, + "end": 1595282660000, + "billable": true, + "duration": 50000, + "assignee": 1, + "tid": "task_id" + } + ] + }, + "example": { + "description": "from api", + "tags": [ + { + "name": "name of tag", + "tag_bg": "#BF55EC", + "tag_fg": "#FFFFFF" + } + ], + "start": 1595282645000, + "billable": true, + "duration": 50000, + "assignee": 1, + "tid": "task_id" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "Createatimeentryresponse", + "required": [ + "description", + "tags", + "start", + "billable", + "duration", + "assignee", + "tid" + ], + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items" + }, + "description": "" + }, + "start": { + "type": "integer", + "contentEncoding": "int64" + }, + "billable": { + "type": "boolean" + }, + "duration": { + "type": "integer", + "contentEncoding": "int32" + }, + "assignee": { + "type": "integer", + "contentEncoding": "int32" + }, + "tid": { + "type": "string" + } + }, + "examples": [ + { + "description": "from api", + "tags": [ + { + "name": "name of tag", + "tag_bg": "#BF55EC", + "tag_fg": "#BF55EC" + } + ], + "start": 1595282645000, + "billable": true, + "duration": 50000, + "assignee": 1, + "tid": "task_id" + } + ] + }, + "example": { + "description": "from api", + "tags": [ + { + "name": "name of tag", + "tag_bg": "#BF55EC", + "tag_fg": "#BF55EC" + } + ], + "start": 1595282645000, + "billable": true, + "duration": 50000, + "assignee": 1, + "tid": "task_id" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 11, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/time_entries/{timer_id}": { + "parameters": [], + "get": { + "summary": "Get singular time entry", + "tags": [ + "Time Tracking" + ], + "description": "View a single time entry. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*", + "operationId": "Getsingulartimeentry", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "timer_id", + "in": "path", + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "1963465985517105840" + ] + } + }, + { + "name": "include_task_tags", + "in": "query", + "description": "Include task tags in the response for time entries associated with tasks.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "include_location_names", + "in": "query", + "description": "Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "include_approval_history", + "in": "query", + "description": "Include the history of the approval for the time entry.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "include_approval_details", + "in": "query", + "description": "Include the details of the approval for the time entry.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "Getsingulartimeentryresponse", + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "", + "title": "Datum2", + "required": [ + "id", + "wid", + "user", + "billable", + "start", + "end", + "duration", + "description", + "tags", + "source", + "at", + "task_location", + "task_tags", + "task_url" + ], + "properties": { + "id": { + "type": "string" + }, + "wid": { + "type": "string" + }, + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user" + }, + "billable": { + "type": "boolean" + }, + "start": { + "type": "string" + }, + "end": { + "type": "string" + }, + "duration": { + "type": "string" + }, + "description": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "source": { + "type": "string" + }, + "at": { + "type": "string" + }, + "approval_id": { + "type": "string", + "description": "ID of the associated approval" + }, + "approval": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval" + }, + "task_location": { + "title": "TaskLocation", + "required": [ + "list_id", + "folder_id", + "space_id", + "list_name", + "folder_name", + "space_name" + ], + "type": "object", + "properties": { + "list_id": { + "type": "integer", + "contentEncoding": "int32" + }, + "folder_id": { + "type": "integer", + "contentEncoding": "int32" + }, + "space_id": { + "type": "integer", + "contentEncoding": "int32" + }, + "list_name": { + "type": "string" + }, + "folder_name": { + "type": "string" + }, + "space_name": { + "type": "string" + } + }, + "examples": [ + { + "list_id": 1560300071, + "folder_id": 468300080, + "space_id": 22800253, + "list_name": "List", + "folder_name": "Folder", + "space_name": "Space" + } + ] + }, + "task_tags": { + "type": "array", + "items": { + "title": "TaskTag", + "required": [ + "name", + "tag_fg", + "tag_bg", + "creator" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "tag_fg": { + "type": "string" + }, + "tag_bg": { + "type": "string" + }, + "creator": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "name": "content-request", + "tag_fg": "#800000", + "tag_bg": "#2ecd6f", + "creator": 301828 + } + ] + }, + "description": "" + }, + "task_url": { + "type": "string" + } + }, + "examples": [ + { + "id": "timer_id", + "wid": "workspace_id", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1592841559129", + "end": "1592845899021", + "duration": "4339892", + "description": "", + "tags": [], + "source": "clickup", + "at": "1592845899021", + "approval_id": "2d539936-119a-4927-9770-179f0a72e2e5", + "approval": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval" + }, + "task_location": { + "list_id": 1560300071, + "folder_id": 468300080, + "space_id": 22800253, + "list_name": "List", + "folder_name": "Folder", + "space_name": "Space" + }, + "task_tags": [ + { + "name": "content-request", + "tag_fg": "#800000", + "tag_bg": "#2ecd6f", + "creator": 301828 + }, + { + "name": "marketing-okr", + "tag_fg": "#800000", + "tag_bg": "#7C4DFF", + "creator": 301828 + } + ], + "task_url": "https://staging.clickup.com/t/rnmuwz7" + } + ] + } + }, + "examples": [ + { + "data": [ + { + "id": "timer_id", + "wid": "workspace_id", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1592841559129", + "end": "1592845899021", + "duration": "4339892", + "description": "", + "tags": [], + "source": "clickup", + "at": "1592845899021", + "approval_id": "2d539936-119a-4927-9770-179f0a72e2e5", + "approval": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval" + }, + "task_location": { + "list_id": 1560300071, + "folder_id": 468300080, + "space_id": 22800253, + "list_name": "List", + "folder_name": "Folder", + "space_name": "Space" + }, + "task_tags": [ + { + "name": "content-request", + "tag_fg": "#800000", + "tag_bg": "#2ecd6f", + "creator": 301828 + }, + { + "name": "marketing-okr", + "tag_fg": "#800000", + "tag_bg": "#7C4DFF", + "creator": 301828 + } + ], + "task_url": "https://staging.clickup.com/t/rnmuwz7" + } + ] + } + ] + }, + "example": { + "data": [ + { + "id": "timer_id", + "wid": "workspace_id", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1592841559129", + "end": "1592845899021", + "duration": "4339892", + "description": "", + "source": "clickup", + "at": "1592845899021", + "task_location": { + "list_id": 1560300071, + "folder_id": 468300080, + "space_id": 22800253, + "list_name": "List", + "folder_name": "Folder", + "space_name": "Space" + }, + "task_tags": [ + { + "name": "content-request", + "tag_fg": "#800000", + "tag_bg": "#2ecd6f", + "creator": 301828 + }, + { + "name": "marketing-okr", + "tag_fg": "#800000", + "tag_bg": "#7C4DFF", + "creator": 301828 + } + ], + "task_url": "https://staging.clickup.com/t/rnmuwz7" + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete a time Entry", + "tags": [ + "Time Tracking" + ], + "description": "Delete a time entry from a Workspace.", + "operationId": "DeleteatimeEntry", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "timer_id", + "in": "path", + "description": "Array of timer ids to delete separated by commas", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "DeleteatimeEntryresponse", + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data" + } + }, + "examples": [ + { + "data": { + "id": "timer_id", + "task": { + "id": "task_id", + "name": "test task", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + }, + "wid": "workspace_id", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1595289395842", + "end": 1595289452790, + "duration": 56948, + "description": "", + "tags": [], + "source": "clickup", + "at": 1595289452790 + } + } + ] + }, + "example": { + "data": { + "id": "timer_id", + "task": { + "id": "task_id", + "name": "test task", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + }, + "wid": "workspace_id", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1595289395842", + "end": 1595289452790, + "duration": 56948, + "description": "", + "tags": [], + "source": "clickup", + "at": 1595289452790 + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "put": { + "summary": "Update a time Entry", + "tags": [ + "Time Tracking" + ], + "description": "Update the details of a time entry.", + "operationId": "UpdateatimeEntry", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "timer_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 2004673344540003600 + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "Accessible tag actions are `[\"replace\", \"add\", \"remove\"]`", + "content": { + "application/json": { + "schema": { + "title": "UpdateatimeEntryrequest", + "required": [ + "tags", + "tid" + ], + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "tags": { + "description": "Users on the Business Plan and above can include a time tracking label.", + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items" + } + }, + "tag_action": { + "type": "string" + }, + "start": { + "type": "integer", + "contentEncoding": "int64", + "description": "When providing `start`, you must also provide `end`." + }, + "end": { + "type": "integer", + "contentEncoding": "int64", + "description": "When providing `end`, you must also provide `start`." + }, + "tid": { + "type": "string" + }, + "billable": { + "type": "boolean" + }, + "duration": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "description": "", + "tags": [ + { + "name": "name of tag", + "tag_bg": "#BF55EC", + "tag_fg": "#FFFFFF" + } + ], + "tag_action": "add", + "start": 1595289395842, + "end": 1595289495842, + "tid": "task_id", + "billable": true, + "duration": 100000 + } + ] + }, + "example": { + "description": "", + "tags": [ + { + "name": "name of tag", + "tag_bg": "#BF55EC", + "tag_fg": "#FFFFFF" + } + ], + "tag_action": "add", + "start": 1595289395842, + "end": 1595289495842, + "tid": "task_id", + "billable": true, + "duration": 100000 + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "contentMediaType": "application/json" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 7, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/time_entries/{timer_id}/history": { + "parameters": [], + "get": { + "summary": "Get time entry history", + "tags": [ + "Time Tracking" + ], + "description": "View a list of changes made to a time entry.", + "operationId": "Gettimeentryhistory", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "timer_id", + "in": "path", + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "1963465985517105840" + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "contentMediaType": "application/json" + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/time_entries/current": { + "parameters": [], + "get": { + "summary": "Get running time entry", + "tags": [ + "Time Tracking" + ], + "description": "View a time entry that's currently tracking time for the authenticated user. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*", + "operationId": "Getrunningtimeentry", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "assignee", + "in": "query", + "description": "user id", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double" + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "Getrunningtimeentryresponse", + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "title": "Data", + "required": [ + "id", + "task", + "wid", + "user", + "billable", + "start", + "duration", + "description", + "tags", + "at" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "task": { + "title": "Task5", + "required": [ + "id", + "name", + "status" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + } + }, + "examples": [ + { + "id": "task_id", + "name": "task_name", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + } + } + ] + }, + "wid": { + "type": "string" + }, + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user" + }, + "billable": { + "type": "boolean" + }, + "start": { + "type": "string" + }, + "duration": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "at": { + "type": "string" + } + }, + "examples": [ + { + "id": "timer_id", + "task": { + "id": "task_id", + "name": "task_name", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + } + }, + "wid": "workspace_id", + "user": { + "id": 300528, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1595293042560", + "duration": -25655, + "description": "", + "tags": [], + "at": "1595293042560" + } + ] + } + }, + "examples": [ + { + "data": { + "id": "timer_id", + "task": { + "id": "task_id", + "name": "task_name", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + } + }, + "wid": "workspace_id", + "user": { + "id": 300528, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1595293042560", + "duration": -25655, + "description": "", + "tags": [], + "at": "1595293042560" + } + } + ] + }, + "example": { + "data": { + "id": "timer_id", + "task": { + "id": "task_id", + "name": "task_name", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + } + }, + "wid": "workspace_id", + "user": { + "id": 300528, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1595293042560", + "duration": -25655, + "description": "", + "tags": [], + "at": "1595293042560" + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/time_entries/tags": { + "parameters": [], + "delete": { + "summary": "Remove tags from time entries", + "tags": [ + "Time Tracking" + ], + "description": "Remove labels from time entries. This does not remove the label from a Workspace.", + "operationId": "Removetagsfromtimeentries", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "Removetagsfromtimeentriesrequest", + "required": [ + "time_entry_ids", + "tags" + ], + "type": "object", + "properties": { + "time_entry_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries~1start/post/requestBody/content/application~1json/schema/properties/tags/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries~1start/post/requestBody/content/application~1json/schema/properties/tags/items" + }, + "description": "" + } + }, + "examples": [ + { + "time_entry_ids": [ + "timer_id" + ], + "tags": [ + { + "name": "name of tag" + } + ] + } + ] + }, + "example": { + "time_entry_ids": [ + "timer_id" + ], + "tags": [ + { + "name": "name of tag" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 1, + "x-moar-complexity-skipped": false + }, + "get": { + "summary": "Get all tags from time entries", + "tags": [ + "Time Tracking" + ], + "description": "View all the labels that have been applied to time entries in a Workspace.", + "operationId": "Getalltagsfromtimeentries", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "Getalltagsfromtimeentriesresponse", + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "title": "Data1", + "required": [ + "name", + "creator", + "tag_bg", + "tag_fg" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "creator": { + "type": "integer", + "contentEncoding": "int32" + }, + "tag_bg": { + "type": "string" + }, + "tag_fg": { + "type": "string" + } + }, + "examples": [ + { + "name": "name of tag", + "creator": 1, + "tag_bg": "#BF55EC", + "tag_fg": "#FFFFFF" + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "data": [ + { + "name": "name of tag", + "creator": 1, + "tag_bg": "#BF55EC", + "tag_fg": "#FFFFFF" + } + ] + } + ] + }, + "example": { + "data": [ + { + "name": "name of tag", + "creator": 1, + "tag_bg": "#BF55EC", + "tag_fg": "#FFFFFF" + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Add tags from time entries", + "tags": [ + "Time Tracking" + ], + "description": "Add a label to a time entry.", + "operationId": "Addtagsfromtimeentries", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "Addtagsfromtimeentriesrequest", + "required": [ + "time_entry_ids", + "tags" + ], + "type": "object", + "properties": { + "time_entry_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items" + }, + "description": "" + } + }, + "examples": [ + { + "time_entry_ids": [ + "timer_id" + ], + "tags": [ + { + "name": "name of tag", + "tag_bg": "#BF55EC", + "tag_fg": "#FFFFFF" + } + ] + } + ] + }, + "example": { + "time_entry_ids": [ + "timer_id" + ], + "tags": [ + { + "name": "name of tag", + "tag_bg": "#BF55EC", + "tag_fg": "#FFFFFF" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 1, + "x-moar-complexity-skipped": false + }, + "put": { + "summary": "Change tag names from time entries", + "tags": [ + "Time Tracking" + ], + "description": "Rename an time entry label.", + "operationId": "Changetagnamesfromtimeentries", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "Changetagnamesfromtimeentriesrequest", + "required": [ + "name", + "new_name", + "tag_bg", + "tag_fg" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "new_name": { + "type": "string" + }, + "tag_bg": { + "type": "string" + }, + "tag_fg": { + "type": "string" + } + }, + "examples": [ + { + "name": "old tag name", + "new_name": "new tag name", + "tag_bg": "#000000", + "tag_fg": "#000000" + } + ] + }, + "example": { + "name": "old tag name", + "new_name": "new tag name", + "tag_bg": "#000000", + "tag_fg": "#000000" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 4, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_Id}/time_entries/start": { + "parameters": [], + "post": { + "summary": "Start a time Entry", + "tags": [ + "Time Tracking" + ], + "description": "Start a timer for the authenticated user.", + "operationId": "StartatimeEntry", + "parameters": [ + { + "name": "team_Id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "custom_task_ids", + "in": "query", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + true + ] + } + }, + { + "name": "team_id", + "in": "query", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "style": "form", + "explode": true, + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "For Workspaces on the Free Forever or Unlimited Plan, either the `timer_id` parameter or the `\"tid\"` field in the body of the request are required fields.", + "content": { + "application/json": { + "schema": { + "title": "StartatimeEntryrequest", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "tags": { + "description": "Users on the Business Plan and above can include a time tracking label.", + "type": "array", + "items": { + "title": "Tags10", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "examples": [ + { + "name": "name of tag" + } + ] + } + }, + "tid": { + "type": "string" + }, + "billable": { + "type": "boolean" + } + }, + "examples": [ + { + "description": "from api", + "tags": [ + { + "name": "tag1" + } + ], + "tid": "task_id", + "billable": false + } + ] + }, + "example": { + "description": "from api", + "tags": [ + { + "name": "tag1" + } + ], + "tid": "task_id", + "billable": false + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "StartatimeEntryresponse", + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "title": "Data2", + "required": [ + "id", + "task", + "wid", + "user", + "billable", + "start", + "duration", + "description", + "tags", + "at" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "task": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/task", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/task" + }, + "wid": { + "type": "string" + }, + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user" + }, + "billable": { + "type": "boolean" + }, + "start": { + "type": "string" + }, + "duration": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "at": { + "type": "integer", + "contentEncoding": "int64" + } + }, + "examples": [ + { + "id": "timer_id", + "task": { + "id": "task_id", + "name": "test task", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + }, + "wid": "workspace_id", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1595289395842", + "duration": -53, + "description": "", + "tags": [], + "at": 1595289452790 + } + ] + } + }, + "examples": [ + { + "data": { + "id": "timer_id", + "task": { + "id": "task_id", + "name": "test task", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + }, + "wid": "workspace_id", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1595289395842", + "duration": -53, + "description": "", + "tags": [], + "at": 1595289452790 + } + } + ] + }, + "example": { + "data": { + "id": "timer_id", + "task": { + "id": "task_id", + "name": "test task", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + }, + "wid": "workspace_id", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1595289395842", + "duration": -53, + "description": "", + "tags": [], + "at": 1595289452790 + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 4, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/time_entries/stop": { + "parameters": [], + "post": { + "summary": "Stop a time Entry", + "tags": [ + "Time Tracking" + ], + "description": "Stop a timer that's currently running for the authenticated user.", + "operationId": "StopatimeEntry", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "Content-Type", + "in": "header", + "description": "", + "required": true, + "style": "simple", + "schema": { + "const": "application/json", + "type": "string", + "examples": [ + "application/json" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "StopatimeEntryresponse", + "required": [ + "data" + ], + "type": "object", + "properties": { + "data": { + "title": "Data3", + "required": [ + "id", + "task", + "wid", + "user", + "billable", + "start", + "end", + "duration", + "description", + "tags", + "source", + "at" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "task": { + "title": "Task6", + "required": [ + "id", + "name", + "status", + "custom_type" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "custom_type": { + "type": [ + "string", + "null" + ] + } + }, + "examples": [ + { + "id": "task_id", + "name": "test task", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + } + ] + }, + "wid": { + "type": "string" + }, + "user": { + "title": "User2", + "required": [ + "id", + "username", + "initials", + "email", + "color", + "profilePicture" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 183, + "username": "John Doe", + "initials": "JD", + "email": "johndoe@gmail.com", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + } + ] + }, + "billable": { + "type": "boolean" + }, + "start": { + "type": "string" + }, + "end": { + "type": "integer", + "contentEncoding": "int64" + }, + "duration": { + "type": "integer", + "contentEncoding": "int32" + }, + "description": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "source": { + "type": "string" + }, + "at": { + "type": "integer", + "contentEncoding": "int64" + } + }, + "examples": [ + { + "id": "timer_id", + "task": { + "id": "task_id", + "name": "test task", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + }, + "wid": "workspace_id", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1595289395842", + "end": 1595289452790, + "duration": 56948, + "description": "", + "tags": [], + "source": "clickup", + "at": 1595289452790 + } + ] + } + }, + "examples": [ + { + "data": { + "id": "timer_id", + "task": { + "id": "task_id", + "name": "test task", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + }, + "wid": "workspace_id", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1595289395842", + "end": 1595289452790, + "duration": 56948, + "description": "", + "tags": [], + "source": "clickup", + "at": 1595289452790 + } + } + ] + }, + "example": { + "data": { + "id": "timer_id", + "task": { + "id": "task_id", + "name": "test task", + "status": { + "status": "to do", + "color": "#d3d3d3", + "type": "open", + "orderindex": 0 + }, + "custom_type": null + }, + "wid": "workspace_id", + "user": { + "id": 1, + "username": "first_name last_name", + "email": "test@gmail.com", + "color": "#08c7e0", + "initials": "JK", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg" + }, + "billable": false, + "start": "1595289395842", + "end": 1595289452790, + "duration": 56948, + "description": "", + "tags": [], + "source": "clickup", + "at": 1595289452790 + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/user": { + "parameters": [], + "post": { + "summary": "Invite User To Workspace", + "tags": [ + "Users" + ], + "description": "Invite someone to join your Workspace as a member. To invite someone as a guest, use the [Invite Guest](ref:inviteguesttoworkspace) endpoint.\\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "InviteUserToWorkspace", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "InviteUserToWorkspacerequest", + "required": [ + "email", + "admin" + ], + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "admin": { + "type": "boolean" + }, + "custom_role_id": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "email": "user@example.com", + "admin": true, + "custom_role_id": 112233 + } + ] + }, + "example": { + "email": "user@example.com", + "admin": true + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "InviteUserToWorkspaceresponse", + "required": [ + "team" + ], + "type": "object", + "properties": { + "team": { + "title": "Team3", + "required": [ + "id", + "name", + "color", + "avatar", + "members", + "roles" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "avatar": { + "type": [ + "string", + "null" + ] + }, + "members": { + "type": "array", + "items": { + "title": "Members5", + "required": [ + "user", + "invited_by" + ], + "type": "object", + "properties": { + "user": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1guest~1%7Bguest_id%7D/put/responses/200/content/application~1json/schema/properties/guest/properties/user", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1guest~1%7Bguest_id%7D/put/responses/200/content/application~1json/schema/properties/guest/properties/user" + }, + "invited_by": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by" + } + }, + "examples": [ + { + "user": { + "id": 184, + "username": null, + "email": "user@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 2, + "custom_role": { + "id": 112233, + "name": "admin custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + } + } + ] + }, + "description": "" + }, + "roles": { + "type": "array", + "items": { + "title": "Role", + "required": [ + "id", + "name", + "custom" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "name": { + "type": "string" + }, + "custom": { + "type": "boolean" + }, + "inherited_role": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "id": 1, + "name": "owner", + "custom": false + } + ] + }, + "description": "" + } + }, + "examples": [ + { + "id": "333", + "name": "Team Name", + "color": "#8D00D4", + "avatar": null, + "members": [ + { + "user": { + "id": 184, + "username": null, + "email": "user@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 2, + "custom_role": { + "id": 112233, + "name": "admin custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + } + } + ], + "roles": [ + { + "id": 1, + "name": "owner", + "custom": false + }, + { + "id": 2, + "name": "admin", + "custom": false + }, + { + "id": 3, + "name": "member", + "custom": false + }, + { + "id": 4, + "name": "guest", + "custom": false + }, + { + "id": 998877, + "name": "member custom", + "inherited_role": 3, + "custom": true + }, + { + "id": 112233, + "name": "admin custom", + "inherited_role": 2, + "custom": true + }, + { + "id": 12345, + "name": "guest custom", + "inherited_role": 4, + "custom": true + } + ] + } + ] + } + }, + "examples": [ + { + "team": { + "id": "333", + "name": "Team Name", + "color": "#8D00D4", + "avatar": null, + "members": [ + { + "user": { + "id": 184, + "username": null, + "email": "user@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 2, + "custom_role": { + "id": 112233, + "name": "admin custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + } + } + ], + "roles": [ + { + "id": 1, + "name": "owner", + "custom": false + }, + { + "id": 2, + "name": "admin", + "custom": false + }, + { + "id": 3, + "name": "member", + "custom": false + }, + { + "id": 4, + "name": "guest", + "custom": false + }, + { + "id": 998877, + "name": "member custom", + "inherited_role": 3, + "custom": true + }, + { + "id": 112233, + "name": "admin custom", + "inherited_role": 2, + "custom": true + }, + { + "id": 12345, + "name": "guest custom", + "inherited_role": 4, + "custom": true + } + ] + } + } + ] + }, + "example": { + "team": { + "id": "333", + "name": "Team Name", + "color": "#8D00D4", + "avatar": null, + "members": [ + { + "user": { + "id": 184, + "username": null, + "email": "user@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 2, + "custom_role": { + "id": 112233, + "name": "admin custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + } + } + ], + "roles": [ + { + "id": 1, + "name": "owner", + "custom": false + }, + { + "id": 2, + "name": "admin", + "custom": false + }, + { + "id": 3, + "name": "member", + "custom": false + }, + { + "id": 4, + "name": "guest", + "custom": false + }, + { + "id": 998877, + "name": "member custom", + "inherited_role": 3, + "custom": true + }, + { + "id": 112233, + "name": "admin custom", + "inherited_role": 2, + "custom": true + }, + { + "id": 12345, + "name": "guest custom", + "inherited_role": 4, + "custom": true + } + ] + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 3, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/user/{user_id}": { + "parameters": [], + "get": { + "summary": "Get User", + "tags": [ + "Users" + ], + "description": "View information about a user in a Workspace. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "GetUser", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "user_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + }, + { + "name": "include_shared", + "in": "query", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "boolean", + "examples": [ + false + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetUserresponse", + "type": "object", + "properties": { + "member": { + "title": "Member7", + "type": "object", + "properties": { + "user": { + "title": "User21", + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "color": { + "type": [ + "string", + "null" + ] + }, + "profilePicture": { + "type": [ + "string", + "null" + ] + }, + "initials": { + "type": "string" + }, + "role": { + "description": "Owner = 1, Admin = 2, Member = 3, Guest = 4", + "type": "integer", + "contentEncoding": "int32" + }, + "custom_role": { + "title": "CustomRole", + "required": [ + "id", + "name" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "name": { + "type": "string" + } + }, + "examples": [ + { + "id": 12345, + "name": "guest custom" + } + ] + }, + "last_active": { + "type": [ + "string", + "null" + ] + }, + "date_joined": { + "type": [ + "string", + "null" + ] + }, + "date_invited": { + "type": "string" + } + }, + "examples": [ + { + "id": 184, + "username": "User Name", + "email": "user@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 3, + "custom_role": { + "id": 998877, + "name": "member custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + } + ] + }, + "invited_by": { + "title": "InvitedBy", + "type": "object", + "properties": { + "id": { + "type": "integer", + "contentEncoding": "int32" + }, + "color": { + "type": "string" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + }, + "initials": { + "type": "string" + }, + "profilePicture": { + "type": "string" + } + }, + "examples": [ + { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + } + ] + }, + "shared": { + "title": "Shared", + "type": "object", + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "lists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "folders": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + } + }, + "examples": [ + { + "tasks": [], + "lists": [], + "folders": [] + } + ] + } + }, + "examples": [ + { + "user": { + "id": 184, + "username": "User Name", + "email": "user@example.com", + "color": null, + "profilePicture": null, + "initials": "UN", + "role": 3, + "custom_role": { + "id": 998877, + "name": "member custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + ] + } + }, + "examples": [ + { + "member": { + "user": { + "id": 184, + "username": "User Name", + "email": "user@example.com", + "color": null, + "profilePicture": null, + "initials": "UN", + "role": 3, + "custom_role": { + "id": 998877, + "name": "member custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + ] + }, + "example": { + "member": { + "user": { + "id": 184, + "username": "User Name", + "email": "user@example.com", + "color": null, + "profilePicture": null, + "initials": "UN", + "role": 3, + "custom_role": { + "id": 998877, + "name": "member custom" + }, + "last_active": "1688667338000", + "date_joined": "1657131338000", + "date_invited": "1657044938000" + }, + "invited_by": { + "id": 183, + "username": "Jerry", + "color": "#827718", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "put": { + "summary": "Edit User On Workspace", + "tags": [ + "Users" + ], + "description": "Update a user's name and role. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "EditUserOnWorkspace", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "user_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "EditUserOnWorkspacerequest", + "required": [ + "username", + "admin", + "custom_role_id" + ], + "type": "object", + "properties": { + "username": { + "type": "string" + }, + "admin": { + "type": "boolean" + }, + "custom_role_id": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "username": "User Name", + "admin": false, + "custom_role_id": 998877 + } + ] + }, + "example": { + "username": "User Name", + "admin": false, + "custom_role_id": 998877 + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "EditUserOnWorkspaceresponse", + "required": [ + "member" + ], + "type": "object", + "properties": { + "member": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member" + } + }, + "examples": [ + { + "member": { + "user": { + "id": 184, + "username": "User Name", + "email": "user@example.com", + "color": null, + "profilePicture": null, + "initials": "UN", + "role": 3, + "custom_role": { + "id": 998877, + "name": "member custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + ] + }, + "example": { + "member": { + "user": { + "id": 184, + "username": "User Name", + "email": "user@example.com", + "color": null, + "profilePicture": null, + "initials": "G", + "role": 3, + "custom_role": { + "id": 998877, + "name": "member custom" + }, + "last_active": null, + "date_joined": null, + "date_invited": "1583358383412" + }, + "invited_by": { + "id": 183, + "color": "#827718", + "username": "Jerry", + "email": "jerry@example.com", + "initials": "J", + "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg" + }, + "shared": { + "tasks": [], + "lists": [], + "folders": [] + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 3, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Remove User From Workspace", + "tags": [ + "Users" + ], + "description": "Deactivate a user from a Workspace. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*", + "operationId": "RemoveUserFromWorkspace", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + }, + { + "name": "user_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 403 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "RemoveUserFromWorkspaceresponse", + "required": [ + "team" + ], + "type": "object", + "properties": { + "team": { + "title": "Team2", + "required": [ + "id", + "name", + "color", + "avatar", + "members" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "avatar": { + "type": [ + "string", + "null" + ] + }, + "members": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + } + }, + "examples": [ + { + "id": "333", + "name": "Team Name", + "color": "#8D00D4", + "avatar": null, + "members": [] + } + ] + } + }, + "examples": [ + { + "team": { + "id": "333", + "name": "Team Name", + "color": "#8D00D4", + "avatar": null, + "members": [] + } + } + ] + }, + "example": { + "team": { + "id": "333", + "name": "Team Name", + "color": "#8D00D4", + "avatar": null, + "members": [] + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/view": { + "parameters": [], + "get": { + "summary": "Get Workspace (Everything level) Views", + "tags": [ + "Views" + ], + "description": "View the task and page views available at the Everything Level of a Workspace.", + "operationId": "GetTeamViews", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetTeamViewsresponse", + "required": [ + "views" + ], + "type": "object", + "properties": { + "views": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view" + }, + "description": "" + } + }, + "examples": [ + { + "views": [ + { + "id": "3c-105", + "name": "New View Name", + "type": "list", + "parent": { + "id": "512", + "type": 7 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + } + ] + }, + "example": { + "views": [ + { + "id": "3c-105", + "name": "New View Name", + "type": "list", + "parent": { + "id": "512", + "type": 7 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "field": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Workspace (Everything level) View", + "tags": [ + "Views" + ], + "description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view at the Everything Level of a Workspace.", + "operationId": "CreateTeamView", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateTeamViewrequest", + "required": [ + "name", + "type", + "grouping", + "divide", + "sorting", + "filters", + "columns", + "team_sidebar", + "settings" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "examples": [ + { + "name": "New Team View Name", + "type": "list", + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + }, + "example": { + "name": "New Everything level View", + "type": "list", + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "field": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateTeamViewresponse", + "required": [ + "view" + ], + "type": "object", + "properties": { + "view": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view" + } + }, + "examples": [ + { + "view": { + "id": "3c-105", + "name": "New Team View Name", + "type": "list", + "parent": { + "id": "512", + "type": 7 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + ] + }, + "example": { + "view": { + "id": "3c-105", + "name": "New Team View Name", + "type": "list", + "parent": { + "id": "512", + "type": 7 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "field": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 2, + "x-moar-complexity-skipped": false + } + }, + "/v2/space/{space_id}/view": { + "parameters": [], + "get": { + "summary": "Get Space Views", + "tags": [ + "Views" + ], + "description": "View the task and page views available for a Space.", + "operationId": "GetSpaceViews", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 790 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetSpaceViewsresponse", + "required": [ + "views" + ], + "type": "object", + "properties": { + "views": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view" + }, + "description": "" + } + }, + "examples": [ + { + "views": [ + { + "id": "3c-106", + "name": "New Space View Name", + "type": "list", + "parent": { + "id": "790", + "type": 4 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + } + ] + }, + "example": { + "views": [ + { + "id": "3c-106", + "name": "New Space View Name", + "type": "list", + "parent": { + "id": "790", + "type": 4 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Space View", + "tags": [ + "Views" + ], + "description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Space.", + "operationId": "CreateSpaceView", + "parameters": [ + { + "name": "space_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 790 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateSpaceViewrequest", + "required": [ + "name", + "type", + "grouping", + "divide", + "sorting", + "filters", + "columns", + "team_sidebar", + "settings" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "examples": [ + { + "name": "New Space View Name", + "type": "list", + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + }, + "example": { + "name": "New Space View Name", + "type": "list", + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateSpaceViewresponse", + "required": [ + "view" + ], + "type": "object", + "properties": { + "view": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view" + } + }, + "examples": [ + { + "view": { + "id": "3c-106", + "name": "New Space View Name", + "type": "list", + "parent": { + "id": "790", + "type": 4 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + ] + }, + "example": { + "view": { + "id": "3c-106", + "name": "New Space View Name", + "type": "list", + "parent": { + "id": "790", + "type": 4 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 2, + "x-moar-complexity-skipped": false + } + }, + "/v2/folder/{folder_id}/view": { + "parameters": [], + "get": { + "summary": "Get Folder Views", + "tags": [ + "Views" + ], + "description": "View the task and page views available for a Folder.", + "operationId": "GetFolderViews", + "parameters": [ + { + "name": "folder_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 457 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetFolderViewsresponse", + "required": [ + "views" + ], + "type": "object", + "properties": { + "views": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view" + }, + "description": "" + } + }, + "examples": [ + { + "views": [ + { + "id": "3c-107", + "name": "New Folder View Name", + "type": "list", + "parent": { + "id": "457", + "type": 5 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + } + ] + }, + "example": { + "views": [ + { + "id": "3c-107", + "name": "New Folder View Name", + "type": "list", + "parent": { + "id": "457", + "type": 5 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Folder View", + "tags": [ + "Views" + ], + "description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Folder.", + "operationId": "CreateFolderView", + "parameters": [ + { + "name": "folder_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 457 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateFolderViewrequest", + "required": [ + "name", + "type", + "grouping", + "divide", + "sorting", + "filters", + "columns", + "team_sidebar", + "settings" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "examples": [ + { + "name": "New Folder View Name", + "type": "list", + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + }, + "example": { + "name": "New Folder View Name", + "type": "list", + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateFolderViewresponse", + "required": [ + "view" + ], + "type": "object", + "properties": { + "view": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view" + } + }, + "examples": [ + { + "view": { + "id": "3c-107", + "name": "New Folder View Name", + "type": "list", + "parent": { + "id": "457", + "type": 5 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + ] + }, + "example": { + "view": { + "id": "3c-107", + "name": "New Folder View Name", + "type": "list", + "parent": { + "id": "457", + "type": 5 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 2, + "x-moar-complexity-skipped": false + } + }, + "/v2/list/{list_id}/view": { + "parameters": [], + "get": { + "summary": "Get List Views", + "tags": [ + "Views" + ], + "description": "View the task and page views available for a List.
Views and required views are separate responses.", + "operationId": "GetListViews", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 124 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetListViewsresponse", + "required": [ + "views" + ], + "type": "object", + "properties": { + "views": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view" + }, + "description": "" + } + }, + "examples": [ + { + "views": [ + { + "id": "3c-107", + "name": "New List View Name", + "type": "list", + "parent": { + "id": "124", + "type": 6 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + } + ] + }, + "example": { + "views": [ + { + "id": "3c-107", + "name": "New List View Name", + "type": "list", + "parent": { + "id": "124", + "type": 6 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create List View", + "tags": [ + "Views" + ], + "description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a List.", + "operationId": "CreateListView", + "parameters": [ + { + "name": "list_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 124 + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "CreateListViewrequest", + "required": [ + "name", + "type", + "grouping", + "divide", + "sorting", + "filters", + "columns", + "team_sidebar", + "settings" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "examples": [ + { + "name": "New List View Name", + "type": "list", + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + }, + "example": { + "name": "New List View Name", + "type": "list", + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateListViewresponse", + "required": [ + "view" + ], + "type": "object", + "properties": { + "view": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view" + } + }, + "examples": [ + { + "view": { + "id": "3c-108", + "name": "New List View Name", + "type": "list", + "parent": { + "id": "124", + "type": 6 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + ] + }, + "example": { + "view": { + "id": "3c-108", + "name": "New List View Name", + "type": "list", + "parent": { + "id": "124", + "type": 6 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 2, + "x-moar-complexity-skipped": false + } + }, + "/v2/view/{view_id}": { + "parameters": [], + "get": { + "summary": "Get View", + "tags": [ + "Views" + ], + "description": "View information about a specific task or page view.", + "operationId": "GetView", + "parameters": [ + { + "name": "view_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "3c-105" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetViewresponse", + "required": [ + "view" + ], + "type": "object", + "properties": { + "view": { + "title": "View", + "required": [ + "id", + "name", + "type", + "parent", + "grouping", + "divide", + "sorting", + "filters", + "columns", + "team_sidebar", + "settings" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "parent": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/parent", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/parent" + }, + "grouping": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "examples": [ + { + "id": "3c-105", + "name": "New Team View Name", + "type": "list", + "parent": { + "id": "512", + "type": 7 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + } + }, + "examples": [ + { + "view": { + "id": "3c-105", + "name": "New View Name", + "type": "list", + "parent": { + "id": "512", + "type": 7 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + ] + }, + "example": { + "view": { + "id": "3c-105", + "name": "New View Name", + "type": "list", + "parent": { + "id": "512", + "type": 7 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "put": { + "summary": "Update View", + "tags": [ + "Views" + ], + "description": "Rename a view, update the grouping, sorting, filters, columns, and settings of a view.", + "operationId": "UpdateView", + "parameters": [ + { + "name": "view_id", + "in": "path", + "description": "", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "3c" + ] + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "title": "UpdateViewrequest", + "required": [ + "name", + "type", + "parent", + "grouping", + "divide", + "sorting", + "filters", + "columns", + "team_sidebar", + "settings" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "parent": { + "title": "Parent", + "description": "The parent parameter specifies where the view is located in the ClickUp Hierarchy. Both `id` and `type` are required. \\\n \\\nThe `id` is the id of the Workspace, Space, Folder, or List where the view is located. \\\n \\\nThe `type` value indciates the level of the Hierarchy where the view is located.", + "required": [ + "id", + "type" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the Workspace, Space, Folder, or List where the view is located." + }, + "type": { + "type": "integer", + "description": "The level of the Hierarchy where the view is created. \\\n \\\nOptions include: \\\n \\\nWorkspace (Everything Level): `7` \\\n \\\nSpace: `4` \\\n \\\nFolder: `5` \\\n \\\nList: `6`", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "id": "512", + "type": 7 + } + ] + }, + "grouping": { + "title": "Grouping", + "required": [ + "field", + "dir", + "collapsed", + "ignore" + ], + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`." + }, + "dir": { + "description": "Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view.", + "type": "integer", + "contentEncoding": "int32" + }, + "collapsed": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "ignore": { + "type": "boolean" + } + }, + "examples": [ + { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + } + ] + }, + "divide": { + "title": "Divide", + "required": [ + "collapsed" + ], + "type": "object", + "properties": { + "field": { + "type": [ + "null" + ] + }, + "dir": { + "type": [ + "null" + ] + }, + "collapsed": { + "type": [ + "boolean" + ] + } + }, + "examples": [ + { + "field": null, + "dir": null, + "collapsed": [] + } + ] + }, + "sorting": { + "title": "Sorting", + "required": [ + "fields" + ], + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views)." + } + }, + "examples": [ + { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + } + ] + }, + "filters": { + "title": "Filters", + "required": [ + "op", + "fields", + "search", + "show_closed" + ], + "type": "object", + "properties": { + "op": { + "type": "string", + "description": "The available operator (`op``) values are `AND`` and `OR``." + }, + "fields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "View the list of [fields available](doc:filter-views) to filter by." + }, + "search": { + "type": "string" + }, + "show_closed": { + "type": "boolean" + } + }, + "examples": [ + { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + } + ] + }, + "columns": { + "title": "Columns", + "description": "Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy.", + "required": [ + "fields" + ], + "type": "object", + "properties": { + "fields": { + "description": "Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`", + "type": "array", + "items": { + "type": "string" + } + } + }, + "examples": [ + { + "fields": [] + } + ] + }, + "team_sidebar": { + "title": "TeamSidebar", + "required": [ + "assignees", + "assigned_comments", + "unassigned_tasks" + ], + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "assigned_comments": { + "type": "boolean" + }, + "unassigned_tasks": { + "type": "boolean" + } + }, + "examples": [ + { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + } + ] + }, + "settings": { + "title": "Settings", + "required": [ + "show_task_locations", + "show_subtasks", + "show_subtask_parent_names", + "show_closed_subtasks", + "show_assignees", + "show_images", + "collapse_empty_columns", + "me_comments", + "me_subtasks", + "me_checklists" + ], + "type": "object", + "properties": { + "show_task_locations": { + "type": "boolean" + }, + "show_subtasks": { + "description": "Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.", + "type": "integer", + "contentEncoding": "int32" + }, + "show_subtask_parent_names": { + "type": "boolean" + }, + "show_closed_subtasks": { + "type": "boolean" + }, + "show_assignees": { + "type": "boolean" + }, + "show_images": { + "type": "boolean" + }, + "collapse_empty_columns": { + "type": [ + "string", + "null" + ] + }, + "me_comments": { + "type": "boolean" + }, + "me_subtasks": { + "type": "boolean" + }, + "me_checklists": { + "type": "boolean" + } + }, + "examples": [ + { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + ] + } + }, + "examples": [ + { + "name": "New View Name", + "type": "list", + "parent": { + "id": "512", + "type": 7 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + ] + }, + "example": { + "name": "New View Name", + "type": "list", + "parent": { + "id": "512", + "type": 7 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "UpdateViewresponse", + "required": [ + "view" + ], + "type": "object", + "properties": { + "view": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view" + } + }, + "examples": [ + { + "view": { + "id": "3c-105", + "name": "New View Name", + "type": "list", + "parent": { + "id": "512", + "type": 7 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [] + }, + "filters": { + "op": "AND", + "fields": [], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + ] + }, + "example": { + "view": { + "id": "3c-105", + "name": "New View Name", + "type": "list", + "parent": { + "id": "512", + "type": 7 + }, + "grouping": { + "field": "status", + "dir": 1, + "collapsed": [], + "ignore": false + }, + "divide": { + "field": null, + "dir": null, + "collapsed": [] + }, + "sorting": { + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "dir": -1, + "idx": 0 + } + ] + }, + "filters": { + "op": "AND", + "fields": [ + { + "field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", + "op": "EQ", + "determinor": null, + "idx": 0, + "values": "123" + } + ], + "search": "", + "show_closed": false + }, + "columns": { + "fields": [ + { + "field": "assignee", + "idx": 0, + "width": 160, + "hidden": true, + "name": null, + "display": null + } + ] + }, + "team_sidebar": { + "assignees": [], + "assigned_comments": false, + "unassigned_tasks": false + }, + "settings": { + "show_task_locations": false, + "show_subtasks": 3, + "show_subtask_parent_names": false, + "show_closed_subtasks": false, + "show_assignees": true, + "show_images": true, + "collapse_empty_columns": null, + "me_comments": true, + "me_subtasks": true, + "me_checklists": true + } + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 26, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete View", + "tags": [ + "Views" + ], + "operationId": "DeleteView", + "parameters": [ + { + "name": "view_id", + "in": "path", + "description": "105 (string)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "3c" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/view/{view_id}/task": { + "parameters": [], + "get": { + "summary": "Get View Tasks", + "tags": [ + "Views" + ], + "description": "See all visible tasks in a view in ClickUp.", + "operationId": "GetViewTasks", + "parameters": [ + { + "name": "view_id", + "in": "path", + "description": "105 (string)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "3c" + ] + } + }, + { + "name": "page", + "in": "query", + "description": "", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "integer", + "contentEncoding": "int32", + "examples": [ + 0 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetViewTasksresponse", + "required": [ + "tasks", + "last_page" + ], + "type": "object", + "properties": { + "tasks": { + "type": "array", + "items": { + "title": "Task9", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "custom_item_id": { + "type": [ + "number", + "null" + ] + }, + "name": { + "type": "string" + }, + "status": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status" + }, + "markdown_description": { + "type": "string" + }, + "orderindex": { + "type": "string" + }, + "date_created": { + "type": "string" + }, + "date_updated": { + "type": "string" + }, + "date_closed": { + "type": [ + "string", + "null" + ] + }, + "date_done": { + "type": [ + "string", + "null" + ] + }, + "creator": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator" + }, + "assignees": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "watchers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "checklists": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "parent": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority" + }, + "due_date": { + "type": [ + "string", + "null" + ] + }, + "start_date": { + "type": [ + "string", + "null" + ] + }, + "points": { + "type": [ + "number" + ] + }, + "time_estimate": { + "type": [ + "string", + "null" + ] + }, + "time_spent": { + "type": [ + "string" + ] + }, + "custom_fields": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items" + }, + "list": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list" + }, + "folder": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder" + }, + "space": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space" + }, + "url": { + "type": "string" + } + }, + "examples": [ + { + "id": "9hx", + "name": "New Task Name", + "custom_item_id": null, + "status": { + "status": "Open", + "color": "#d3d3d3", + "orderindex": 0, + "type": "open" + }, + "markdown_description": "Task description", + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "date_done": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "watchers": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": { + "color": "#f8ae00", + "id": "3", + "orderindex": "3", + "priority": "normal" + }, + "due_date": null, + "start_date": null, + "time_estimate": null, + "time_spent": 7200000, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hx" + } + ] + }, + "description": "" + }, + "last_page": { + "type": "boolean" + } + }, + "examples": [ + { + "tasks": [ + { + "id": "9hx", + "name": "New Task Name", + "status": { + "status": "Open", + "color": "#d3d3d3", + "orderindex": 0, + "type": "open" + }, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "date_done": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": { + "color": "#f8ae00", + "id": "3", + "orderindex": "3", + "priority": "normal" + }, + "due_date": null, + "start_date": null, + "points": 3, + "time_estimate": null, + "time_spent": null, + "custom_fields": { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "name": "My Text Custom field", + "type": "text", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": { + "value": "This is a string of text added to a Custom Field." + }, + "required": true + }, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hx" + }, + { + "id": "9hz", + "name": "Second task", + "status": { + "status": "Open", + "color": "#d3d3d3", + "orderindex": 0, + "type": "open" + }, + "orderindex": "2.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "date_done": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": null, + "due_date": null, + "start_date": null, + "points": 3, + "time_estimate": null, + "time_spent": null, + "custom_fields": { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "name": "My Text Custom field", + "type": "text", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": { + "value": "This is a string of text added to a Custom Field." + }, + "required": true + }, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hz" + } + ], + "last_page": true + } + ] + }, + "example": { + "tasks": [ + { + "id": "9hx", + "name": "New Task Name", + "status": { + "status": "Open", + "color": "#d3d3d3", + "orderindex": 0, + "type": "open" + }, + "orderindex": "1.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "date_done": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": { + "color": "#f8ae00", + "id": "3", + "orderindex": "3", + "priority": "normal" + }, + "due_date": null, + "start_date": null, + "points": 3, + "time_estimate": null, + "time_spent": null, + "custom_fields": { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "name": "My Text Custom field", + "type": "text", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": { + "value": "This is a string of text added to a Custom Field." + }, + "required": true + }, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hx" + }, + { + "id": "9hz", + "name": "Second task", + "status": { + "status": "Open", + "color": "#d3d3d3", + "orderindex": 0, + "type": "open" + }, + "orderindex": "2.00000000000000000000000000000000", + "date_created": "1567780450202", + "date_updated": "1567780450202", + "date_closed": null, + "date_done": null, + "creator": { + "id": 183, + "username": "John Doe", + "color": "#827718", + "profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg" + }, + "assignees": [], + "checklists": [], + "tags": [], + "parent": null, + "priority": null, + "due_date": null, + "start_date": null, + "points": 3, + "time_estimate": null, + "time_spent": null, + "custom_fields": { + "id": "0a52c486-5f05-403b-b4fd-c512ff05131c", + "name": "My Text Custom field", + "type": "text", + "type_config": {}, + "date_created": "1622176979540", + "hide_from_guests": false, + "value": { + "value": "This is a string of text added to a Custom Field." + }, + "required": true + }, + "list": { + "id": "123" + }, + "folder": { + "id": "456" + }, + "space": { + "id": "789" + }, + "url": "https://app.clickup.com/t/9hz" + } + ], + "last_page": true + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + }, + "/v2/team/{team_id}/webhook": { + "parameters": [], + "get": { + "summary": "Get Webhooks", + "tags": [ + "Webhooks" + ], + "description": "View the webhooks created via the API for a Workspace. This endpoint returns webhooks created by the authenticated user.", + "operationId": "GetWebhooks", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "GetWebhooksresponse", + "required": [ + "webhooks" + ], + "type": "object", + "properties": { + "webhooks": { + "type": "array", + "items": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1webhook~1%7Bwebhook_id%7D/put/responses/200/content/application~1json/schema/properties/webhook", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1webhook~1%7Bwebhook_id%7D/put/responses/200/content/application~1json/schema/properties/webhook" + }, + "description": "" + } + }, + "examples": [ + { + "webhooks": [ + { + "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", + "userid": 183, + "team_id": 108, + "endpoint": "https://yourdomain.com/webhook", + "client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO", + "events": [ + "taskCreated", + "taskUpdated", + "taskDeleted", + "taskPriorityUpdated", + "taskStatusUpdated", + "taskAssigneeUpdated", + "taskDueDateUpdated", + "taskTagUpdated", + "taskMoved", + "taskCommentPosted", + "taskCommentUpdated", + "taskTimeEstimateUpdated", + "taskTimeTrackedUpdated", + "listCreated", + "listUpdated", + "listDeleted", + "folderCreated", + "folderUpdated", + "folderDeleted", + "spaceCreated", + "spaceUpdated", + "spaceDeleted", + "goalCreated", + "goalUpdated", + "goalDeleted", + "keyResultCreated", + "keyResultUpdated", + "keyResultDeleted" + ], + "task_id": null, + "list_id": null, + "folder_id": null, + "space_id": null, + "health": { + "status": "failing", + "fail_count": 5 + }, + "secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA" + } + ] + } + ] + }, + "example": { + "webhooks": [ + { + "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", + "userid": 183, + "team_id": 108, + "endpoint": "https://yourdomain.com/webhook", + "client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO", + "events": [ + "taskCreated", + "taskUpdated", + "taskDeleted", + "taskPriorityUpdated", + "taskStatusUpdated", + "taskAssigneeUpdated", + "taskDueDateUpdated", + "taskTagUpdated", + "taskMoved", + "taskCommentPosted", + "taskCommentUpdated", + "taskTimeEstimateUpdated", + "taskTimeTrackedUpdated", + "listCreated", + "listUpdated", + "listDeleted", + "folderCreated", + "folderUpdated", + "folderDeleted", + "spaceCreated", + "spaceUpdated", + "spaceDeleted", + "goalCreated", + "goalUpdated", + "goalDeleted", + "keyResultCreated", + "keyResultUpdated", + "keyResultDeleted" + ], + "task_id": null, + "list_id": null, + "folder_id": null, + "space_id": null, + "health": { + "status": "failing", + "fail_count": 5 + }, + "secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA" + } + ] + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + }, + "post": { + "summary": "Create Webhook", + "tags": [ + "Webhooks" + ], + "description": "Set up a webhook to monitor for events.
We do not have a dedicated IP address for webhooks. We use our domain name and dynamic addressing.", + "operationId": "CreateWebhook", + "parameters": [ + { + "name": "team_id", + "in": "path", + "description": "Workspace ID", + "required": true, + "style": "simple", + "schema": { + "type": "number", + "contentEncoding": "double", + "examples": [ + 123 + ] + } + } + ], + "requestBody": { + "description": "You can subscribe to specific events, and one specific location per webhook. [Learn more](doc:webhooks).", + "content": { + "application/json": { + "schema": { + "title": "CreateWebhookrequest", + "required": [ + "endpoint", + "events" + ], + "type": "object", + "properties": { + "endpoint": { + "type": "string" + }, + "events": { + "type": "array", + "description": "See [documentation](doc:webhooks#task-webhooks) for available event options. Use `*` to subscribe to all events.", + "items": { + "type": "string" + } + }, + "space_id": { + "type": "integer" + }, + "folder_id": { + "type": "integer" + }, + "list_id": { + "type": "integer" + }, + "task_id": { + "type": "string" + } + }, + "examples": [ + { + "endpoint": "https://yourdomain.com/webhook", + "events": [ + "taskCreated", + "taskUpdated", + "taskDeleted", + "taskPriorityUpdated", + "taskStatusUpdated", + "taskAssigneeUpdated", + "taskDueDateUpdated", + "taskTagUpdated", + "taskMoved", + "taskCommentPosted", + "taskCommentUpdated", + "taskTimeEstimateUpdated", + "taskTimeTrackedUpdated", + "listCreated", + "listUpdated", + "listDeleted", + "folderCreated", + "folderUpdated", + "folderDeleted", + "spaceCreated", + "spaceUpdated", + "spaceDeleted", + "goalCreated", + "goalUpdated", + "goalDeleted", + "keyResultCreated", + "keyResultUpdated", + "keyResultDeleted" + ], + "space_id": 1234, + "folder_id": 5678, + "list_id": 9876, + "task_id": "abc1234" + } + ] + }, + "example": { + "endpoint": "https://yourdomain.com/webhook", + "events": [ + "taskCreated", + "taskUpdated", + "taskDeleted", + "taskPriorityUpdated", + "taskStatusUpdated", + "taskAssigneeUpdated", + "taskDueDateUpdated", + "taskTagUpdated", + "taskMoved", + "taskCommentPosted", + "taskCommentUpdated", + "taskTimeEstimateUpdated", + "taskTimeTrackedUpdated", + "listCreated", + "listUpdated", + "listDeleted", + "folderCreated", + "folderUpdated", + "folderDeleted", + "spaceCreated", + "spaceUpdated", + "spaceDeleted", + "goalCreated", + "goalUpdated", + "goalDeleted", + "keyResultCreated", + "keyResultUpdated", + "keyResultDeleted" + ], + "space_id": 1234, + "folder_id": 5678, + "list_id": 9876, + "task_id": "abc1234" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "CreateWebhookresponse", + "required": [ + "id", + "webhook" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "webhook": { + "type": "object", + "description": "Schema reference broken: #/paths/~1v2~1webhook~1%7Bwebhook_id%7D/put/responses/200/content/application~1json/schema/properties/webhook", + "additionalProperties": true, + "x-moar-broken-reference": "#/paths/~1v2~1webhook~1%7Bwebhook_id%7D/put/responses/200/content/application~1json/schema/properties/webhook" + } + }, + "examples": [ + { + "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", + "webhook": { + "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", + "userid": 183, + "team_id": 108, + "endpoint": "https://yourdomain.com/webhook", + "client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO", + "events": [ + "taskCreated", + "taskUpdated", + "taskDeleted", + "taskPriorityUpdated", + "taskStatusUpdated", + "taskAssigneeUpdated", + "taskDueDateUpdated", + "taskTagUpdated", + "taskMoved", + "taskCommentPosted", + "taskCommentUpdated", + "taskTimeEstimateUpdated", + "taskTimeTrackedUpdated", + "listCreated", + "listUpdated", + "listDeleted", + "folderCreated", + "folderUpdated", + "folderDeleted", + "spaceCreated", + "spaceUpdated", + "spaceDeleted", + "goalCreated", + "goalUpdated", + "goalDeleted", + "keyResultCreated", + "keyResultUpdated", + "keyResultDeleted" + ], + "task_id": null, + "list_id": null, + "folder_id": null, + "space_id": null, + "health": { + "status": "active", + "fail_count": 0 + }, + "secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA" + } + } + ] + }, + "example": { + "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", + "webhook": { + "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", + "userid": 183, + "team_id": 108, + "endpoint": "https://yourdomain.com/webhook", + "client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO", + "events": [ + "taskCreated", + "taskUpdated", + "taskDeleted", + "taskPriorityUpdated", + "taskStatusUpdated", + "taskAssigneeUpdated", + "taskDueDateUpdated", + "taskTagUpdated", + "taskMoved", + "taskCommentPosted", + "taskCommentUpdated", + "taskTimeEstimateUpdated", + "taskTimeTrackedUpdated", + "listCreated", + "listUpdated", + "listDeleted", + "folderCreated", + "folderUpdated", + "folderDeleted", + "spaceCreated", + "spaceUpdated", + "spaceDeleted", + "goalCreated", + "goalUpdated", + "goalDeleted", + "keyResultCreated", + "keyResultUpdated", + "keyResultDeleted" + ], + "task_id": null, + "list_id": null, + "folder_id": null, + "space_id": null, + "health": { + "status": "active", + "fail_count": 0 + }, + "secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA" + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 6, + "x-moar-complexity-skipped": false + } + }, + "/v2/webhook/{webhook_id}": { + "parameters": [], + "put": { + "summary": "Update Webhook", + "tags": [ + "Webhooks" + ], + "description": "Update a webhook to change the events to be monitored.", + "operationId": "UpdateWebhook", + "parameters": [ + { + "name": "webhook_id", + "in": "path", + "description": "e506-4a29-9d42-26e504e3435e (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "4b67ac88" + ] + } + } + ], + "requestBody": { + "description": "To subscribe to specific events, pass an array of `events` that you want to subscribe to, or use the wildcard character `\"*\"` to subscribe to everything.\\\n \\\nIf you don't specify any events, all events will be sent to the webhook.", + "content": { + "application/json": { + "schema": { + "title": "UpdateWebhookrequest", + "required": [ + "endpoint", + "events", + "status" + ], + "type": "object", + "properties": { + "endpoint": { + "type": "string" + }, + "events": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "examples": [ + { + "endpoint": "https://yourdomain.com/webhook", + "events": "*", + "status": "active" + } + ] + }, + "example": { + "endpoint": "https://yourdomain.com/webhook", + "events": "*", + "status": "active" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "title": "UpdateWebhookresponse", + "required": [ + "id", + "webhook" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "webhook": { + "title": "Webhook", + "required": [ + "id", + "userid", + "team_id", + "endpoint", + "client_id", + "events", + "task_id", + "list_id", + "folder_id", + "space_id", + "health", + "secret" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "userid": { + "type": "integer", + "contentEncoding": "int32" + }, + "team_id": { + "type": "integer", + "contentEncoding": "int32" + }, + "endpoint": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "string" + }, + "description": "" + }, + "task_id": { + "type": [ + "string", + "null" + ] + }, + "list_id": { + "type": [ + "string", + "null" + ] + }, + "folder_id": { + "type": [ + "string", + "null" + ] + }, + "space_id": { + "type": [ + "string", + "null" + ] + }, + "health": { + "title": "Health", + "required": [ + "status", + "fail_count" + ], + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "fail_count": { + "type": "integer", + "contentEncoding": "int32" + } + }, + "examples": [ + { + "status": "active", + "fail_count": 0 + } + ] + }, + "secret": { + "type": "string" + } + }, + "examples": [ + { + "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", + "userid": 183, + "team_id": 108, + "endpoint": "https://yourdomain.com/webhook", + "client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO", + "events": [ + "taskCreated", + "taskUpdated", + "taskDeleted", + "taskPriorityUpdated", + "taskStatusUpdated", + "taskAssigneeUpdated", + "taskDueDateUpdated", + "taskTagUpdated", + "taskMoved", + "taskCommentPosted", + "taskCommentUpdated", + "taskTimeEstimateUpdated", + "taskTimeTrackedUpdated", + "listCreated", + "listUpdated", + "listDeleted", + "folderCreated", + "folderUpdated", + "folderDeleted", + "spaceCreated", + "spaceUpdated", + "spaceDeleted", + "goalCreated", + "goalUpdated", + "goalDeleted", + "keyResultCreated", + "keyResultUpdated", + "keyResultDeleted" + ], + "task_id": null, + "list_id": null, + "folder_id": null, + "space_id": null, + "health": { + "status": "active", + "fail_count": 0 + }, + "secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA" + } + ] + } + }, + "examples": [ + { + "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", + "webhook": { + "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", + "userid": 183, + "team_id": 108, + "endpoint": "https://yourdomain.com/webhook", + "client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO", + "events": [ + "taskCreated", + "taskUpdated", + "taskDeleted", + "taskPriorityUpdated", + "taskStatusUpdated", + "taskAssigneeUpdated", + "taskDueDateUpdated", + "taskTagUpdated", + "taskMoved", + "taskCommentPosted", + "taskCommentUpdated", + "taskTimeEstimateUpdated", + "taskTimeTrackedUpdated", + "listCreated", + "listUpdated", + "listDeleted", + "folderCreated", + "folderUpdated", + "folderDeleted", + "spaceCreated", + "spaceUpdated", + "spaceDeleted", + "goalCreated", + "goalUpdated", + "goalDeleted", + "keyResultCreated", + "keyResultUpdated", + "keyResultDeleted" + ], + "task_id": null, + "list_id": null, + "folder_id": null, + "space_id": null, + "health": { + "status": "active", + "fail_count": 0 + }, + "secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA" + } + } + ] + }, + "example": { + "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", + "webhook": { + "id": "4b67ac88-e506-4a29-9d42-26e504e3435e", + "userid": 183, + "team_id": 108, + "endpoint": "https://yourdomain.com/webhook", + "client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO", + "events": [ + "taskCreated", + "taskUpdated", + "taskDeleted", + "taskPriorityUpdated", + "taskStatusUpdated", + "taskAssigneeUpdated", + "taskDueDateUpdated", + "taskTagUpdated", + "taskMoved", + "taskCommentPosted", + "taskCommentUpdated", + "taskTimeEstimateUpdated", + "taskTimeTrackedUpdated", + "listCreated", + "listUpdated", + "listDeleted", + "folderCreated", + "folderUpdated", + "folderDeleted", + "spaceCreated", + "spaceUpdated", + "spaceDeleted", + "goalCreated", + "goalUpdated", + "goalDeleted", + "keyResultCreated", + "keyResultUpdated", + "keyResultDeleted" + ], + "task_id": null, + "list_id": null, + "folder_id": null, + "space_id": null, + "health": { + "status": "active", + "fail_count": 0 + }, + "secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA" + } + } + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 3, + "x-moar-complexity-skipped": false + }, + "delete": { + "summary": "Delete Webhook", + "tags": [ + "Webhooks" + ], + "description": "Delete a webhook to stop monitoring the events and locations of the webhook.", + "operationId": "DeleteWebhook", + "parameters": [ + { + "name": "webhook_id", + "in": "path", + "description": "e506-4a29-9d42-26e504e3435e (uuid)", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "examples": [ + "4b67ac88" + ] + } + } + ], + "responses": { + "200": { + "description": "", + "headers": {}, + "content": { + "application/json": { + "schema": { + "type": "object", + "examples": [ + {} + ], + "contentMediaType": "application/json" + }, + "example": {} + } + } + } + }, + "deprecated": false, + "x-moar-primitive-count": 0, + "x-moar-complexity-skipped": false + } + } + }, + "components": { + "securitySchemes": { + "Authorization_Token": { + "name": "Authorization", + "type": "apiKey", + "in": "header", + "description": "API token required for authentication. Two types of tokens are supported:\n**Personal API Key** Obtain from ClickUp's settings page under 'Apps' and add it to the header as `Authorization: pk_...`\n**OAuth2 Access Token** Generated through the OAuth2 flow and add it to the header as `Authorization: Bearer {access_token}`" + } + } + }, + "security": [ + { + "Authorization_Token": [] + } + ], + "tags": [ + { + "name": "Authorization" + }, + { + "name": "Attachments" + }, + { + "name": "Comments" + }, + { + "name": "Custom Task Types" + }, + { + "name": "Custom Fields" + }, + { + "name": "Folders" + }, + { + "name": "Goals" + }, + { + "name": "Guests" + }, + { + "name": "Lists" + }, + { + "name": "Members" + }, + { + "name": "Roles" + }, + { + "name": "Shared Hierarchy" + }, + { + "name": "Spaces" + }, + { + "name": "Tags" + }, + { + "name": "Tasks" + }, + { + "name": "Task Checklists" + }, + { + "name": "Task Relationships" + }, + { + "name": "Templates" + }, + { + "name": "Workspaces" + }, + { + "name": "User Groups" + }, + { + "name": "Time Tracking" + }, + { + "name": "Time Tracking (Legacy)" + }, + { + "name": "Users" + }, + { + "name": "Views" + }, + { + "name": "Webhooks" + } + ] +} diff --git a/toolkits/clickup_api/clickup_api/tools/__init__.py b/toolkits/clickup_api/clickup_api/tools/__init__.py new file mode 100644 index 00000000..42b8b45b --- /dev/null +++ b/toolkits/clickup_api/clickup_api/tools/__init__.py @@ -0,0 +1,7749 @@ +"""Arcade Starter Tools for Clickup + +DO NOT EDIT THIS MODULE DIRECTLY. + +THIS MODULE WAS AUTO-GENERATED BY TRANSPILING THE API STARTER TOOL JSON DEFINITIONS +IN THE ../wrapper_tools DIRECTORY INTO PYTHON CODE. ANY CHANGES TO THIS MODULE WILL +BE OVERWRITTEN BY THE TRANSPILER. +""" + +import asyncio +import json +from enum import Enum +from typing import Annotated, Any + +import httpx +import jsonschema +from arcade_tdk import ToolContext, tool +from arcade_tdk.auth import OAuth2 +from arcade_tdk.errors import RetryableToolError + +from .request_body_schemas import REQUEST_BODY_SCHEMAS + +# Retry configuration +INITIAL_RETRY_DELAY = 0.5 # seconds + +HTTP_CLIENT = httpx.AsyncClient( + timeout=httpx.Timeout(60.0, connect=10.0), + limits=httpx.Limits(max_keepalive_connections=20, max_connections=100), + transport=httpx.AsyncHTTPTransport(retries=3), + http2=True, + follow_redirects=True, +) + + +class ToolMode(str, Enum): + """Mode for tools with complex request bodies.""" + + GET_REQUEST_SCHEMA = "get_request_schema" + EXECUTE = "execute" + + +def remove_none_values(data: dict[str, Any]) -> dict[str, Any]: + return {k: v for k, v in data.items() if v is not None} + + +async def make_request( + url: str, + method: str, + params: dict[str, Any] | None = None, + headers: dict[str, Any] | None = None, + content: str | None = None, + data: dict[str, Any] | None = None, + auth: tuple[str, str] | None = None, + max_retries: int = 3, +) -> httpx.Response: + """Make an HTTP request with retry logic for 5xx server errors.""" + for attempt in range(max_retries): + try: + response = await HTTP_CLIENT.request( + url=url, + auth=auth, + method=method, + params=params, + headers=headers, + content=content, + ) + response.raise_for_status() + except httpx.HTTPStatusError as e: + # Only retry on 5xx server errors + if e.response.status_code >= 500 and attempt < max_retries - 1: + # Exponential backoff: 0.5s, 1s, 2s + await asyncio.sleep(INITIAL_RETRY_DELAY * (2**attempt)) + continue + # Re-raise for 4xx errors or if max retries reached + raise + except httpx.RequestError: + # Don't retry request errors (network issues are handled by transport) + raise + else: + return response + + # This should never be reached, but satisfies type checker + raise httpx.RequestError("Max retries exceeded") + + +async def make_request_with_schema_validation( + url: str, + method: str, + request_data: dict[str, Any], + schema: dict[str, Any] | str, + auth: tuple[str, str] | None = None, + params: dict[str, Any] | None = None, + headers: dict[str, Any] | None = None, + max_retries: int = 3, +) -> httpx.Response: + """Make an HTTP request with schema validation on format errors.""" + # Parse schema if it's a string, skip validation if parsing fails + parsed_schema = None + if isinstance(schema, str): + try: + parsed_schema = json.loads(schema) + except Exception: + # If schema parsing fails, just skip validation + parsed_schema = None + else: + parsed_schema = schema + + try: + response = await make_request( + url=url, + auth=auth, + method=method, + params=params, + headers=headers, + content=json.dumps(request_data), + max_retries=max_retries, + ) + except httpx.HTTPStatusError as e: + # Only provide schema validation for format-related errors + if e.response.status_code in (400, 422): + api_error_details = f"API returned {e.response.status_code}: {e.response.text}" + + # Only run validation if we have a valid parsed schema + if parsed_schema is not None: + # Run validation to provide additional context + is_valid, validation_error = validate_json_against_schema( + request_data, parsed_schema + ) + + if not is_valid: + # Schema validation found issues - additional context + additional_context = ( + f"{api_error_details}\n\n" + f"Schema validation found the following issues:\n" + f"{validation_error}" + ) + else: + # Schema validation passed - just show API error + additional_context = api_error_details + else: + # No valid schema - just show API error + additional_context = api_error_details + + raise RetryableToolError( + message=(f"API request failed with validation error: {e.response.status_code}"), + developer_message=api_error_details, + additional_prompt_content=additional_context, + ) from e + else: + # For non-validation errors, re-raise as-is + raise + else: + return response + + +def validate_json_against_schema( + json_data: dict[str, Any], schema: dict[str, Any] +) -> tuple[bool, str | None]: + """Validate JSON data against an OpenAPI/JSON Schema. + + This provides full JSON Schema Draft 7 validation including: + - Required fields, types, enums + - Pattern validation (regex) + - Format validation (email, uuid, date-time, etc.) + - Min/max length and values + - oneOf, anyOf, allOf + - And all other JSON Schema features + + Args: + json_data: The JSON data to validate + schema: The JSON Schema to validate against + + Returns: + Tuple of (is_valid, error_messages). If valid, error_messages is None. + If invalid, error_messages contains all validation errors. + """ + try: + validator = jsonschema.Draft7Validator( + schema, format_checker=jsonschema.Draft7Validator.FORMAT_CHECKER + ) + # Collect ALL validation errors + errors = list(validator.iter_errors(json_data)) + if errors: + # Format all errors with their paths + error_messages = [] + for error in errors: + error_path = ".".join(str(p) for p in error.path) if error.path else "root" + error_messages.append(f"{error.message} at {error_path}") + # Join all errors with newlines + return False, "\n".join(error_messages) + else: + return True, None + except jsonschema.SchemaError as e: + return False, f"Invalid schema: {e.message}" + except Exception as e: + return False, f"Validation error: {e!s}" + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_clickup_access_token( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetAccessToken'."]: + """Obtain an OAuth access token for ClickUp API authentication. + + Use this tool to obtain an OAuth access token for authenticating applications with the ClickUp API. This tool is not for personal API tokens and does not support the 'Try It' feature in browser-based API documentation. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["GETCLICKUPACCESSTOKEN"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["GETCLICKUPACCESSTOKEN"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["GETCLICKUPACCESSTOKEN"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/oauth/token", + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["GETCLICKUPACCESSTOKEN"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_clickup_user_details( + context: ToolContext, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetAuthorizedUser'."]: + """Get details of the authenticated ClickUp user's account.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/user", + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_authorized_teams( + context: ToolContext, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetAuthorizedTeams'."]: + """Retrieve the workspaces for the authenticated user. + + Use this tool to get a list of workspaces (teams) available to the user who is currently authenticated. It provides an overview of the user's accessible workspaces in ClickUp.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team", + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_checklist_to_task( + context: ToolContext, + checklist_name: Annotated[ + str, + "The name or title of the checklist to be added to the task. It should be a descriptive string identifying the purpose or contents of the checklist.", + ], + task_identifier: Annotated[ + str, + "A unique identifier for the task to which the checklist will be added. It can be a custom or default task ID.", + ], + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id_for_custom_task: Annotated[ + int | None, + "Provide the Workspace ID when 'custom_task_ids' is set to true. It's necessary to reference tasks by custom IDs.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateChecklist'."]: + """Add a new checklist to a task in ClickUp. + + Use this tool to add a checklist to a specific task in ClickUp by providing the task ID.""" + request_data: Any = {"name": checklist_name} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/checklist".format( # noqa: UP032 + task_id=task_identifier + ), + method="POST", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_for_custom_task, + }), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def edit_checklist( + context: ToolContext, + checklist_id: Annotated[ + str, "The unique identifier (UUID) of the checklist to be edited or reordered." + ], + checklist_name: Annotated[ + str | None, "The new name for the checklist. Leave empty if you do not wish to rename." + ] = None, + checklist_position: Annotated[ + int | None, + "Specify the order in which the checklist should appear on a task. Use 0 to place it at the top.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'EditChecklist'."]: + """Rename or reorder a task checklist in ClickUp. + + Use this tool to rename a checklist or change its order within a task in ClickUp. It is suitable when you need to update the checklist name or adjust its position in relation to other checklists in a specific task.""" + request_data: Any = {"name": checklist_name, "position": checklist_position} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/checklist/{checklist_id}".format( # noqa: UP032 + checklist_id=checklist_id + ), + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_checklist( + context: ToolContext, + checklist_id: Annotated[ + str, "The unique identifier for the checklist to be deleted. It should be in UUID format." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteChecklist'."]: + """Deletes a checklist from a task in ClickUp. + + Use this tool to delete a specific checklist from a task in ClickUp by providing the checklist ID. Ideal for when you need to manage or reorganize task checklists.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/checklist/{checklist_id}".format( # noqa: UP032 + checklist_id=checklist_id + ), + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_checklist_item_clickup( + context: ToolContext, + checklist_identifier: Annotated[ + str, "A unique identifier for the checklist. Must be in UUID format." + ], + assignee_user_id: Annotated[ + int | None, + "The unique ID of the user assigned to the checklist item. This should be an integer value representing the user's ID.", + ] = None, + checklist_item_name: Annotated[ + str | None, + "The name of the checklist item to be added. This should clearly describe the task or item to be completed.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateChecklistItem'."]: + """Add an item to a checklist in ClickUp tasks. + + Use this tool to add a new line item to an existing checklist within a task in ClickUp. This can be useful for task management and ensuring all steps are documented within a checklist.""" + request_data: Any = {"name": checklist_item_name, "assignee": assignee_user_id} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/checklist/{checklist_id}/checklist_item".format( # noqa: UP032 + checklist_id=checklist_identifier + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_checklist_item( + context: ToolContext, + checklist_item_uuid: Annotated[str, "The UUID for the specific checklist item to be updated."], + checklist_unique_identifier: Annotated[ + str, "The UUID of the checklist to update. Example: b8a8-48d8-a0c6-b4200788a683." + ], + assign_item_to_user: Annotated[ + str | None, + "The user ID to which the checklist item will be assigned. This should be a string representing a valid user identifier in ClickUp.", + ] = None, + checklist_item_name: Annotated[ + str | None, "The new name for the checklist item. Provide a string to rename the item." + ] = None, + mark_as_resolved: Annotated[ + bool | None, "Boolean to mark the checklist item as resolved (true) or unresolved (false)." + ] = None, + parent_checklist_item_id: Annotated[ + str | None, "Include another item's `checklist_item_id` to nest this item under it." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'EditChecklistItem'."]: + """Modify or update a specific task checklist item. + + This tool updates an individual line item in a task checklist. It can rename the item, set the assignee, mark it as resolved, or nest it under another item.""" + request_data: Any = { + "name": checklist_item_name, + "assignee": assign_item_to_user, + "resolved": mark_as_resolved, + "parent": parent_checklist_item_id, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}".format( # noqa: UP032 + checklist_id=checklist_unique_identifier, checklist_item_id=checklist_item_uuid + ), + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_task_checklist_item( + context: ToolContext, + checklist_identifier: Annotated[ + str, + "The unique identifier (UUID) for the checklist. Used to specify the checklist from which the item will be deleted.", + ], + checklist_item_uuid: Annotated[ + str, "The unique identifier (UUID) of the checklist item to be deleted." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteChecklistItem'."]: + """Delete an item from a task checklist in ClickUp. + + Use this tool to delete a specific line item from a checklist associated with a task. Ideal for managing and updating task checklists by removing unnecessary or completed items.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}".format( # noqa: UP032 + checklist_id=checklist_identifier, checklist_item_id=checklist_item_uuid + ), + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_task_comments( + context: ToolContext, + task_identifier: Annotated[ + str, "Specify the unique identifier of the task whose comments you want to retrieve." + ], + comment_date_unix_time_ms: Annotated[ + int | None, + "Specify the date of a task comment using Unix time in milliseconds for pagination.", + ] = None, + comment_start_id: Annotated[ + str | None, "The ID of the earliest comment to start retrieving from, used for pagination." + ] = None, + use_custom_task_ids: Annotated[ + bool | None, "Set to `true` if you want to reference a task by its custom task ID." + ] = None, + workspace_id_for_custom_task: Annotated[ + int | None, + "Provide the Workspace ID when using a custom task ID (requires `custom_task_ids` to be true).", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetTaskComments'."]: + """Retrieve comments from a specified task in ClickUp. + + Use this tool to view comments on a specific task within ClickUp. If no 'start' and 'start_id' parameters are provided, it will return the latest 25 comments. Provide 'start' and 'start_id' to paginate through older comments.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/comment".format(task_id=task_identifier), # noqa: UP032 + method="GET", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_for_custom_task, + "start": comment_date_unix_time_ms, + "start_id": comment_start_id, + }), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_task_comment( + context: ToolContext, + comment_content: Annotated[ + str, + "The text of the comment to be added to the task. It should contain any updates, feedback, or relevant information.", + ], + send_notifications_to_all: Annotated[ + bool, + "If true, notifications will be sent to everyone, including the creator of the comment.", + ], + specific_task_id: Annotated[ + str, "The ID of the task to add the comment to. Required for identifying the target task." + ], + assignee_group: Annotated[ + str | None, + "Specifies a group of users (as a comma-separated string) to be assigned to the comment. Ensure the group is relevant to the task.", + ] = None, + comment_assignee_id: Annotated[ + int | None, + "An integer representing the user ID of the assignee for the comment on the task.", + ] = None, + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id_for_custom_task: Annotated[ + int | None, + "Provide the Workspace ID when referencing a task by its custom task ID (set `custom_task_ids` to true).", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateTaskComment'."]: + """Add a new comment to a specific task on ClickUp. + + This tool allows users to add a new comment to a specified task on ClickUp. It should be called when there's a need to comment on a task, offering a way to communicate updates, feedback, or any relevant information directly related to the task in question.""" + request_data: Any = { + "comment_text": comment_content, + "assignee": comment_assignee_id, + "group_assignee": assignee_group, + "notify_all": send_notifications_to_all, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/comment".format( # noqa: UP032 + task_id=specific_task_id + ), + method="POST", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_for_custom_task, + }), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_chat_comments( + context: ToolContext, + chat_view_id: Annotated[ + str, + "The unique identifier for the Chat view to retrieve comments from. It should be a string, typically '105'.", + ], + comment_start_date_unix_ms: Annotated[ + int | None, + "The start date of a Chat view comment in Unix time (milliseconds) to fetch older comments.", + ] = None, + start_comment_id: Annotated[ + str | None, + "The comment ID to start retrieving older comments from in the Chat view. Use this to fetch comments beyond the most recent 25.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetChatViewComments'."]: + """Retrieve the most recent comments from a Chat view. + + This tool fetches comments from a Chat view in ClickUp. It returns the 25 most recent comments if no parameters are provided. To access older comments, use `start` and `start_id` parameters.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/view/{view_id}/comment".format(view_id=chat_view_id), # noqa: UP032 + method="GET", + params=remove_none_values({ + "start": comment_start_date_unix_ms, + "start_id": start_comment_id, + }), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_chat_view_comment( + context: ToolContext, + comment_text: Annotated[str, "The text content of the comment to be added to the Chat view."], + send_notifications_to_all: Annotated[ + bool, "Set to true to send notifications to everyone, including the comment creator." + ], + view_id: Annotated[ + str, "The ID of the Chat view where the comment will be added. Expected as a string." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateChatViewComment'."]: + """Add a new comment to a Chat view. + + Use this tool to add a comment to a Chat view in ClickUp. This can be used to facilitate discussion and share information in a specific View context.""" + request_data: Any = {"comment_text": comment_text, "notify_all": send_notifications_to_all} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/view/{view_id}/comment".format(view_id=view_id), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_list_comments( + context: ToolContext, + list_id: Annotated[ + int, + "The unique integer identifier of the ClickUp list for which comments are being retrieved.", + ], + oldest_comment_id: Annotated[ + str | None, "ID of the oldest comment to start retrieving additional comments from." + ] = None, + start_date_unix_millis: Annotated[ + int | None, + "Enter the date of a list info comment using Unix time in milliseconds to retrieve comments starting from this timestamp.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetListComments'."]: + """View comments from a specific ClickUp list. + + Use this tool to retrieve the most recent comments from a specified ClickUp list. It returns up to 25 comments by default. To fetch older comments, utilize the optional parameters `start` and `start_id`.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}/comment".format(list_id=list_id), # noqa: UP032 + method="GET", + params=remove_none_values({"start": start_date_unix_millis, "start_id": oldest_comment_id}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_comment_to_list( + context: ToolContext, + assignee_id: Annotated[ + int, + "The ID of the user to whom the comment is assigned. This should be an integer value representing the user's unique identifier.", + ], + comment_text: Annotated[ + str, + "The text of the comment to be added to the list. This should contain the message or information you wish to convey.", + ], + list_identifier: Annotated[int, "The unique ID of the list where the comment will be added."], + notify_all: Annotated[ + bool, "If true, notifications are sent to everyone, including the comment creator." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateListComment'."]: + """Add a comment to a specific list in ClickUp. + + This tool allows you to add a comment to a specified list in ClickUp. Use it when you need to provide additional information or feedback on a list.""" + request_data: Any = { + "comment_text": comment_text, + "assignee": assignee_id, + "notify_all": notify_all, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}/comment".format(list_id=list_identifier), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_task_comment( + context: ToolContext, + assignee_user_id: Annotated[ + int, + "The ID of the user to assign the comment to. This should be a numeric user ID in ClickUp.", + ], + comment_identifier: Annotated[ + int, "The unique identifier of the comment to update. It must be an integer." + ], + mark_comment_as_resolved: Annotated[ + bool, + "Set to true to mark the comment as resolved; false to leave it unresolved. Accepts a boolean value.", + ], + new_comment_content: Annotated[ + str, "The new content for the task comment. This will replace the existing comment text." + ], + assign_to_group: Annotated[ + int | None, "Assign the comment to a group by providing the group's ID." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'UpdateComment'."]: + """Update a task comment in ClickUp. + + Use this tool to replace a task comment's content, assign it, or mark it as resolved in ClickUp.""" + request_data: Any = { + "comment_text": new_comment_content, + "assignee": assignee_user_id, + "group_assignee": assign_to_group, + "resolved": mark_comment_as_resolved, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/comment/{comment_id}".format( # noqa: UP032 + comment_id=comment_identifier + ), + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_task_comment( + context: ToolContext, + comment_id: Annotated[int, "The unique integer identifier of the comment to be deleted."], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteComment'."]: + """Delete a comment from a task. + + Use this tool to delete a specific comment from a task. It should be called when you need to remove a comment based on its unique identifier.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/comment/{comment_id}".format(comment_id=comment_id), # noqa: UP032 + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_threaded_comments( + context: ToolContext, + thread_comment_id: Annotated[ + int, + "The ID of the comment for which threaded replies are to be retrieved. This ID should be an integer and corresponds to the comment in a ClickUp task whose replies you want to view.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetThreadedComments'."]: + """Retrieve threaded replies to a comment. + + This tool allows for the retrieval of threaded comments in a ClickUp task, excluding the parent comment. Use this tool to view discussions or replies linked to a specific comment by providing the comment ID.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/comment/{comment_id}/reply".format( # noqa: UP032 + comment_id=thread_comment_id + ), + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_threaded_comment( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + parent_comment_id: Annotated[ + int | None, + "The ID of the parent comment to which the threaded reply will be attached. It should be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateThreadedComment'."]: + """Create a threaded comment in a ClickUp task. + + This tool is used to create a threaded comment as a reply to an existing comment in a ClickUp task. It is useful when you want to continue a discussion or provide additional information to a specific comment thread. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["CREATETHREADEDCOMMENT"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not parent_comment_id: + missing_params.append(("parent_comment_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATETHREADEDCOMMENT"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATETHREADEDCOMMENT"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/comment/{comment_id}/reply".format( # noqa: UP032 + comment_id=parent_comment_id + ), + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["CREATETHREADEDCOMMENT"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_list_custom_fields( + context: ToolContext, + content_type: Annotated[ + str, "The MIME type of the request body, typically set to 'application/json'." + ], + list_id: Annotated[ + int, "The unique identifier of the list to retrieve accessible custom fields for." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetAccessibleCustomFields'."]: + """Retrieve accessible custom fields for a specific list. + + Use this tool to view the custom fields you have access to in a specific list. This is useful for understanding which custom fields are available for use or modification in your lists.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}/field".format(list_id=list_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": content_type, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_folder_custom_fields( + context: ToolContext, + content_type: Annotated[ + str, "The MIME type of the content being sent. Typically, use 'application/json'." + ], + folder_id: Annotated[ + int, + "The unique identifier of the folder to retrieve custom fields from. Must be an integer corresponding to a specific folder in ClickUp.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'getFolderAvailableFields'."]: + """Retrieve accessible custom fields from a folder in ClickUp. + + This tool retrieves the custom fields that are accessible at the folder level in ClickUp. It's useful when you need to know what folder-level custom fields are available for a specific folder. Custom fields created at the list level aren't included.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/folder/{folder_id}/field".format(folder_id=folder_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": content_type, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_space_custom_fields( + context: ToolContext, + content_type_header: Annotated[ + str, "The MIME type for the request header, typically 'application/json'." + ], + space_identifier: Annotated[ + int, + "The unique identifier for the ClickUp space from which to fetch available custom fields. It should be an integer.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'getSpaceAvailableFields'."]: + """Retrieve custom fields accessible in a specific ClickUp space. + + This tool retrieves the custom fields available to you in a specified ClickUp space. It returns only the custom fields created at the space level, excluding those at the folder and list levels.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/space/{space_id}/field".format( # noqa: UP032 + space_id=space_identifier + ), + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_workspace_custom_fields( + context: ToolContext, + content_type_header: Annotated[ + str, "The MIME type of the content. Typically set to 'application/json' for JSON data." + ], + workspace_id: Annotated[ + int, + "The ID of the Workspace to retrieve custom fields for. This identifies which Workspace's fields you want to view.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'getTeamAvailableFields'."]: + """Retrieve Workspace-level Custom Fields in ClickUp. + + Use this tool to view custom fields accessible at the workspace level in ClickUp. It doesn't include fields from Space, Folder, or List levels.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/field".format(team_id=workspace_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_task_custom_field( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + task_id: Annotated[ + str | None, + "The ID of the task to be updated with new custom field data. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + custom_field_uuid: Annotated[ + str | None, + "The UUID of the custom field to update for a specific task. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + workspace_id: Annotated[ + int | None, + "Provide the Workspace ID when referencing a task by its Custom Task ID (`custom_task_ids` must be true). Only used when mode is 'execute'.", + ] = None, + use_custom_task_id_reference: Annotated[ + bool | None, + "Set to `true` to reference a task using its Custom Task ID. Only used when mode is 'execute'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'SetCustomFieldValue'."]: + """Update a custom field value for a specific task in ClickUp. + + Use this tool to add data to a custom field on a task. Requires the `task_id` of the task and the `field_id` of the custom field. Retrieve `field_id` using the 'Get Accessible Custom Fields' or 'Get Task' endpoints. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path, query parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path, query parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["UPDATETASKCUSTOMFIELD"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path, query parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not task_id: + missing_params.append(("task_id", "path")) + if not custom_field_uuid: + missing_params.append(("custom_field_uuid", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["UPDATETASKCUSTOMFIELD"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["UPDATETASKCUSTOMFIELD"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/task/{task_id}/field/{field_id}".format( # noqa: UP032 + task_id=task_id, field_id=custom_field_uuid + ), + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["UPDATETASKCUSTOMFIELD"], + params=remove_none_values({ + "custom_task_ids": use_custom_task_id_reference, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_custom_field_value( + context: ToolContext, + custom_field_id: Annotated[ + str, + "UUID of the custom field to be removed from the task. Example: b8a8-48d8-a0c6-b4200788a683", + ], + task_identifier: Annotated[ + str, + "The unique identifier of the task from which you want to remove the custom field value.", + ], + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id: Annotated[ + int | None, "Provide the Workspace ID when referencing a task by custom task id." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'RemoveCustomFieldValue'."]: + """Remove a custom field value from a ClickUp task. + + Use this tool to remove the data from a custom field on a ClickUp task without deleting the field option itself.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/field/{field_id}".format( # noqa: UP032 + task_id=task_identifier, field_id=custom_field_id + ), + method="DELETE", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def set_task_dependency( + context: ToolContext, + task_id_of_dependency: Annotated[ + str, "The ID of the task that is waiting on or blocking another task." + ], + dependent_task_id: Annotated[ + str | None, + "The ID of the task that the specified task depends on or is blocking. This establishes the task dependency relationship.", + ] = None, + depends_on_task_id: Annotated[ + str | None, + "Specify the task ID that this task depends on or is blocked by. It should be a valid task ID in ClickUp.", + ] = None, + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id: Annotated[ + int | None, + "Provide the Workspace ID when `custom_task_ids` is true. Necessary for task identification.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'AddDependency'."]: + """Set a task as waiting on or blocking another task. + + Use this tool to establish a dependency between tasks in ClickUp, either setting a task as waiting on another or as blocking one.""" + request_data: Any = {"depends_on": depends_on_task_id, "depedency_of": dependent_task_id} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/dependency".format( # noqa: UP032 + task_id=task_id_of_dependency + ), + method="POST", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_task_dependency( + context: ToolContext, + dependent_task_id: Annotated[ + str, "The task ID that is dependent on another. Provide a valid task ID as a string." + ], + depends_on_task_id: Annotated[ + str, + "The ID of the task that another task depends on. Provide a valid task ID to specify the dependent task.", + ], + task_id_to_remove_dependency: Annotated[ + str, + "Specify the task ID from which the dependency is to be removed. This is required to identify the task involved in the dependency relationship.", + ], + use_custom_task_ids: Annotated[ + bool | None, "Set to true if referencing tasks by their custom task IDs is desired." + ] = None, + workspace_id: Annotated[ + int | None, + "Provide the Workspace ID when using custom task IDs by setting `custom_task_ids` to `true`.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteDependency'."]: + """Remove a dependency relationship between tasks. + + This tool is used to remove the dependency relationship between two or more tasks in ClickUp. Call this when two tasks that are currently dependent on one another need to be independent.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/dependency".format( # noqa: UP032 + task_id=task_id_to_remove_dependency + ), + method="DELETE", + params=remove_none_values({ + "depends_on": depends_on_task_id, + "dependency_of": dependent_task_id, + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def link_tasks_clickup( + context: ToolContext, + source_task_id: Annotated[str, "The ID of the task from which the link will be initiated."], + task_to_link_to: Annotated[str, "The ID of the task to link to the initiating task."], + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id_for_custom_task: Annotated[ + int | None, + "Provide the Workspace ID if referencing a task by custom task id (when custom_task_ids is true).", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'AddTaskLink'."]: + """Link two ClickUp tasks together. + + This tool allows you to link two tasks in ClickUp via the Task Links feature in the right-hand sidebar of a task. It should be called when you need to associate tasks directly, but does not support linking to other types of objects.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/link/{links_to}".format( # noqa: UP032 + task_id=source_task_id, links_to=task_to_link_to + ), + method="POST", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_for_custom_task, + }), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_task_link( + context: ToolContext, + linked_task_id: Annotated[ + str, + "The task ID of the task to which the original task is linked. This specifies the connection to be removed.", + ], + primary_task_id: Annotated[ + str, + "The ID of the primary task from which to remove the link. This is required to identify the task.", + ], + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id: Annotated[ + int | None, "Provide the Workspace ID when `custom_task_ids` is set to `true`." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteTaskLink'."]: + """Remove the link between two tasks. + + Use this tool to delete an existing link between two tasks in ClickUp. It is helpful when you need to unlink tasks that are no longer related.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/link/{links_to}".format( # noqa: UP032 + task_id=primary_task_id, links_to=linked_task_id + ), + method="DELETE", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_space_folders( + context: ToolContext, + space_id: Annotated[ + int, + "The unique identifier of the space from which to retrieve folders. This is required to specify which space's folders are being requested.", + ], + include_archived_folders: Annotated[ + bool | None, "Set to true to include archived folders in the results." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetFolders'."]: + """Retrieve a list of folders from a specified space. + + Use this tool to view folders within a specific space in ClickUp. It is useful when you need to access or manage the folders in a particular workspace.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/space/{space_id}/folder".format(space_id=space_id), # noqa: UP032 + method="GET", + params=remove_none_values({"archived": include_archived_folders}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_folder_in_space( + context: ToolContext, + folder_name: Annotated[ + str, + "The name of the new folder to be created in the specified space. It should be a string representing the folder's title.", + ], + space_id: Annotated[ + int, + "The unique identifier for the ClickUp Space where the folder will be created. It should be an integer.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateFolder'."]: + """Add a new Folder to a Space in ClickUp. + + This tool allows you to create a new folder within a specified space in ClickUp. Use it when you need to organize tasks or projects into a new folder under an existing space.""" + request_data: Any = {"name": folder_name} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/space/{space_id}/folder".format(space_id=space_id), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_folder_lists( + context: ToolContext, + folder_id: Annotated[ + int, + "The unique identifier for the folder whose lists you want to retrieve. This must be an integer.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetFolder'."]: + """Retrieve lists contained in a specified folder. + + Call this tool to access all the lists that are organized under a specific folder in ClickUp by providing the folder ID.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/folder/{folder_id}".format(folder_id=folder_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def rename_clickup_folder( + context: ToolContext, + folder_id_clickup: Annotated[ + int, "The unique identifier for the ClickUp folder you wish to rename." + ], + new_folder_name: Annotated[ + str, + "Specify the new name for the folder. This is the name that the folder will be renamed to in ClickUp.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'UpdateFolder'."]: + """Rename a folder in ClickUp. + + Use this tool to update the name of a folder in ClickUp by specifying the folder ID and the new name.""" + request_data: Any = {"name": new_folder_name} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/folder/{folder_id}".format(folder_id=folder_id_clickup), # noqa: UP032 + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_workspace_folder( + context: ToolContext, + folder_id: Annotated[ + int, + "The unique ID of the folder to be deleted from your ClickUp workspace. Ensure this ID is correct to avoid unintended deletions.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteFolder'."]: + """Delete a folder from your ClickUp workspace. + + Use this tool to permanently delete a specific folder from your ClickUp workspace. Ensure you have the correct folder ID before performing this action.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/folder/{folder_id}".format(folder_id=folder_id), # noqa: UP032 + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_workspace_goals( + context: ToolContext, + workspace_id: Annotated[int, "The unique identifier for the workspace to view its goals."], + include_completed_goals: Annotated[ + bool | None, + "Indicate whether to include completed goals in the results. Set to true to include completed goals, or false to exclude them.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetGoals'."]: + """View the Goals available in a Workspace. + + This tool retrieves the goals available in a specific workspace on ClickUp. It should be used when you need to access or display information about the goals associated with a given workspace.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/goal".format(team_id=workspace_id), # noqa: UP032 + method="GET", + params=remove_none_values({"include_completed": include_completed_goals}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_workspace_goal( + context: ToolContext, + allow_multiple_owners: Annotated[ + bool, "Set to true to allow a goal to have multiple owners, or false for a single owner." + ], + due_date_timestamp: Annotated[ + int, + "The due date for the goal as a Unix timestamp in milliseconds. Represents when the goal should be completed.", + ], + goal_color: Annotated[ + str, + "The color code for the goal. Expected to be a string representing a color, such as a hex code like '#FF5733'.", + ], + goal_description: Annotated[ + str, "A brief explanation of the goal to be added, providing context and details." + ], + goal_name: Annotated[str, "The name or title of the goal to be added to the workspace."], + goal_owners: Annotated[ + list[int], "Array of user IDs for those assigned to own the goal, allowing multiple owners." + ], + workspace_id: Annotated[ + int, "The ID of the workspace where the goal will be added. This is a numeric value." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateGoal'."]: + """Add a new goal to a specified workspace. + + This tool allows you to create a new goal in a specific workspace by providing the necessary details. Use it to set objectives and track progress within teams.""" + request_data: Any = { + "name": goal_name, + "due_date": due_date_timestamp, + "description": goal_description, + "multiple_owners": allow_multiple_owners, + "owners": goal_owners, + "color": goal_color, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/goal".format(team_id=workspace_id), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_goal_details( + context: ToolContext, + goal_identifier: Annotated[ + str, "The unique identifier (UUID) for the goal to retrieve details and targets." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetGoal'."]: + """Retrieve detailed information about a specific goal including its targets.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/goal/{goal_id}".format(goal_id=goal_identifier), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_goal_details( + context: ToolContext, + goal_color: Annotated[ + str, + "Set the color of the goal. Accepts a string representing the color, such as a hex code.", + ], + goal_description: Annotated[ + str, + "The new description for the goal. This should provide an overview or details of the goal's purpose.", + ], + goal_due_date: Annotated[ + int, + "An integer representing the new due date for the goal, usually in Unix timestamp format.", + ], + goal_id: Annotated[str, "The unique identifier for the goal to be updated. This is a UUID."], + goal_name: Annotated[ + str, "The new name for the goal. This will replace the current goal name." + ], + new_owners_to_add: Annotated[list[int], "List of user IDs to add as new owners for the goal."], + remove_owners_user_ids: Annotated[ + list[int], "Array of user IDs to be removed as owners of the goal." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'UpdateGoal'."]: + """Update goal details such as name, due date, and owners. + + Use this tool to rename a goal, set its due date, update its description, manage owners, or change its color in ClickUp.""" + request_data: Any = { + "name": goal_name, + "due_date": goal_due_date, + "description": goal_description, + "rem_owners": remove_owners_user_ids, + "add_owners": new_owners_to_add, + "color": goal_color, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/goal/{goal_id}".format(goal_id=goal_id), # noqa: UP032 + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_goal( + context: ToolContext, + content_type_header: Annotated[ + str, "Specify the Content-Type header. Typically set to 'application/json'." + ], + goal_identifier: Annotated[ + str, "The unique identifier for the goal to be deleted. It must be a valid UUID." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteGoal'."]: + """Deletes a goal from your workspace in ClickUp. + + Use this tool to remove a specified goal from your ClickUp workspace by providing the goal ID.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/goal/{goal_id}".format(goal_id=goal_identifier), # noqa: UP032 + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_target_to_goal( + context: ToolContext, + goal_identifier: Annotated[ + str, "The unique identifier (UUID) of the goal to which the target will be added." + ], + initial_value_steps: Annotated[ + int, "Specify the starting value for the target's progress steps, as an integer." + ], + linked_task_ids: Annotated[ + list[str], "An array of task IDs to associate the target with tasks." + ], + list_ids: Annotated[ + list[str], "Array of List IDs to associate the target with multiple Lists." + ], + target_name: Annotated[ + str, + "Specify the name for the target being added to the goal. It should be a descriptive label for easy identification.", + ], + target_owners_ids: Annotated[ + list[int], "An array of user IDs representing the owners of the key result target." + ], + target_steps_end: Annotated[ + int, + "Specify the final value for the target steps. It indicates the goal completion threshold.", + ], + target_type: Annotated[ + str, + "Specify the type of target (key result) as one of the following: `number`, `currency`, `boolean`, `percentage`, or `automatic`.", + ], + target_unit: Annotated[ + str, "Specify the unit for the target if using types like number, currency, or percentage." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateKeyResult'."]: + """Add a target to a specific goal in ClickUp. + + Use this tool to add a key result target to an existing goal in ClickUp, enhancing goal tracking and achievement.""" + request_data: Any = { + "name": target_name, + "owners": target_owners_ids, + "type": target_type, + "steps_start": initial_value_steps, + "steps_end": target_steps_end, + "unit": target_unit, + "task_ids": linked_task_ids, + "list_ids": list_ids, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/goal/{goal_id}/key_result".format( # noqa: UP032 + goal_id=goal_identifier + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_key_result_target( + context: ToolContext, + current_steps_value: Annotated[ + int, + "The current number of steps completed for the key result target. Provide an integer value.", + ], + key_result_identifier: Annotated[ + str, "Unique identifier for the key result to be updated, provided as a UUID." + ], + note_update_description: Annotated[ + str, + "Text for the note associated with the key result. Use to add or update content related to the key result.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'EditKeyResult'."]: + """Update the target of a specific key result. + + Use this tool to update the target value of a specified key result. It should be called when there's a need to modify the target associated with a key result in ClickUp.""" + request_data: Any = {"steps_current": current_steps_value, "note": note_update_description} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/key_result/{key_result_id}".format( # noqa: UP032 + key_result_id=key_result_identifier + ), + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_goal_target( + context: ToolContext, + goal_target_id: Annotated[ + str, "The unique identifier (UUID) of the key result to delete from the goal in ClickUp." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteKeyResult'."]: + """Delete a target from a goal in ClickUp. + + Use this tool to delete a key result (target) from a goal in ClickUp when a specific target needs to be removed.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/key_result/{key_result_id}".format( # noqa: UP032 + key_result_id=goal_target_id + ), + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def invite_guest_to_workspace( + context: ToolContext, + guest_email: Annotated[ + str, + "The email address of the guest to be invited to the workspace. Ensure it is correctly formatted.", + ], + workspace_id: Annotated[ + int, "The integer ID of the Workspace to which the guest will be invited." + ], + allow_guest_to_create_views: Annotated[ + bool | None, + "Indicates if the guest can create views in the workspace. Accepts a boolean value.", + ] = None, + allow_tag_editing: Annotated[ + bool | None, "Set to true if the guest should be allowed to edit tags in the workspace." + ] = None, + allow_view_time_spent: Annotated[ + bool | None, + "Allow the guest to view time spent in the workspace. Accepts a boolean value: true to allow, false to deny.", + ] = None, + can_view_estimated_times: Annotated[ + bool | None, "Set to true to allow the guest to view estimated times for tasks." + ] = None, + can_view_points_estimated: Annotated[ + bool | None, "Set to true to allow the guest to view estimated points for tasks." + ] = None, + custom_role_id: Annotated[ + int | None, "The ID of the custom role to assign to the guest. Must be an integer value." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'InviteGuestToWorkspace'."]: + """Invite a guest to join a ClickUp workspace. + + This tool is used to invite a guest to a ClickUp workspace on an Enterprise Plan. Ensure the guest has access to specific items in the workspace using additional endpoints.""" + request_data: Any = { + "email": guest_email, + "can_edit_tags": allow_tag_editing, + "can_see_time_spent": allow_view_time_spent, + "can_see_time_estimated": can_view_estimated_times, + "can_create_views": allow_guest_to_create_views, + "can_see_points_estimated": can_view_points_estimated, + "custom_role_id": custom_role_id, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/guest".format(team_id=workspace_id), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_guest_information( + context: ToolContext, + guest_identifier: Annotated[ + int, + "An integer representing the unique ID of the guest whose information is to be retrieved.", + ], + workspace_id: Annotated[ + int, + "The ID of the ClickUp workspace. This is required for identifying the specific workspace where the guest information is being retrieved.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetGuest'."]: + """Retrieve information about a guest in a workspace. + + This tool is used to view details about a guest in a ClickUp workspace. It is available only for Workspaces on the Enterprise Plan. Use it when you need to obtain guest-related information, such as profile or access details.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/guest/{guest_id}".format( # noqa: UP032 + team_id=workspace_id, guest_id=guest_identifier + ), + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def configure_workspace_guest( + context: ToolContext, + guest_identifier: Annotated[ + int, "The unique identifier for the guest to be configured in the workspace." + ], + workspace_id: Annotated[ + int, + "The unique identifier for the ClickUp workspace where the guest is being configured. This is required for identifying the specific workspace.", + ], + allow_guest_to_edit_tags: Annotated[ + bool | None, + "Set to true to allow the guest to edit tags in the workspace; false to disallow.", + ] = None, + allow_view_creation: Annotated[ + bool | None, + "A boolean to specify if the guest can create views. True allows view creation, false denies it.", + ] = None, + allow_viewing_points_estimated: Annotated[ + bool | None, + "Specify if the guest can view estimated points in the workspace. True allows viewing; false restricts it.", + ] = None, + allow_viewing_time_spent: Annotated[ + bool | None, + "Set to true to allow the guest to view time spent on tasks, false to restrict.", + ] = None, + can_see_time_estimates: Annotated[ + bool | None, + "Determines if the guest can view time estimates. Use true to allow, false to restrict.", + ] = None, + guest_custom_role_id: Annotated[ + int | None, + "An integer representing the custom role ID assigned to the guest in the workspace.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'EditGuestOnWorkspace'."]: + """Configure options for a guest in a workspace. + + This tool adjusts settings for a guest in a ClickUp workspace, specifically for teams on the Enterprise Plan.""" + request_data: Any = { + "can_see_points_estimated": allow_viewing_points_estimated, + "can_edit_tags": allow_guest_to_edit_tags, + "can_see_time_spent": allow_viewing_time_spent, + "can_see_time_estimated": can_see_time_estimates, + "can_create_views": allow_view_creation, + "custom_role_id": guest_custom_role_id, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/guest/{guest_id}".format( # noqa: UP032 + team_id=workspace_id, guest_id=guest_identifier + ), + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_guest_from_workspace( + context: ToolContext, + guest_id: Annotated[ + int, + "The unique identifier for the guest to be removed from the workspace. This should be an integer value.", + ], + workspace_id: Annotated[ + int, + "The unique ID of the ClickUp workspace from which the guest will be removed. This is an integer.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'RemoveGuestFromWorkspace'."]: + """Revoke a guest's access to a ClickUp workspace. + + Remove a guest from a ClickUp workspace. Available only for Workspaces on the Enterprise Plan.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/guest/{guest_id}".format( # noqa: UP032 + team_id=workspace_id, guest_id=guest_id + ), + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def share_task_with_guest( + context: ToolContext, + guest_id: Annotated[int, "The unique identifier for the guest to share the task with."], + guest_permission_level: Annotated[ + str, + "Defines the level of access for the guest. Options: 'read', 'comment', 'edit', 'create'.", + ], + task_id: Annotated[str, "The unique identifier for the task to share with the guest."], + include_shared_details: Annotated[ + bool | None, + "Set to `true` to include details of items shared with the guest. Defaults to `true`.", + ] = None, + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id_when_custom_task_ids_enabled: Annotated[ + int | None, + "Provide the Workspace ID when referencing tasks by custom task IDs. Required if `custom_task_ids` is `true`.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'AddGuestToTask'."]: + """Share a task with a guest in the ClickUp Workspace. + + This tool shares a specified task with a guest, available only on ClickUp's Enterprise Plan.""" + request_data: Any = {"permission_level": guest_permission_level} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/guest/{guest_id}".format( # noqa: UP032 + task_id=task_id, guest_id=guest_id + ), + method="POST", + params=remove_none_values({ + "include_shared": include_shared_details, + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_when_custom_task_ids_enabled, + }), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_guest_from_task( + context: ToolContext, + guest_id: Annotated[ + int, "The ID of the guest to remove from the task. This is a required integer value." + ], + task_id: Annotated[ + str, + "The unique identifier of the task from which the guest's access should be revoked. This is required to specify the task.", + ], + include_shared_details: Annotated[ + bool | None, + "Set to `true` to include details of items shared with the guest. Default is `true`.", + ] = None, + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id_for_custom_task: Annotated[ + int | None, + "Provide the Workspace ID when referencing a task by its custom task ID. This is required if 'custom_task_ids' is set to 'true'.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'RemoveGuestFromTask'."]: + """Revoke a guest's access to a specific task in ClickUp. + + Use this tool to remove a guest from a task in ClickUp. This action is available only for Workspaces on the Enterprise Plan.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/guest/{guest_id}".format( # noqa: UP032 + task_id=task_id, guest_id=guest_id + ), + method="DELETE", + params=remove_none_values({ + "include_shared": include_shared_details, + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_for_custom_task, + }), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_guest_to_list( + context: ToolContext, + guest_id: Annotated[ + int, "The unique identifier for the guest to be added. This should be an integer value." + ], + guest_permission_level: Annotated[ + str, + "Permission level for the guest on the list. Options are `read`, `comment`, `edit`, or `create`.", + ], + list_id: Annotated[int, "The identifier of the list to which the guest will be added."], + include_shared_details: Annotated[ + bool | None, + "Set to false to exclude shared item details from the guest view; defaults to true to include them.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'AddGuestToList'."]: + """Add a guest to a specific list in ClickUp. + + This tool adds a guest to a list within ClickUp, available only for Enterprise Plan workspaces.""" + request_data: Any = {"permission_level": guest_permission_level} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}/guest/{guest_id}".format( # noqa: UP032 + list_id=list_id, guest_id=guest_id + ), + method="POST", + params=remove_none_values({"include_shared": include_shared_details}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_guest_from_list( + context: ToolContext, + guest_user_id: Annotated[ + int, "The unique identifier of the guest whose access is to be revoked from the list." + ], + list_identifier: Annotated[ + int, + "The unique identifier for the list from which the guest's access will be revoked. This must be an integer.", + ], + include_shared_details: Annotated[ + bool | None, + "Set to `true` to include details of items shared with the guest. Default is `true`.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'RemoveGuestFromList'."]: + """Revoke a guest's access to a specific list in ClickUp. + + This tool removes a guest's access from a specified list within ClickUp. It is available only for Workspaces on the Enterprise Plan.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}/guest/{guest_id}".format( # noqa: UP032 + list_id=list_identifier, guest_id=guest_user_id + ), + method="DELETE", + params=remove_none_values({"include_shared": include_shared_details}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_guest_to_folder( + context: ToolContext, + folder_id: Annotated[int, "The unique integer ID of the folder to be shared with the guest."], + guest_identifier: Annotated[ + int, + "The unique identifier for the guest to whom the folder will be shared. This should be an integer representing the guest's ID.", + ], + guest_permission_level: Annotated[ + str, + "Defines guest's access level: 'read' for view only, 'comment', 'edit', or 'create' for full access.", + ], + include_shared_items: Annotated[ + bool | None, + "Set to true to include details of items shared with the guest. Default is true.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'AddGuestToFolder'."]: + """Share a folder with a guest in ClickUp's Enterprise Plan. + + This tool shares a specific folder with a guest, available only for ClickUp Workspaces on the Enterprise Plan. Use it to collaborate by granting access to specified guests.""" + request_data: Any = {"permission_level": guest_permission_level} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/folder/{folder_id}/guest/{guest_id}".format( # noqa: UP032 + folder_id=folder_id, guest_id=guest_identifier + ), + method="POST", + params=remove_none_values({"include_shared": include_shared_items}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_guest_from_folder( + context: ToolContext, + folder_identifier: Annotated[ + int, + "The unique identifier for the folder from which the guest's access should be revoked. This ID is essential to specify the exact folder within the ClickUp workspace.", + ], + guest_identifier: Annotated[ + int, + "The unique numeric ID of the guest to be removed from the folder. This is required to identify which guest's access is being revoked.", + ], + include_shared_items: Annotated[ + bool | None, + "Set to true to include details of items shared with the guest. Defaults to true.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'RemoveGuestFromFolder'."]: + """Revoke a guest's access to a specified folder. + + Use this tool to remove a guest's access to a specific folder in ClickUp workspaces on the Enterprise Plan.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/folder/{folder_id}/guest/{guest_id}".format( # noqa: UP032 + folder_id=folder_identifier, guest_id=guest_identifier + ), + method="DELETE", + params=remove_none_values({"include_shared": include_shared_items}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_lists_in_folder( + context: ToolContext, + folder_id: Annotated[ + int, + "The unique identifier for the folder whose lists are to be retrieved. This is required to specify which folder's lists to view.", + ], + include_archived_lists: Annotated[ + bool | None, + "Specify whether to include archived lists. Set to true to include and false to exclude.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetLists'."]: + """Retrieve lists from a specific folder. + + Use this tool to view all the lists contained within a specified folder by providing the folder ID. It should be called when you need to access or manage lists within a folder within ClickUp.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/folder/{folder_id}/list".format(folder_id=folder_id), # noqa: UP032 + method="GET", + params=remove_none_values({"archived": include_archived_lists}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_clickup_list( + context: ToolContext, + folder_id: Annotated[ + int, "The unique integer identifier for the folder where the new list will be added." + ], + list_name: Annotated[ + str, "The name of the new list to be created within the specified ClickUp folder." + ], + due_date_timestamp: Annotated[ + int | None, + "The due date for the list in Unix timestamp format. Determines when the list should be completed.", + ] = None, + formatted_list_description: Annotated[ + str | None, + "Provide a markdown-formatted description for the List. Use this instead of plain text content.", + ] = None, + include_time_in_due_date: Annotated[ + bool | None, "Set to true to include a specific time with the due date." + ] = None, + list_assignee_user_id: Annotated[ + int | None, + "The user ID to assign this list to a specific user. This identifies who will be responsible for the list.", + ] = None, + list_color: Annotated[ + str | None, "Specifies the color of the List, not related to task statuses." + ] = None, + list_description: Annotated[ + str | None, + "A plain text description for the list. Use this to provide details about the list's purpose.", + ] = None, + list_priority: Annotated[ + int | None, + "An integer value indicating the priority of the list, where a higher number typically means higher priority.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateList'."]: + """Create a new list in a ClickUp folder. + + Use this tool to add a new list to a specified folder in ClickUp. Ideal for organizing tasks or projects within a folder.""" + request_data: Any = { + "name": list_name, + "content": list_description, + "markdown_content": formatted_list_description, + "due_date": due_date_timestamp, + "due_date_time": include_time_in_due_date, + "priority": list_priority, + "assignee": list_assignee_user_id, + "status": list_color, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/folder/{folder_id}/list".format(folder_id=folder_id), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_folder_from_template( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + clickup_space_id: Annotated[ + str | None, + "ID of the ClickUp Space where the folder will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + folder_template_id: Annotated[ + str | None, + "The ID of the folder template to be used for creating a new folder in a ClickUp space. Ensure the template is added to your Workspace. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateFolderFromTemplate'."]: + """Creates a new folder from a template in a ClickUp space. + + This tool creates a new folder using a predefined template within a specified ClickUp space. It can also incorporate nested assets like lists and tasks from the template into the new folder. Templates must be added to your Workspace before use. The operation can be executed asynchronously or synchronously. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["CREATEFOLDERFROMTEMPLATE"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not clickup_space_id: + missing_params.append(("clickup_space_id", "path")) + if not folder_template_id: + missing_params.append(("folder_template_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATEFOLDERFROMTEMPLATE"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATEFOLDERFROMTEMPLATE"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/space/{space_id}/folder_template/{template_id}".format( # noqa: UP032 + space_id=clickup_space_id, template_id=folder_template_id + ), + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["CREATEFOLDERFROMTEMPLATE"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_folderless_lists( + context: ToolContext, + space_identifier: Annotated[ + int, + "The unique identifier of the space to retrieve the folderless lists from. It should be an integer.", + ], + include_archived_lists: Annotated[ + bool | None, "Specify true to include archived lists, or false to exclude them." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetFolderlessLists'."]: + """View Lists in a Space not located in a Folder. + + Use this tool to retrieve lists within a specified space that are not contained within any folder, providing an organized view of unassigned lists.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/space/{space_id}/list".format( # noqa: UP032 + space_id=space_identifier + ), + method="GET", + params=remove_none_values({"archived": include_archived_lists}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_folderless_list_to_space( + context: ToolContext, + list_name: Annotated[str, "The name of the new list to be created within the space."], + space_id: Annotated[int, "The unique identifier of the space where the list will be added."], + due_date_timestamp: Annotated[ + int | None, + "An integer representing the UNIX timestamp for the list's due date. This defines the deadline for the list.", + ] = None, + include_due_time: Annotated[ + bool | None, "Set to true if the due date should include a specific time." + ] = None, + list_color_status: Annotated[ + str | None, + "Specifies the color representing the List. This is for visual identification and does not affect task statuses.", + ] = None, + list_description: Annotated[ + str | None, + "A text description for the new list. Use plain text. For markdown, use `markdown_content`.", + ] = None, + list_markdown_description: Annotated[ + str | None, + "Markdown formatted description for the list. Use this instead of a plain text description.", + ] = None, + list_owner_user_id: Annotated[ + int | None, "The user ID for the list owner to be assigned to the new list." + ] = None, + list_priority_level: Annotated[ + int | None, + "Set the priority level for the list. It should be an integer value indicating the list's urgency or importance.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateFolderlessList'."]: + """Add a new folderless list to a specified space. + + This tool is used to create a new list within a specified space in ClickUp without associating it with a folder. It facilitates the organization of tasks directly within the space.""" + request_data: Any = { + "name": list_name, + "content": list_description, + "markdown_content": list_markdown_description, + "due_date": due_date_timestamp, + "due_date_time": include_due_time, + "priority": list_priority_level, + "assignee": list_owner_user_id, + "status": list_color_status, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/space/{space_id}/list".format(space_id=space_id), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_list_details( + context: ToolContext, + list_id: Annotated[ + int, + "The unique ID of the list to view details. Right-click the list in your ClickUp sidebar, select 'Copy link', and paste the URL's last string.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetList'."]: + """Retrieve details of a specific list in ClickUp. + + Use this tool to get detailed information about a specific list in ClickUp by providing the list ID. It helps in obtaining metadata and current status of the list.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}".format(list_id=list_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_clickup_list( + context: ToolContext, + list_identifier: Annotated[ + str, "The unique identifier of the ClickUp list to update. This is a required string field." + ], + list_name: Annotated[str, "The new name for the ClickUp list. This should be a string value."], + formatted_list_description: Annotated[ + str | None, "Formatted description of the list using Markdown syntax instead of plain text." + ] = None, + include_due_date_time: Annotated[ + bool | None, "Set to true to include a specific time with the due date." + ] = None, + list_assignee_id: Annotated[ + str | None, "The ID of the user to assign to the list. Provide a valid user ID string." + ] = None, + list_color: Annotated[ + str | None, + "Specify the color of the list. This refers to the List color rather than task statuses.", + ] = None, + list_description_content: Annotated[ + str | None, + "The plain text description to update for the ClickUp list. Use this instead of markdown for simple text updates.", + ] = None, + list_due_date: Annotated[ + int | None, + "Set the list's due date as a Unix timestamp in milliseconds, representing the time the list is due.", + ] = None, + list_priority: Annotated[ + int | None, + "Set the list's priority as an integer. Usually, 1 is high, 2 is medium, and 3 is low priority.", + ] = None, + remove_list_color: Annotated[ + bool | None, "Set to `true` to remove the List color; default is `false`." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'UpdateList'."]: + """Update the details of a ClickUp list. + + Use this tool to rename a ClickUp list, update its description, set a due date or time, change the priority, assign someone, or modify the list color.""" + request_data: Any = { + "name": list_name, + "content": list_description_content, + "markdown_content": formatted_list_description, + "due_date": list_due_date, + "due_date_time": include_due_date_time, + "priority": list_priority, + "assignee": list_assignee_id, + "status": list_color, + "unset_status": remove_list_color, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}".format(list_id=list_identifier), # noqa: UP032 + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_workspace_list( + context: ToolContext, + content_type_header: Annotated[ + str, "Specifies the media type of the request. Typically set to 'application/json'." + ], + workspace_list_id: Annotated[ + int, "The unique integer ID of the list to be deleted from the ClickUp workspace." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteList'."]: + """Delete a list from your ClickUp workspace. + + Use this tool to remove a specific list from your ClickUp workspace when it's no longer needed.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}".format(list_id=workspace_list_id), # noqa: UP032 + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_task_to_clickup_list( + context: ToolContext, + target_list_id: Annotated[ + int, + "The unique identifier for the target list where the task will be added. This is required to associate the task with the correct list in ClickUp.", + ], + task_identifier: Annotated[ + str, "Specify the ID of the task to be added to an additional list in ClickUp." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'AddTaskToList'."]: + """Add a task to an additional list in ClickUp. + + This tool adds a specified task to an additional list in ClickUp, requiring the 'Tasks in Multiple List' ClickApp to be enabled. Use this tool to manage tasks across multiple lists efficiently.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}/task/{task_id}".format( # noqa: UP032 + list_id=target_list_id, task_id=task_identifier + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_task_from_additional_list( + context: ToolContext, + additional_list_id: Annotated[ + int, + "The ID of the additional list from which the task should be removed. This is required for identifying the secondary list, not the task's home list.", + ], + task_identifier: Annotated[ + str, "The unique identifier for the task to be removed from the additional list." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'RemoveTaskFromList'."]: + """Remove a task from an additional list in ClickUp. + + Use this tool to remove a task from an additional list, not the task's home list. Requires the 'Tasks in Multiple Lists' feature to be enabled in ClickUp.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}/task/{task_id}".format( # noqa: UP032 + list_id=additional_list_id, task_id=task_identifier + ), + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_task_members( + context: ToolContext, + task_identifier: Annotated[ + str, + "The unique identifier of the task to retrieve members for. This ID is necessary to specify the task in question.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetTaskMembers'."]: + """Retrieve members with direct access to a task. + + Use this tool to view the people who have direct access to a specific task in ClickUp. It does not include members with inherited permissions through the hierarchy.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/member".format(task_id=task_identifier), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_list_members( + context: ToolContext, + list_id: Annotated[ + int, + "The unique identifier for the list in ClickUp. It is required to fetch the members with access to this list.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetListMembers'."]: + """Retrieve members with access to a specific list in ClickUp. + + Use this tool to get the members of a ClickUp workspace who have access to a specified list. It helps in managing and viewing user access to project resources.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}/member".format(list_id=list_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_workspace_custom_roles( + context: ToolContext, + workspace_id: Annotated[ + int, "The unique identifier for the workspace to retrieve custom roles from." + ], + include_members: Annotated[ + bool | None, + "Include member details in the response. Set to true to include, false to exclude.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetCustomRoles'."]: + """Retrieve custom roles from a specific workspace. + + This tool is used to retrieve the custom roles available in a specified workspace on ClickUp. It should be called when you need to view or manage roles in a ClickUp workspace.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/customroles".format( # noqa: UP032 + team_id=workspace_id + ), + method="GET", + params=remove_none_values({"include_members": include_members}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_shared_hierarchy( + context: ToolContext, + workspace_id: Annotated[int, "The Workspace ID to view shared tasks, lists, and folders."], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'SharedHierarchy'."]: + """View shared tasks, lists, and folders. + + Use this tool to view tasks, lists, and folders shared with the authenticated user in a specified team.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/shared".format(team_id=workspace_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def retrieve_available_spaces( + context: ToolContext, + workspace_id: Annotated[int, "The ID of the workspace to retrieve available spaces from."], + include_archived_spaces: Annotated[ + bool | None, + "Set to true to include archived Spaces in the results. Otherwise, only active Spaces are returned.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetSpaces'."]: + """View available Spaces in a Workspace. + + The tool retrieves the Spaces within a specified Workspace, providing member info for private Spaces if applicable.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/space".format(team_id=workspace_id), # noqa: UP032 + method="GET", + params=remove_none_values({"archived": include_archived_spaces}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_space_in_workspace( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + workspace_id: Annotated[ + int | None, + "The ID of the workspace where the new space will be added. It should be an integer value. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateSpace'."]: + """Add a new Space to a Workspace. + + Use this tool to create a new space within a specified workspace on ClickUp. It should be called when a user wants to organize tasks or projects under a new space in their team environment. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["CREATESPACEINWORKSPACE"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not workspace_id: + missing_params.append(("workspace_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATESPACEINWORKSPACE"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATESPACEINWORKSPACE"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/team/{team_id}/space".format(team_id=workspace_id), # noqa: UP032 + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["CREATESPACEINWORKSPACE"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_workspace_spaces( + context: ToolContext, + workspace_space_id: Annotated[ + int, "The unique identifier for the specific space in the workspace to retrieve details." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetSpace'."]: + """Retrieve available Spaces in a Workspace. + + Use this tool to get information about the Spaces available in a specific Workspace identified by its space ID.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/space/{space_id}".format(space_id=workspace_space_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_clickup_space( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + space_identifier: Annotated[ + int | None, + "The unique identifier for the ClickUp space to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'UpdateSpace'."]: + """Update space attributes in ClickUp. + + Use this tool to rename a ClickUp space, change its color, and enable or disable ClickApps for it. Call this when you need to modify the settings of an existing space. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["UPDATECLICKUPSPACE"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not space_identifier: + missing_params.append(("space_identifier", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["UPDATECLICKUPSPACE"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["UPDATECLICKUPSPACE"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/space/{space_id}".format(space_id=space_identifier), # noqa: UP032 + method="PUT", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["UPDATECLICKUPSPACE"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_workspace_space( + context: ToolContext, + workspace_space_id: Annotated[ + int, + "The unique identifier for the space to delete in your ClickUp workspace. Provide the specific space ID to permanently remove the space and its data.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteSpace'."]: + """Delete a space from your ClickUp workspace. + + Use this tool to delete a specific space in your ClickUp workspace by providing the space ID. It permanently removes the space and all associated data.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/space/{space_id}".format(space_id=workspace_space_id), # noqa: UP032 + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_space_tags( + context: ToolContext, + content_type_header: Annotated[ + str, "The MIME type of the request. Generally set to 'application/json'." + ], + space_identifier: Annotated[ + int, + "An integer representing the ID of the space for which to retrieve task tags. This ID is required to specify the space.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetSpaceTags'."]: + """Retrieve task tags for a specified space. + + Use this tool to view the task tags available within a specific space. It helps in identifying and managing tags associated with tasks.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/space/{space_id}/tag".format(space_id=space_identifier), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_space_task_tag( + context: ToolContext, + space_identifier: Annotated[ + int, + "The unique identifier for the space where the tag will be added. It must be an integer.", + ], + tag_background_color: Annotated[ + str, + "Hex code representing the background color for the tag. It should be a string in the format '#RRGGBB'.", + ], + tag_foreground_color: Annotated[ + str, "Hex code for the tag's foreground color. It defines the text color of the tag." + ], + tag_name: Annotated[ + str, + "Name of the new tag to be added to the space. It should be a descriptive and concise identifier for categorizing tasks.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateSpaceTag'."]: + """Add a new task tag to a specified space in ClickUp. + + Use this tool to create a new tag for tasks within a specific space in ClickUp. It's useful for organizing tasks by category or priority.""" + request_data: Any = { + "tag": {"name": tag_name, "tag_fg": tag_foreground_color, "tag_bg": tag_background_color} + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/space/{space_id}/tag".format(space_id=space_identifier), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_task_tag( + context: ToolContext, + background_color_of_tag: Annotated[ + str, + "The background color for the task tag. It should be a valid hex color code (e.g., #FFFFFF).", + ], + current_tag_name: Annotated[ + str, "The current name of the tag to be updated in the ClickUp space." + ], + new_tag_name: Annotated[ + str, + "The new name for the task tag to be updated in the ClickUp space. It must be a string representing the desired tag name after the update.", + ], + space_id: Annotated[ + int, + "The unique identifier of the ClickUp space where the tag will be updated. This is required to specify which space's tag needs modification.", + ], + tag_foreground_color: Annotated[ + str, "The foreground (text) color of the tag in a valid color format (e.g., HEX)." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'EditSpaceTag'."]: + """Update a task tag in a ClickUp space. + + Use this tool to update the details of a task tag within a specified ClickUp space. It is helpful for managing and organizing tasks by modifying existing tags.""" + request_data: Any = { + "tag": { + "name": new_tag_name, + "fg_color": tag_foreground_color, + "bg_color": background_color_of_tag, + } + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/space/{space_id}/tag/{tag_name}".format( # noqa: UP032 + space_id=space_id, tag_name=current_tag_name + ), + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_space_tag( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + space_identifier: Annotated[ + int | None, + "The unique identifier of the space from which the tag will be deleted. This should be an integer value. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + tag_name_to_delete: Annotated[ + str | None, + "The name of the tag to be deleted from the specified space. Ensure this tag name exists in the target space. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteSpaceTag'."]: + """Delete a task tag from a space in ClickUp. + + Use this tool to delete a specific task tag from a designated space in ClickUp. Ideal for cleaning up or reorganizing tags within a space. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["DELETESPACETAG"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not space_identifier: + missing_params.append(("space_identifier", "path")) + if not tag_name_to_delete: + missing_params.append(("tag_name_to_delete", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["DELETESPACETAG"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["DELETESPACETAG"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/space/{space_id}/tag/{tag_name}".format( # noqa: UP032 + space_id=space_identifier, tag_name=tag_name_to_delete + ), + method="DELETE", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["DELETESPACETAG"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_tag_to_task( + context: ToolContext, + content_type: Annotated[ + str, "Specifies the media type of the request. Typically set to 'application/json'." + ], + tag_name: Annotated[ + str, + "The name of the tag to add to the task. This should be a string representing the desired tag.", + ], + task_identifier: Annotated[ + str, + "The unique identifier of the task to which the tag will be added. Can be a custom task ID if specified.", + ], + use_custom_task_ids: Annotated[ + bool | None, "Set to true if you want to reference a task using its custom task ID." + ] = None, + workspace_id_if_custom_task_ids: Annotated[ + int | None, + "Workspace ID required when referencing a task by its custom task ID. Only needed if `custom_task_ids=true`.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'AddTagToTask'."]: + """Add a tag to a specific task in ClickUp. + + Use this tool to assign a tag to a task in ClickUp by specifying the task ID and tag name. It helps in organizing and categorizing tasks efficiently.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/tag/{tag_name}".format( # noqa: UP032 + task_id=task_identifier, tag_name=tag_name + ), + method="POST", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_if_custom_task_ids, + }), + headers=remove_none_values({ + "Content-Type": content_type, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_tag_from_task( + context: ToolContext, + content_type_header: Annotated[ + str, "Specifies the media type of the request. Commonly set to 'application/json'." + ], + tag_name_to_remove: Annotated[str, "The name of the tag to remove from the specified task."], + task_id: Annotated[ + str, + "The unique identifier of the task from which the tag will be removed. Use the task's regular ID unless custom task IDs are enabled.", + ], + use_custom_task_ids: Annotated[ + bool | None, + "Set to true to reference a task by its custom task ID, or false to use the standard ID.", + ] = None, + workspace_id_for_custom_task: Annotated[ + int | None, + "The Workspace ID required when referencing a task by its custom ID (if custom_task_ids is true).", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'RemoveTagFromTask'."]: + """Remove a tag from a specific task in ClickUp. + + Use this tool to remove a specified tag from a task in ClickUp without deleting the tag from the space.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/tag/{tag_name}".format( # noqa: UP032 + task_id=task_id, tag_name=tag_name_to_remove + ), + method="DELETE", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_for_custom_task, + }), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_list_tasks( + context: ToolContext, + list_identifier: Annotated[ + int, + "The unique identifier for the list. Find it by copying the link and extracting the number following /li in the URL.", + ], + custom_task_type_filters: Annotated[ + list[float] | None, + "An array of numbers to filter tasks by custom types. Use 0 for tasks, 1 for Milestones, and other numbers for custom types defined in your Workspace.", + ] = None, + date_created_less_than: Annotated[ + int | None, "Filter tasks created before the specified Unix timestamp in milliseconds." + ] = None, + display_tasks_in_reverse_order: Annotated[ + bool | None, "Set to true to display tasks in reverse order." + ] = None, + filter_by_assignees: Annotated[ + list[str] | None, + "Filter tasks by assignee IDs. Provide an array of assignee IDs to filter tasks assigned to specific users.", + ] = None, + filter_by_custom_field: Annotated[ + list[str] | None, + "Include tasks with specific values in one Custom Field. This can be a Custom Relationship. Provide an array of strings representing the field values.", + ] = None, + filter_by_custom_fields: Annotated[ + list[str] | None, + "Include tasks with specific values in one or more Custom Fields. Use a JSON array of objects, where each object includes 'field_id', 'operator', and 'value'.", + ] = None, + filter_by_date_done_before: Annotated[ + int | None, "Filter tasks completed before a specified Unix time in milliseconds." + ] = None, + filter_by_statuses: Annotated[ + list[str] | None, + "Filter tasks by their statuses. Use an array of status strings, such as ['to do', 'in progress'].", + ] = None, + filter_by_tags: Annotated[ + list[str] | None, + "Filter tasks by a list of tags. Provide an array of strings representing the tags to filter by.", + ] = None, + filter_by_watchers: Annotated[ + list[str] | None, + "An array of watcher IDs to filter tasks by watchers. Each ID should be a string.", + ] = None, + filter_date_created_after: Annotated[ + int | None, "Filter tasks created after this Unix timestamp in milliseconds." + ] = None, + filter_date_done_after: Annotated[ + int | None, "Filter tasks completed after a specified date in Unix time (milliseconds)." + ] = None, + filter_date_updated_after: Annotated[ + int | None, "Filter tasks updated after the specified Unix timestamp in milliseconds." + ] = None, + filter_date_updated_less_than: Annotated[ + int | None, "Filter tasks updated before a specific date, using Unix time in milliseconds." + ] = None, + filter_due_date_before: Annotated[ + int | None, + "Filter tasks with due dates earlier than the specified Unix time in milliseconds.", + ] = None, + filter_due_date_greater_than: Annotated[ + int | None, + "Filter tasks by a due date greater than the provided Unix time in milliseconds.", + ] = None, + include_archived_tasks: Annotated[ + bool | None, + "Set to true to include archived tasks in the results. By default, archived tasks are excluded.", + ] = None, + include_closed_tasks: Annotated[ + bool | None, + "Set to true to include closed tasks in the response. Defaults to false to exclude them.", + ] = None, + include_markdown_task_descriptions: Annotated[ + bool | None, "Set to true to return task descriptions in Markdown format." + ] = None, + include_subtasks: Annotated[ + bool | None, "Set to true to include subtasks; false to exclude them. Defaults to false." + ] = None, + include_tasks_in_multiple_lists: Annotated[ + bool | None, + "Set to true to include tasks that exist in multiple lists. By default, these tasks are excluded.", + ] = None, + order_by_field: Annotated[ + str | None, + "Specify the field to order tasks by. Options: 'id', 'created', 'updated', 'due_date'. Defaults to 'created'.", + ] = None, + page_number_to_fetch: Annotated[ + int | None, "Specify the page number to fetch tasks from, starting at 0." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetTasks'."]: + """Retrieve tasks from a specific list in ClickUp. + + This tool retrieves tasks from a specified list in ClickUp, limited to 100 tasks per page. It includes tasks where the specified list is their home, while also allowing inclusion of tasks from multiple lists by using the `include_timl` parameter. It provides details accessible to the user, including time spent on tasks with time entries.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}/task".format(list_id=list_identifier), # noqa: UP032 + method="GET", + params=remove_none_values({ + "archived": include_archived_tasks, + "include_markdown_description": include_markdown_task_descriptions, + "page": page_number_to_fetch, + "order_by": order_by_field, + "reverse": display_tasks_in_reverse_order, + "subtasks": include_subtasks, + "statuses": filter_by_statuses, + "include_closed": include_closed_tasks, + "include_timl": include_tasks_in_multiple_lists, + "assignees": filter_by_assignees, + "watchers": filter_by_watchers, + "tags": filter_by_tags, + "due_date_gt": filter_due_date_greater_than, + "due_date_lt": filter_due_date_before, + "date_created_gt": filter_date_created_after, + "date_created_lt": date_created_less_than, + "date_updated_gt": filter_date_updated_after, + "date_updated_lt": filter_date_updated_less_than, + "date_done_gt": filter_date_done_after, + "date_done_lt": filter_by_date_done_before, + "custom_fields": filter_by_custom_fields, + "custom_field": filter_by_custom_field, + "custom_items": custom_task_type_filters, + }), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_new_clickup_task( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + target_list_id: Annotated[ + int | None, + "The ID of the list where the new task will be created. This should be an integer identifying the list in ClickUp. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateTask'."]: + """Create a new task in ClickUp. + + This tool is used to create a new task in a specified list on ClickUp. It should be called when you need to add a task to your ClickUp project management system. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["CREATENEWCLICKUPTASK"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not target_list_id: + missing_params.append(("target_list_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATENEWCLICKUPTASK"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATENEWCLICKUPTASK"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/list/{list_id}/task".format(list_id=target_list_id), # noqa: UP032 + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["CREATENEWCLICKUPTASK"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_task_details( + context: ToolContext, + task_identifier: Annotated[ + str, "The unique identifier for the task you want to retrieve details for in ClickUp." + ], + filter_custom_fields: Annotated[ + list[str] | None, + "Include tasks with specific values in one or more custom fields using the specified JSON format. Custom Relationships are supported.", + ] = None, + include_markdown_description: Annotated[ + bool | None, "Set to true to return task descriptions in Markdown format." + ] = None, + include_subtasks: Annotated[ + bool | None, "Include subtasks in the task details if set to true. Defaults to false." + ] = None, + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id_for_custom_task: Annotated[ + int | None, + "Provide the Workspace ID when referencing a task by its custom task ID. Required if `custom_task_ids` is true.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetTask'."]: + """Retrieve detailed information about a specific task. + + Use this tool to get detailed information on a task you have access to in ClickUp, including any attachments associated with the task.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}".format(task_id=task_identifier), # noqa: UP032 + method="GET", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_for_custom_task, + "include_subtasks": include_subtasks, + "include_markdown_description": include_markdown_description, + "custom_fields": filter_custom_fields, + }), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_task_in_clickup( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + task_identifier: Annotated[ + str | None, + "The ID of the task to be updated. Provide either the standard task ID or a custom task ID if 'custom_task_ids' is true. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + workspace_id_for_custom_task: Annotated[ + int | None, + "Provide the Workspace ID when referencing a task by its custom task ID (requires `custom_task_ids` set to true). Only used when mode is 'execute'.", + ] = None, + use_custom_task_ids: Annotated[ + bool | None, + "Set to true to reference a task by its custom task ID. Only used when mode is 'execute'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'UpdateTask'."]: + """Update task details in ClickUp. + + Use this tool to update specific fields of a task in ClickUp by providing the task ID and desired changes. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path, query parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path, query parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["UPDATETASKINCLICKUP"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path, query parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not task_identifier: + missing_params.append(("task_identifier", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["UPDATETASKINCLICKUP"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["UPDATETASKINCLICKUP"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/task/{task_id}".format(task_id=task_identifier), # noqa: UP032 + method="PUT", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["UPDATETASKINCLICKUP"], + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_for_custom_task, + }), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_task( + context: ToolContext, + content_type: Annotated[ + str, "Specify the media type of the resource. Typically set as 'application/json'." + ], + task_id: Annotated[ + str, + "The ID of the task to be deleted. This is mandatory and should be a valid task identifier.", + ], + use_custom_task_ids: Annotated[ + bool | None, "Set to true if referencing a task by custom task ID is required." + ] = None, + workspace_id: Annotated[ + int | None, + "Provide the Workspace ID when referencing a task by its custom task ID. Required if `custom_task_ids` is true.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteTask'."]: + """Delete a task from your ClickUp Workspace. + + Use this tool to delete a specific task from your ClickUp Workspace by providing the task ID. It should be called when you want to permanently remove a task.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}".format(task_id=task_id), # noqa: UP032 + method="DELETE", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Content-Type": content_type, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_filtered_team_tasks( + context: ToolContext, + workspace_id: Annotated[ + int, "The ID of the workspace to retrieve tasks from. Must be an integer." + ], + assignee_ids: Annotated[ + list[str] | None, "Filter tasks by assignee using their ClickUp user IDs." + ] = None, + custom_task_type_filters: Annotated[ + list[float] | None, + "Filter tasks by custom task types. Use `0` for tasks, `1` for Milestones, and other numbers for Workspace-defined types.", + ] = None, + display_tasks_in_reverse_order: Annotated[ + bool | None, "Set to true to display tasks in reverse order." + ] = None, + due_date_before: Annotated[ + int | None, + "Filter tasks with due dates earlier than the specified Unix timestamp in milliseconds.", + ] = None, + due_date_greater_than: Annotated[ + int | None, + "Filter tasks by a due date greater than the specified Unix time in milliseconds.", + ] = None, + filter_by_custom_fields: Annotated[ + list[str] | None, + "Include tasks with specific values in Custom Fields. Provide an array of objects with field_id, operator, and value keys.", + ] = None, + filter_by_date_created_before: Annotated[ + int | None, "Filter tasks created before this date. Specify as Unix time in milliseconds." + ] = None, + filter_by_date_done_after: Annotated[ + int | None, "Filter tasks by the completion date after the given Unix time in milliseconds." + ] = None, + filter_by_done_date_before: Annotated[ + int | None, + "Filter tasks completed before a specific date. Provide the date in Unix time (milliseconds).", + ] = None, + filter_by_list_ids: Annotated[ + list[str] | None, 'An array of list IDs to filter tasks by. Example: ["1234", "6789"].' + ] = None, + filter_by_project_ids: Annotated[ + list[str] | None, + "An array of folder IDs to filter tasks by specific folders. For example, ['1234', '6789'].", + ] = None, + filter_by_space_ids: Annotated[ + list[str] | None, + "An array of space IDs to filter tasks by. Example values: ['1234', '6789'].", + ] = None, + filter_by_tags: Annotated[ + list[str] | None, + "Filter tasks by tags. Use `%20` for spaces within tags. Example: `urgent%20task`.", + ] = None, + filter_by_update_date_before: Annotated[ + int | None, + "Filter tasks updated before a specific date, provided as Unix time in milliseconds.", + ] = None, + filter_by_updated_date_greater_than: Annotated[ + int | None, + "Filter tasks by their updated date, greater than the specified Unix time in milliseconds.", + ] = None, + filter_created_date_after: Annotated[ + int | None, + "Filter tasks by creation date greater than the specified Unix time in milliseconds.", + ] = None, + include_closed_tasks: Annotated[ + bool | None, + "Set to true to include closed tasks, false to exclude them. By default, closed tasks are excluded.", + ] = None, + include_markdown_description: Annotated[ + bool | None, "Set to true to return task descriptions in Markdown format. Default is false." + ] = None, + include_subtasks: Annotated[ + bool | None, + "Set to true to include subtasks, or false to exclude them. Defaults to false (exclude).", + ] = None, + order_tasks_by: Annotated[ + str | None, + "Specify the field by which to order tasks. Options include: 'id', 'created', 'updated', 'due_date'. Defaults to 'created'.", + ] = None, + page_number_to_fetch: Annotated[ + int | None, "Page number to fetch, starting at 0, in the paginated list of tasks." + ] = None, + parent_task_id: Annotated[ + str | None, "Include the parent task ID to return subtasks in the response." + ] = None, + status_filters: Annotated[ + list[str] | None, + "Filter tasks by their statuses. Use '%20' for spaces. Example: ['to%20do', 'in%20progress'].", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetFilteredTeamTasks'."]: + """Retrieve tasks from a workspace based on specified filters. + + This tool retrieves tasks from a specified workspace that meet certain criteria. The response is limited to 100 tasks per page, and only tasks that the user has access to are returned. The tool is useful for viewing filtered task information from multiple lists, folders, or spaces.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_Id}/task".format(team_Id=workspace_id), # noqa: UP032 + method="GET", + params=remove_none_values({ + "page": page_number_to_fetch, + "order_by": order_tasks_by, + "reverse": display_tasks_in_reverse_order, + "subtasks": include_subtasks, + "space_ids[]": filter_by_space_ids, + "project_ids[]": filter_by_project_ids, + "list_ids[]": filter_by_list_ids, + "statuses[]": status_filters, + "include_closed": include_closed_tasks, + "assignees[]": assignee_ids, + "tags[]": filter_by_tags, + "due_date_gt": due_date_greater_than, + "due_date_lt": due_date_before, + "date_created_gt": filter_created_date_after, + "date_created_lt": filter_by_date_created_before, + "date_updated_gt": filter_by_updated_date_greater_than, + "date_updated_lt": filter_by_update_date_before, + "date_done_gt": filter_by_date_done_after, + "date_done_lt": filter_by_done_date_before, + "custom_fields": filter_by_custom_fields, + "parent": parent_task_id, + "include_markdown_description": include_markdown_description, + "custom_items[]": custom_task_type_filters, + }), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def merge_tasks_in_clickup( + context: ToolContext, + source_task_ids_to_merge: Annotated[ + list[str], "Array of task IDs to merge into the target task in ClickUp." + ], + target_task_id: Annotated[str, "ID of the target task into which other tasks will be merged."], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'mergeTasks'."]: + """Merge multiple tasks into a target task in ClickUp. + + Use this tool to merge several tasks into a specified target task within ClickUp. The target task is identified by the task_id, with source tasks provided in the request. This is useful when consolidating tasks for better project management.""" + request_data: Any = {"source_task_ids": source_task_ids_to_merge} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/merge".format(task_id=target_task_id), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def task_status_duration( + context: ToolContext, + content_type: Annotated[ + str, "Specify the content type for the API request, typically 'application/json'." + ], + task_identifier: Annotated[ + str, + "The unique identifier for the task you want to query. Use this to specify which task's status duration you are interested in.", + ], + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id: Annotated[ + int | None, + "The Workspace ID must be provided when referencing a task by its custom task ID and `custom_task_ids` is set to `true`.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetTask'sTimeinStatus'."]: + """Get the duration a task spends in each status. + + Use this tool to find out how long a task has been in each status. Ensure that the 'Total time in Status' ClickApp is enabled by the Workspace owner or admin before using this tool.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/time_in_status".format( # noqa: UP032 + task_id=task_identifier + ), + method="GET", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Content-Type": content_type, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_task_time_in_status( + context: ToolContext, + content_type_header: Annotated[ + str, "The MIME type of the body of the request. Typically set to 'application/json'." + ], + task_ids_list: Annotated[ + str, + "A list of up to 100 task IDs to check duration in status. Include each task ID separated by commas.", + ], + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference tasks by custom task IDs." + ] = None, + workspace_id_for_custom_task_ids: Annotated[ + int | None, + "Provide the Workspace ID if using custom task IDs. Required when `custom_task_ids` is `true`.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetBulkTasks'TimeinStatus'."]: + """Retrieve duration of tasks in various statuses. + + Use this tool to find out how long multiple tasks have remained in each status. The Total Time in Status ClickApp must be enabled by the Workspace owner or an admin.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/bulk_time_in_status/task_ids", + method="GET", + params=remove_none_values({ + "task_ids": task_ids_list, + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_for_custom_task_ids, + }), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_task_templates( + context: ToolContext, + content_type_header: Annotated[ + str, "Sets the 'Content-Type' for the API request, typically 'application/json'." + ], + page_number: Annotated[int, "The page number of results to retrieve. Used for pagination."], + workspace_id: Annotated[ + int, + "The ID of the workspace for which to retrieve task templates. This is used to specify the target workspace in ClickUp.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetTaskTemplates'."]: + """View available task templates in a workspace. + + Retrieve a list of task templates available for a specified workspace in ClickUp. Use this tool to explore task templates and plan tasks efficiently.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/taskTemplate".format( # noqa: UP032 + team_id=workspace_id + ), + method="GET", + params=remove_none_values({"page": page_number}), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_task_from_template( + context: ToolContext, + target_list_id: Annotated[ + int, + "The ID of the list where the task will be created. This should be an integer associated with the desired list in your workspace.", + ], + task_name: Annotated[str, "The name of the task to be created using the template."], + task_template_id: Annotated[ + str, + "A string representing the ID of the task template to be used for task creation. Ensure the template is added to your workspace.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateTaskFromTemplate'."]: + """Create a task using an existing template. + + This tool creates a new task in ClickUp using a specified task template from your workspace. Templates must be added to your Workspace before use. Ideal for automating the creation of standardized tasks.""" + request_data: Any = {"name": task_name} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}/taskTemplate/{template_id}".format( # noqa: UP032 + list_id=target_list_id, template_id=task_template_id + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_list_from_folder_template( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + folder_identifier: Annotated[ + str | None, + "The ID of the folder where the new list will be created using the specified template. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + template_id_for_list_creation: Annotated[ + str | None, + "ID of the template to use for creating a new list in the folder. Ensure the template is added to your Workspace library. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateFolderListFromTemplate'."]: + """Create a new list in a folder using a template. + + Use this tool to create a new list in a ClickUp folder using an existing list template. Ensure the template is added to your Workspace library before invoking this tool. The tool returns the future List ID immediately, though the list creation may continue asynchronously. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["CREATELISTFROMFOLDERTEMPLATE"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not folder_identifier: + missing_params.append(("folder_identifier", "path")) + if not template_id_for_list_creation: + missing_params.append(("template_id_for_list_creation", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + + REQUEST_BODY_SCHEMAS["CREATELISTFROMFOLDERTEMPLATE"] + + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + + REQUEST_BODY_SCHEMAS["CREATELISTFROMFOLDERTEMPLATE"] + + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/folder/{folder_id}/list_template/{template_id}".format( # noqa: UP032 + folder_id=folder_identifier, template_id=template_id_for_list_creation + ), + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["CREATELISTFROMFOLDERTEMPLATE"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_list_from_template( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + space_id_for_list_creation: Annotated[ + str | None, + "ID of the ClickUp Space where the new List will be created using the template. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + template_id: Annotated[ + str | None, + "ID of the template to use for creating the list in the specified ClickUp space. It must be accessible in your Workspace. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateSpaceListFromTemplate'."]: + """Create a new list in a ClickUp space using a template. + + This tool creates a new list within a specified ClickUp space using a provided list template. Publicly shared templates must be added to the Workspace before they can be used. The operation can be performed asynchronously or synchronously based on the 'return_immediately' parameter. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["CREATELISTFROMTEMPLATE"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not space_id_for_list_creation: + missing_params.append(("space_id_for_list_creation", "path")) + if not template_id: + missing_params.append(("template_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATELISTFROMTEMPLATE"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATELISTFROMTEMPLATE"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/space/{space_id}/list_template/{template_id}".format( # noqa: UP032 + space_id=space_id_for_list_creation, template_id=template_id + ), + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["CREATELISTFROMTEMPLATE"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_workspace_seat_details( + context: ToolContext, + workspace_id: Annotated[ + str, "The unique ID of the workspace for which seat details are to be retrieved." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetWorkspaceseats'."]: + """Retrieve seat details for a workspace. + + Use this tool to view the used, total, and available member and guest seats for a specified workspace in ClickUp.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/seats".format(team_id=workspace_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_workspace_plan( + context: ToolContext, + workspace_id: Annotated[ + str, "The unique ID for the workspace whose subscription plan you want to retrieve." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetWorkspaceplan'."]: + """Retrieve the current subscription plan for a workspace. + + Use this tool to get details about the current subscription plan for a specified workspace in ClickUp. It should be called when you need to view the plan or pricing details associated with a workspace.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/plan".format(team_id=workspace_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_user_group( + context: ToolContext, + group_name: Annotated[ + str, + "The name of the user group to be created within the workspace. This should be a descriptive name to identify the group easily.", + ], + user_group_members: Annotated[ + list[int], + "List of user IDs to include in the user group. Each ID should be an integer representing a user within the workspace.", + ], + workspace_id: Annotated[ + int, "The unique ID of the ClickUp workspace where the user group will be created." + ], + group_handle: Annotated[ + str | None, + "A unique string identifier for the user group to be created. This will be used as the group's handle within the workspace.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateUserGroup'."]: + """Create a user group within a ClickUp workspace. + + Use this tool to organize and manage users by creating a user group within a specific ClickUp workspace. Note that adding a guest with view-only permissions converts them to a paid guest, potentially incurring additional costs.""" + request_data: Any = {"name": group_name, "handle": group_handle, "members": user_group_members} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/group".format(team_id=workspace_id), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_workspace_custom_task_types( + context: ToolContext, + workspace_id: Annotated[int, "The ID of the Workspace to retrieve custom task types for."], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetCustomItems'."]: + """Retrieve custom task types for a specific workspace. + + Use this tool to view the custom task types available in a specified workspace. Ideal for gaining insight into workspace-specific configurations and custom workflows.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/custom_item".format( # noqa: UP032 + team_id=workspace_id + ), + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_user_group( + context: ToolContext, + user_group_id: Annotated[ + str, + "The unique identifier of the User Group within the Workspace. This ID is required to specify which group to update.", + ], + add_member_ids: Annotated[ + list[int] | None, + "An array of user IDs to add to the User Group. Each ID should be an integer.", + ] = None, + handle_identifier: Annotated[ + str | None, + "A unique identifier or handle for the User Group. This is used to reference the group within ClickUp.", + ] = None, + remove_members_ids: Annotated[ + list[int] | None, + "An array of integer IDs representing the users to be removed from the User Group.", + ] = None, + user_group_name: Annotated[ + str | None, + "The new name for the User Group within the ClickUp Workspace. This should be a string representing the desired name.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'UpdateTeam'."]: + """Update and manage user groups within a ClickUp Workspace. + + Use this tool to update user groups in your ClickUp Workspace. Useful for managing team membership, permissions, or configurations. Note that adding a guest with view-only permissions will incur additional charges as they convert to paid guests.""" + request_data: Any = { + "name": user_group_name, + "handle": handle_identifier, + "members": {"add": add_member_ids, "rem": remove_members_ids}, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/group/{group_id}".format(group_id=user_group_id), # noqa: UP032 + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_user_group( + context: ToolContext, + user_group_id: Annotated[ + str, "The identifier of the user group to be deleted from the workspace." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteTeam'."]: + """Delete a user group from your ClickUp workspace. + + This tool removes a user group from your ClickUp workspace based on the provided group ID.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/group/{group_id}".format(group_id=user_group_id), # noqa: UP032 + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_user_groups_in_workspace( + context: ToolContext, + workspace_id: Annotated[int, "The ID of the ClickUp workspace to retrieve user groups from."], + user_group_ids: Annotated[ + str | None, + "List one or more User Group IDs to retrieve details about specific user groups in the workspace.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetTeams1'."]: + """Retrieve user groups in a ClickUp workspace. + + Use this tool to view the user groups within a specific ClickUp workspace. It's useful for managing and organizing user permissions and roles within a team environment.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/group", + method="GET", + params=remove_none_values({"team_id": workspace_id, "group_ids": user_group_ids}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_tracked_time_for_task( + context: ToolContext, + set_content_type_header: Annotated[ + str, "Set the Content-Type header for the request, typically as 'application/json'." + ], + task_id: Annotated[ + str, "The unique identifier for the task whose tracked time you want to retrieve." + ], + use_custom_task_ids: Annotated[ + bool | None, + "Set to true to reference tasks by their custom task IDs instead of default IDs.", + ] = None, + workspace_id: Annotated[ + int | None, + "The ID of the Workspace to be provided when referencing a task by its custom task ID. Required if `custom_task_ids` is `true`.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Gettrackedtime'."]: + """Fetch tracked time for a specific task. + + Use this tool to get the tracked time recorded for a specific task in ClickUp. It's useful for retrieving time spent details on tasks, though it doesn't handle new time entries.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/time".format(task_id=task_id), # noqa: UP032 + method="GET", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Content-Type": set_content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def clickup_legacy_time_tracking( + context: ToolContext, + clickup_task_id: Annotated[ + str, + "The unique identifier of the task for which time is being logged. This can refer to either the standard task ID or a custom task ID if specified.", + ], + end_timestamp: Annotated[ + int, "Epoch timestamp indicating when the time tracking ended for the task." + ], + start_time_unix_epoch: Annotated[ + int, + "The start time of the time entry in Unix epoch format. This is required to log time for a task.", + ], + time_spent_seconds: Annotated[ + int, + "Duration of time spent on the task in seconds. This is the time you want to log for the specific task.", + ], + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id: Annotated[ + int | None, "Provide the Workspace ID when `custom_task_ids` is `true`." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Tracktime'."]: + """Log time entry for a ClickUp task using legacy endpoint. + + This tool allows logging time entries for a specific ClickUp task using a legacy API endpoint. It should be called when you need to record time spent on tasks, although it's recommended to use the updated Time Tracking API for new implementations.""" + request_data: Any = { + "start": start_time_unix_epoch, + "end": end_timestamp, + "time": time_spent_seconds, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/time".format(task_id=clickup_task_id), # noqa: UP032 + method="POST", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def edit_legacy_time_entry( + context: ToolContext, + end_time_epoch: Annotated[ + int, + "The end time of the tracked interval in Unix epoch format. It marks when the time entry should conclude.", + ], + legacy_time_interval_id: Annotated[ + str, "The unique identifier for the time interval to be edited." + ], + start_timestamp: Annotated[ + int, "The start time of the time entry as a Unix timestamp in milliseconds." + ], + task_identifier: Annotated[ + str, + "The unique identifier of the task for which the legacy time entry is being edited. This is required to specify the task in ClickUp.", + ], + time_duration_in_seconds: Annotated[ + int, + "The total time duration (in seconds) for the time entry to be updated. This modifies the tracked time for a specific task.", + ], + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id: Annotated[ + int | None, + "The Workspace ID required when custom task IDs are used. This must be set if `custom_task_ids` is `true`.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Edittimetracked'."]: + """Edit a legacy time tracked entry for a task in ClickUp. + + Use this tool to modify an existing time entry on a specific task using the legacy endpoint in ClickUp. It's recommended to use newer APIs for time tracking, but this can be used for older integrations.""" + request_data: Any = { + "start": start_timestamp, + "end": end_time_epoch, + "time": time_duration_in_seconds, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/time/{interval_id}".format( # noqa: UP032 + task_id=task_identifier, interval_id=legacy_time_interval_id + ), + method="PUT", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_time_entry( + context: ToolContext, + content_type_header: Annotated[ + str, "Specify the media type of the resource (usually 'application/json')." + ], + interval_id_for_removal: Annotated[ + str, "The unique identifier of the time entry to delete from a task." + ], + task_identifier: Annotated[ + str, + "The identifier of the task from which to delete the time entry. This must match the task ID used in ClickUp.", + ], + use_custom_task_ids: Annotated[ + bool | None, "Set to true to reference a task by its custom task ID." + ] = None, + workspace_id: Annotated[ + int | None, + "Provide the Workspace ID when `use_custom_task_ids` is `true`. Required to identify the workspace in ClickUp.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Deletetimetracked'."]: + """Delete a specific time entry from a task. + + Use this tool to delete a specific time tracking entry from a task. It's useful for managing or correcting time logs by removing unwanted entries.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/task/{task_id}/time/{interval_id}".format( # noqa: UP032 + task_id=task_identifier, interval_id=interval_id_for_removal + ), + method="DELETE", + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_time_entries_in_date_range( + context: ToolContext, + content_type: Annotated[ + str, "Specifies the format of the response content. Usually set to 'application/json'." + ], + workspace_id: Annotated[ + int, "Specify the Workspace ID for filtering time entries when using custom task IDs." + ], + end_date_unix_milliseconds: Annotated[ + float | None, + "Specify the end date in Unix time (milliseconds) to filter time entries up to this point.", + ] = None, + filter_by_assignee: Annotated[ + float | None, + "Filter by user IDs. Use commas to separate multiple IDs (e.g., '1234,9876'). Only accessible to Workspace Owners/Admins.", + ] = None, + folder_id: Annotated[ + int | None, + "Include time entries for tasks in a specific folder by providing its ID. Only one location filter (space, folder, list, or task) can be used at a time.", + ] = None, + include_approval_details: Annotated[ + bool | None, + "Include detailed approval information for each time entry, such as Approver ID, Approved Time, List of Approvers, and Approval Status.", + ] = None, + include_approval_history: Annotated[ + bool | None, + "Set to true to include the approval history for each time entry, with status changes, notes, and approvers.", + ] = None, + include_location_names: Annotated[ + bool | None, + "Include the names of the List, Folder, and Space in the response along with their IDs when set to true.", + ] = None, + include_only_billable_entries: Annotated[ + bool | None, + "Set to `true` to include only billable time entries, or `false` for non-billable entries.", + ] = None, + include_task_tags: Annotated[ + bool | None, "Set to true to include task tags in the response for associated time entries." + ] = None, + space_id: Annotated[ + int | None, + "Include time entries associated only with tasks in the specified Space using its ID.", + ] = None, + specific_list_id: Annotated[ + int | None, + "Include only time entries associated with tasks in a specified List by providing the List ID.", + ] = None, + specific_task_id: Annotated[ + str | None, "Include only time entries associated with the specified task." + ] = None, + start_date_in_unix_milliseconds: Annotated[ + float | None, "The start date of the time entries in Unix time (milliseconds)." + ] = None, + use_custom_task_ids: Annotated[ + bool | None, + "Set to true to reference tasks by their custom task IDs. Requires specifying the team_id.", + ] = None, + workspace_id_for_custom_task_ids: Annotated[ + int | None, + "Provide the Workspace ID when referencing a task by its custom task ID, and `custom_task_ids` is set to true.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Gettimeentrieswithinadaterange'."]: + """Retrieve time entries within a specified date range. + + Use this tool to view time entries filtered by start and end dates. By default, it returns entries from the last 30 days for the authenticated user. To access entries for other users, use the 'assignee' parameter. You may apply location filters with 'space_id', 'folder_id', 'list_id', or 'task_id', but only one at a time. Note: Negative duration entries indicate a running timer.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_Id}/time_entries".format( # noqa: UP032 + team_Id=workspace_id + ), + method="GET", + params=remove_none_values({ + "start_date": start_date_in_unix_milliseconds, + "end_date": end_date_unix_milliseconds, + "assignee": filter_by_assignee, + "include_task_tags": include_task_tags, + "include_location_names": include_location_names, + "include_approval_history": include_approval_history, + "include_approval_details": include_approval_details, + "space_id": space_id, + "folder_id": folder_id, + "list_id": specific_list_id, + "task_id": specific_task_id, + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id_for_custom_task_ids, + "is_billable": include_only_billable_entries, + }), + headers=remove_none_values({ + "Content-Type": content_type, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_time_entry( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + team_id_numeric: Annotated[ + int | None, + "The numeric ID of the workspace. Required if referencing a task by custom task ID. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + workspace_id: Annotated[ + int | None, + "Required if `custom_task_ids` is true. Provide the Workspace ID for the team. Only used when mode is 'execute'.", + ] = None, + use_custom_task_ids: Annotated[ + bool | None, + "Set to true to reference a task by its custom task id. Only used when mode is 'execute'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Createatimeentry'."]: + """Create a new time entry for tracking work. + + Use this tool to log a new time entry for a specific team. If the duration is negative, it indicates that a timer is running for the user. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path, query parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path, query parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["CREATETIMEENTRY"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path, query parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not team_id_numeric: + missing_params.append(("team_id_numeric", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATETIMEENTRY"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATETIMEENTRY"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/team/{team_Id}/time_entries".format( # noqa: UP032 + team_Id=team_id_numeric + ), + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["CREATETIMEENTRY"], + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_time_entry( + context: ToolContext, + content_type: Annotated[ + str, + "Specifies the format of the content being sent or received, such as 'application/json'.", + ], + time_entry_id: Annotated[ + str, + "The ID of a specific time entry, which can be found using the Get Time Entries Within a Date Range endpoint.", + ], + workspace_id: Annotated[int, "The ID of the workspace (team) to which the time entry belongs."], + include_approval_details: Annotated[ + bool | None, "Include the details of the approval for the time entry when true." + ] = None, + include_approval_history: Annotated[ + bool | None, + "Include the approval history of the time entry in the response. Set to true to include.", + ] = None, + include_location_names: Annotated[ + bool | None, + "Include names of the List, Folder, and Space in the response along with their respective IDs.", + ] = None, + include_task_tags: Annotated[ + bool | None, "Set to true to include task tags in the response." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Getsingulartimeentry'."]: + """Retrieve details of a specific time entry. + + Use this tool to view information about a single time entry, including its duration. If the duration is negative, it indicates an active timer for the user.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/time_entries/{timer_id}".format( # noqa: UP032 + team_id=workspace_id, timer_id=time_entry_id + ), + method="GET", + params=remove_none_values({ + "include_task_tags": include_task_tags, + "include_location_names": include_location_names, + "include_approval_history": include_approval_history, + "include_approval_details": include_approval_details, + }), + headers=remove_none_values({ + "Content-Type": content_type, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_time_entry( + context: ToolContext, + content_type_header: Annotated[ + str, "Specify the content type of the request, usually 'application/json'." + ], + timer_ids_to_delete: Annotated[int, "Comma-separated list of timer IDs to delete."], + workspace_id: Annotated[ + int, + "The unique identifier for the ClickUp workspace from which you want to delete the time entry.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteatimeEntry'."]: + """Deletes a time entry from a ClickUp workspace. + + Use this tool to delete a specific time entry from a ClickUp workspace. This should be called when you need to remove a recorded time entry by specifying the team and timer identifiers.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/time_entries/{timer_id}".format( # noqa: UP032 + team_id=workspace_id, timer_id=timer_ids_to_delete + ), + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_time_entry( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + workspace_id: Annotated[ + int | None, + "The Workspace ID is required when referencing a task by its custom task ID. Provide it if `custom_task_ids` is set to `true`. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + team_identifier: Annotated[ + int | None, + "The ID of the workspace (team) where the time entry is located. This is an integer value. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + timer_id: Annotated[ + int | None, + "The unique identifier of the time entry to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + use_custom_task_ids: Annotated[ + bool | None, + "Set to true to reference tasks by custom task IDs instead of standard IDs. Only used when mode is 'execute'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'UpdateatimeEntry'."]: + """Update the details of a time entry. + + This tool updates specific details of a time entry in ClickUp. Use it when you need to modify data such as the duration, description, or other attributes of an existing time entry. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path, query parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path, query parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["UPDATETIMEENTRY"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path, query parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not team_identifier: + missing_params.append(("team_identifier", "path")) + if not timer_id: + missing_params.append(("timer_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["UPDATETIMEENTRY"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["UPDATETIMEENTRY"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/team/{team_id}/time_entries/{timer_id}".format( # noqa: UP032 + team_id=team_identifier, timer_id=timer_id + ), + method="PUT", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["UPDATETIMEENTRY"], + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": team_identifier, + }), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_time_entry_changes( + context: ToolContext, + content_type_header: Annotated[ + str, + "The media type for the request, typically 'application/json'. Required for HTTP headers.", + ], + time_entry_id: Annotated[ + str, + "The ID of a time entry. This ID can be obtained using the Get Time Entries Within a Date Range endpoint.", + ], + workspace_id: Annotated[int, "The ID of the workspace (team) where the time entry resides."], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Gettimeentryhistory'."]: + """View a list of changes made to a time entry. + + Use this tool to access the history of modifications for a specific time entry within a team in ClickUp. It provides insights into various changes made on the entry, such as updates or edits.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/time_entries/{timer_id}/history".format( # noqa: UP032 + team_id=workspace_id, timer_id=time_entry_id + ), + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_current_running_time_entry( + context: ToolContext, + content_type_header: Annotated[ + str, + "The MIME type of the content, e.g., 'application/json'. Required for HTTP content negotiation.", + ], + workspace_id: Annotated[ + int, + "The ID of the workspace to retrieve the running time entry for. It identifies the specific workspace within ClickUp.", + ], + assignee_user_id: Annotated[ + float | None, + "The user ID of the time entry assignee for whom the current running timer is being retrieved. This identifies which user's timer is actively running.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Getrunningtimeentry'."]: + """Retrieve the current running time entry for the user. + + Use this tool to view the time entry that is currently tracking time for the authenticated user. It indicates which timer is actively running. A negative duration suggests an ongoing timer.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/time_entries/current".format( # noqa: UP032 + team_id=workspace_id + ), + method="GET", + params=remove_none_values({"assignee": assignee_user_id}), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_tags_from_time_entries( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + workspace_id: Annotated[ + int | None, + "The unique ID of the Workspace from which to remove labels from time entries. Must be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Removetagsfromtimeentries'."]: + """Remove labels from specific time entries. + + Use this tool to remove labels from time entries without affecting the labels in the Workspace. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["REMOVETAGSFROMTIMEENTRIES"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not workspace_id: + missing_params.append(("workspace_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["REMOVETAGSFROMTIMEENTRIES"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["REMOVETAGSFROMTIMEENTRIES"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/team/{team_id}/time_entries/tags".format( # noqa: UP032 + team_id=workspace_id + ), + method="DELETE", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["REMOVETAGSFROMTIMEENTRIES"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_time_entry_tags( + context: ToolContext, + content_type_header: Annotated[ + str, "The media type of the resource, usually set to 'application/json'." + ], + workspace_id: Annotated[int, "The unique ID of the workspace to retrieve tags from."], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Getalltagsfromtimeentries'."]: + """Retrieve all tags from time entries in a workspace. + + Use this tool to view all labels that have been applied to time entries within a specified workspace.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/time_entries/tags".format( # noqa: UP032 + team_id=workspace_id + ), + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": content_type_header, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_tag_to_time_entry( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + workspace_id: Annotated[ + int | None, + "The ID of the workspace where the time entry is located. This is required to specify which team the tag should be added to. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Addtagsfromtimeentries'."]: + """Add a label to a specific time entry in ClickUp. + + This tool is used to attach a label to a time entry for a specific team in ClickUp. It should be called when you want to organize or categorize time entries with tags for better tracking and management. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["ADDTAGTOTIMEENTRY"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not workspace_id: + missing_params.append(("workspace_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["ADDTAGTOTIMEENTRY"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["ADDTAGTOTIMEENTRY"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/team/{team_id}/time_entries/tags".format( # noqa: UP032 + team_id=workspace_id + ), + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["ADDTAGTOTIMEENTRY"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def rename_time_entry_label( + context: ToolContext, + current_label_name: Annotated[ + str, "The current name of the time entry label that needs to be renamed." + ], + foreground_color_for_tag: Annotated[ + str, "Specify the hexadecimal foreground color for the tag (e.g., '#FFFFFF')." + ], + label_background_color: Annotated[ + str, "Hex code for the new background color of the label (e.g., '#FFFFFF')." + ], + new_label_name: Annotated[ + str, "The new name for the time entry label to be applied in ClickUp." + ], + workspace_id: Annotated[ + int, + "The ID of the workspace where the label is located. This is required to specify the team in ClickUp whose label you want to rename.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'Changetagnamesfromtimeentries'."]: + """Rename a time entry label in ClickUp. + + Use this tool to change the name of a label associated with time entries for a specific team in ClickUp.""" + request_data: Any = { + "name": current_label_name, + "new_name": new_label_name, + "tag_bg": label_background_color, + "tag_fg": foreground_color_for_tag, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/time_entries/tags".format( # noqa: UP032 + team_id=workspace_id + ), + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def start_timer_clickup( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + workspace_identifier: Annotated[ + int | None, + "The Workspace ID required when custom task IDs are used. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + workspace_id: Annotated[ + int | None, + "Provide the Workspace ID when `custom_task_ids` is `true`. Required for task referencing. Only used when mode is 'execute'.", + ] = None, + use_custom_task_ids: Annotated[ + bool | None, + "Set to true to reference a task by its custom task ID. Only used when mode is 'execute'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'StartatimeEntry'."]: + """Start a timer for the authenticated ClickUp user. + + Use this tool to initiate a timer for the authenticated user in ClickUp. It is ideal for tracking time on specific tasks or projects. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path, query parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path, query parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["STARTTIMERCLICKUP"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path, query parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not workspace_identifier: + missing_params.append(("workspace_identifier", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["STARTTIMERCLICKUP"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["STARTTIMERCLICKUP"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/team/{team_Id}/time_entries/start".format( # noqa: UP032 + team_Id=workspace_identifier + ), + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["STARTTIMERCLICKUP"], + params=remove_none_values({ + "custom_task_ids": use_custom_task_ids, + "team_id": workspace_id, + }), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def stop_timer_entry( + context: ToolContext, + content_type: Annotated[ + str, "Specifies the media type of the request. Usually 'application/json'." + ], + workspace_id: Annotated[ + int, "The ID of the workspace where the timer is running. Required to stop the timer." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'StopatimeEntry'."]: + """Stops a running timer for the authenticated user. + + Use this tool to stop a currently running timer for the authenticated user on ClickUp. This action is initiated for a specific team, requiring the team ID.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/time_entries/stop".format( # noqa: UP032 + team_id=workspace_id + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": content_type, + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def invite_user_to_workspace( + context: ToolContext, + invite_as_admin: Annotated[ + bool, + "Indicate if the user should be invited as an admin. True for admin, False for regular member.", + ], + user_email: Annotated[ + str, + "The email address of the user to be invited to the Workspace. Must be a valid email format.", + ], + workspace_id: Annotated[ + int, "The unique ID of the workspace to which the user is being invited." + ], + custom_role_id: Annotated[ + int | None, + "The ID of the custom role to assign to the user in the Workspace. Must be an integer.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'InviteUserToWorkspace'."]: + """Invite a user to your ClickUp Workspace as a member. + + Use this tool to invite someone to your ClickUp Workspace as a member. This is suitable for Workspaces on the Enterprise Plan. For inviting guests, use the appropriate tool instead.""" + request_data: Any = { + "email": user_email, + "admin": invite_as_admin, + "custom_role_id": custom_role_id, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/user".format(team_id=workspace_id), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_workspace_user_info( + context: ToolContext, + user_id: Annotated[ + int, + "The unique identifier of the user to retrieve information for. This is required to specify which user's information is being accessed in the workspace.", + ], + workspace_id: Annotated[ + int, + "The unique ID of the Workspace. Used to specify which Workspace's user information is to be retrieved.", + ], + show_shared_items: Annotated[ + bool | None, + "Set to `true` to include details of shared items; `false` excludes them by default.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetUser'."]: + """Retrieve user information from a specified workspace. + + Call this tool to get details about a user from a specific workspace on the ClickUp platform. This tool is applicable only to Workspaces that are on the Enterprise Plan.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/user/{user_id}".format( # noqa: UP032 + team_id=workspace_id, user_id=user_id + ), + method="GET", + params=remove_none_values({"include_shared": show_shared_items}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_user_workspace_details( + context: ToolContext, + assign_admin_role: Annotated[ + bool, "Set to true to assign the user as an admin in the workspace, otherwise false." + ], + custom_role_id: Annotated[ + int, + "An integer representing the custom role ID to assign to the user in the workspace. This is required for users with specific roles.", + ], + user_identifier: Annotated[ + int, + "The unique identifier for the user within the workspace. This value is required to specify which user's details need updating.", + ], + user_name: Annotated[ + str, "The new full name of the user to be updated in the ClickUp workspace." + ], + workspace_id: Annotated[ + int, "The ID of the ClickUp workspace where the user's details will be updated." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'EditUserOnWorkspace'."]: + """Update a user's name and role in a ClickUp workspace. + + This tool updates a user's name and role within a specific ClickUp workspace. It's only available to Workspaces on the Enterprise Plan. Use it to change user details in a team.""" + request_data: Any = { + "username": user_name, + "admin": assign_admin_role, + "custom_role_id": custom_role_id, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/user/{user_id}".format( # noqa: UP032 + team_id=workspace_id, user_id=user_identifier + ), + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def remove_user_from_workspace( + context: ToolContext, + user_id: Annotated[int, "The ID of the user to be deactivated from the workspace."], + workspace_id: Annotated[ + int, "The ID of the Workspace in ClickUp from which the user will be removed." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'RemoveUserFromWorkspace'."]: + """Remove a user from a ClickUp workspace. + + Use this tool to deactivate a user from a ClickUp workspace, applicable for Workspaces on the Enterprise Plan.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/user/{user_id}".format( # noqa: UP032 + team_id=workspace_id, user_id=user_id + ), + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_team_views( + context: ToolContext, + workspace_id: Annotated[ + int, "The ID of the workspace to retrieve task and page views from in ClickUp." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetTeamViews'."]: + """Retrieve task and page views at the workspace level. + + Use this tool to view the task and page views available at the Everything Level of a specified workspace in ClickUp.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/view".format(team_id=workspace_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def create_team_view( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + workspace_id: Annotated[ + int | None, + "The unique identifier for the workspace where the view will be added. This corresponds to the team or workspace ID. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateTeamView'."]: + """Add various views to a workspace at the Everything Level. + + This tool allows you to add different types of views such as List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt to a specified workspace within a team. Use this when you need to create or organize views for better workspace management. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["CREATETEAMVIEW"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not workspace_id: + missing_params.append(("workspace_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATETEAMVIEW"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["CREATETEAMVIEW"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/team/{team_id}/view".format(team_id=workspace_id), # noqa: UP032 + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["CREATETEAMVIEW"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_space_views( + context: ToolContext, + space_identifier: Annotated[ + int, "The unique integer ID of the space for which to retrieve task and page views." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetSpaceViews'."]: + """Retrieve the task and page views for a specified Space. + + This tool is used to obtain the task and page views available within a specific Space in ClickUp. It should be called when you need to explore or list the views associated with a given space by providing the space ID.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/space/{space_id}/view".format( # noqa: UP032 + space_id=space_identifier + ), + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_space_view( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + space_id: Annotated[ + int | None, + "The unique identifier of the ClickUp space where the view will be added. It should be an integer. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateSpaceView'."]: + """Add a new view to a ClickUp space. + + Use this tool to add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a ClickUp Space. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["ADDSPACEVIEW"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not space_id: + missing_params.append(("space_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["ADDSPACEVIEW"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["ADDSPACEVIEW"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/space/{space_id}/view".format(space_id=space_id), # noqa: UP032 + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["ADDSPACEVIEW"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_folder_views( + context: ToolContext, + folder_id: Annotated[ + int, "The ID of the folder to retrieve views for. This should be an integer value." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetFolderViews'."]: + """Retrieve available task and page views for a Folder in ClickUp.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/folder/{folder_id}/view".format(folder_id=folder_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_view_to_folder( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + folder_id: Annotated[ + int | None, + "The unique integer ID of the ClickUp folder where the view will be added. Required for specifying the target folder. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateFolderView'."]: + """Add various view types to a ClickUp folder. + + Use this tool to add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a specific folder in ClickUp. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["ADDVIEWTOFOLDER"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not folder_id: + missing_params.append(("folder_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["ADDVIEWTOFOLDER"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["ADDVIEWTOFOLDER"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/folder/{folder_id}/view".format(folder_id=folder_id), # noqa: UP032 + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["ADDVIEWTOFOLDER"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_list_views( + context: ToolContext, + target_list_id: Annotated[ + int, "The unique identifier for the list to retrieve views from. This should be an integer." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetListViews'."]: + """Retrieve available views for a specific list. + + Use this tool to view the task and page views available for a specific list in ClickUp. It retrieves both regular and required views.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/list/{list_id}/view".format(list_id=target_list_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def add_view_to_clickup_list( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + clickup_list_id: Annotated[ + int | None, + "An integer representing the ID of the ClickUp list to which the view will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateListView'."]: + """Add various views to a ClickUp list. + + Use this tool to add different types of views (List, Board, Calendar, etc.) to a specific ClickUp list using the list ID. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["ADDVIEWTOCLICKUPLIST"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not clickup_list_id: + missing_params.append(("clickup_list_id", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["ADDVIEWTOCLICKUPLIST"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["ADDVIEWTOCLICKUPLIST"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/list/{list_id}/view".format(list_id=clickup_list_id), # noqa: UP032 + method="POST", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["ADDVIEWTOCLICKUPLIST"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def view_task_or_page_info( + context: ToolContext, + view_identifier: Annotated[ + str, + "A unique identifier for the specific task or page view in ClickUp to be retrieved. This is required to obtain the relevant information.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetView'."]: + """Retrieve details of a specific task or page view. + + Use this tool to get detailed information about a specific task or page view in ClickUp using the view ID.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/view/{view_id}".format(view_id=view_identifier), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_view_settings( + context: ToolContext, + mode: Annotated[ + ToolMode, + "Operation mode: 'get_request_schema' returns the OpenAPI spec " + "for the request body, 'execute' performs the actual operation", + ], + view_identifier: Annotated[ + str | None, + "The unique identifier for the view to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.", + ] = None, + request_body: Annotated[ + str | None, + "Stringified JSON representing the request body. Required when " + "mode is 'execute', ignored when mode is 'get_request_schema'", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'UpdateView'."]: + """Update the settings and configuration of a view. + + Rename, regroup, sort, filter, and modify columns and settings of a view when needing to adjust its configuration. + + Note: Understanding the request schema is necessary to properly create + the stringified JSON input object for execution.\n\nThis operation also requires path parameters. + + Modes: + - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't + already have it. Do NOT call repeatedly if you already received + the schema. + - EXECUTE: Performs the operation with the provided request body + JSON.\n Note: You must also provide the required path parameters when executing. + + If you need the schema, call with mode='get_request_schema' ONCE, then execute. + """ + if mode == ToolMode.GET_REQUEST_SCHEMA: + return { + "request_body_schema": REQUEST_BODY_SCHEMAS["UPDATEVIEWSETTINGS"], + "instructions": ( + "Use the request_body_schema to construct a valid JSON object. " + "Once you have populated the object following the schema " + "structure and requirements, call this tool again with " + "mode='execute' and the stringified JSON as the " + "request_body parameter along with the required path parameters. " + "Do NOT call the schema mode again - you already have " + "the schema now." + ), + } + + # Mode is EXECUTE - validate parameters + # Validate required parameters + missing_params = [] + if not view_identifier: + missing_params.append(("view_identifier", "path")) + + if missing_params: + param_names = [p[0] for p in missing_params] + param_details = ", ".join([f"{p[0]} ({p[1]})" for p in missing_params]) + raise RetryableToolError( + message=f"Missing required parameters: {param_names}", + developer_message=(f"Required parameters validation failed: {param_details}"), + additional_prompt_content=( + f"The following required parameters are missing: " + f"{param_details}. Please call this tool again with all " + "required parameters." + ), + ) + + # Validate request body is provided (not None or empty string) + # Note: Empty objects like {} are allowed - schema validation will check if valid + if request_body is None or request_body.strip() == "": + raise RetryableToolError( + message="Request body is required when mode is 'execute'", + developer_message="The request_body parameter was null or empty string", + additional_prompt_content=( + "The request body is required to perform this operation. " + "Use the schema below to construct a valid JSON object, " + "then call this tool again in execute mode with the " + "stringified JSON as the request_body parameter.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["UPDATEVIEWSETTINGS"] + "\n```" + ), + ) + + # Parse JSON + try: + request_data = json.loads(request_body) + except json.JSONDecodeError as e: + raise RetryableToolError( + message=f"Invalid JSON in request body: {e!s}", + developer_message=f"JSON parsing failed: {e!s}", + additional_prompt_content=( + f"The request body contains invalid JSON. Error: {e!s}\n\n" + "Please provide a valid JSON string that matches the schema " + "below, then call this tool again in execute mode.\n\n" + "Schema:\n\n```json\n" + REQUEST_BODY_SCHEMAS["UPDATEVIEWSETTINGS"] + "\n```" + ), + ) from e + + response = await make_request_with_schema_validation( + url="https://api.clickup.com/api/v2/view/{view_id}".format(view_id=view_identifier), # noqa: UP032 + method="PUT", + request_data=request_data, + schema=REQUEST_BODY_SCHEMAS["UPDATEVIEWSETTINGS"], + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_view( + context: ToolContext, + view_id: Annotated[ + str, "The ID of the view to be deleted in ClickUp. Must be provided as a string." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteView'."]: + """Delete a specified view from ClickUp. + + Use this tool to delete a specific view in ClickUp by providing the view ID. Useful for managing and organizing views by removing those that are no longer needed.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/view/{view_id}".format(view_id=view_id), # noqa: UP032 + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_visible_tasks_in_view( + context: ToolContext, + pagination_page_number: Annotated[ + int, + "The specific page number of tasks to retrieve. Used for pagination in task lists, starting at 1.", + ], + view_identifier: Annotated[ + str, "The ID of the ClickUp view from which to retrieve visible tasks. Must be a string." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetViewTasks'."]: + """Retrieve all visible tasks from a ClickUp view. + + Use this tool to obtain a list of all tasks that are visible in a specific view within ClickUp. It is useful for task management and organization within the platform.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/view/{view_id}/task".format(view_id=view_identifier), # noqa: UP032 + method="GET", + params=remove_none_values({"page": pagination_page_number}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def get_workspace_webhooks( + context: ToolContext, + workspace_id: Annotated[int, "The ID of the Workspace to retrieve the webhooks for."], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'GetWebhooks'."]: + """Retrieve webhooks for a workspace. + + Use this tool to view the webhooks created via the API for a specific Workspace. It returns webhooks created by the authenticated user.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/webhook".format(team_id=workspace_id), # noqa: UP032 + method="GET", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def setup_clickup_webhook( + context: ToolContext, + event_types: Annotated[ + list[str], + "An array of event types to subscribe to, or use `*` to subscribe to all events. Refer to ClickUp documentation for available options.", + ], + webhook_url: Annotated[ + str, + "The URL where the webhook will send POST requests. Must be reachable to receive event data.", + ], + workspace_id: Annotated[ + int, + "The ID of the workspace where the webhook will be set up. Use this to specify the team context for monitoring.", + ], + folder_id: Annotated[ + int | None, + "Specify the folder ID in ClickUp for which the webhook is to be created. It should be an integer value representing the folder.", + ] = None, + space_identifier: Annotated[ + int | None, + "The numeric ID of the space within a ClickUp workspace for which the webhook is set up.", + ] = None, + specific_task_id: Annotated[ + str | None, + "Unique identifier for a specific task to monitor. Leave empty if not targeting a specific task.", + ] = None, + target_list_id: Annotated[ + int | None, "The ID of the list in ClickUp for which you want to set up a webhook." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint 'CreateWebhook'."]: + """Set up a ClickUp webhook to monitor events. + + Use this tool to create a webhook in ClickUp, enabling monitoring of events for a specific team. Useful for triggering actions or notifications based on certain events within a ClickUp team.""" + request_data: Any = { + "endpoint": webhook_url, + "events": event_types, + "space_id": space_identifier, + "folder_id": folder_id, + "list_id": target_list_id, + "task_id": specific_task_id, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/team/{team_id}/webhook".format(team_id=workspace_id), # noqa: UP032 + method="POST", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def update_clickup_webhook_events( + context: ToolContext, + monitored_events: Annotated[ + str, + "A comma-separated list of events for the webhook to monitor. Use valid event names as per ClickUp webhook documentation.", + ], + webhook_endpoint_url: Annotated[ + str, + "The URL where the webhook should send POST requests for the events. Must be a valid and accessible URL.", + ], + webhook_identifier: Annotated[ + str, "The unique identifier for the webhook to be updated, formatted as a UUID." + ], + webhook_status: Annotated[ + str, + "Specify the new status of the webhook. Use 'active' to enable or 'inactive' to disable it.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'UpdateWebhook'."]: + """Update a ClickUp webhook to modify monitored events. + + Use this tool to update the events a ClickUp webhook monitors, allowing for changes to event tracking as needed.""" + request_data: Any = { + "endpoint": webhook_endpoint_url, + "events": monitored_events, + "status": webhook_status, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/webhook/{webhook_id}".format( # noqa: UP032 + webhook_id=webhook_identifier + ), + method="PUT", + params=remove_none_values({}), + headers=remove_none_values({ + "Content-Type": "application/json", + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ), + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_auth=OAuth2(id="arcade-clickup")) +async def delete_webhook( + context: ToolContext, + webhook_id: Annotated[ + str, "The unique identifier for the webhook to be deleted. Must be in UUID format." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint 'DeleteWebhook'."]: + """Delete a webhook to stop event monitoring. + + Use this tool to delete a webhook, which will stop monitoring events and locations associated with it. Useful for managing and updating your event tracking preferences.""" + request_data: Any = {} + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://api.clickup.com/api/v2/webhook/{webhook_id}".format(webhook_id=webhook_id), # noqa: UP032 + method="DELETE", + params=remove_none_values({}), + headers=remove_none_values({ + "Authorization": "Bearer {authorization}".format( # noqa: UP032 + authorization=context.get_auth_token_or_empty() + ) + }), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} diff --git a/toolkits/clickup_api/clickup_api/tools/request_body_schemas.py b/toolkits/clickup_api/clickup_api/tools/request_body_schemas.py new file mode 100644 index 00000000..341ec1ec --- /dev/null +++ b/toolkits/clickup_api/clickup_api/tools/request_body_schemas.py @@ -0,0 +1,34 @@ +"""Request Body Schemas for API Tools + +DO NOT EDIT THIS MODULE DIRECTLY. + +THIS MODULE WAS AUTO-GENERATED AND CONTAINS OpenAPI REQUEST BODY SCHEMAS +FOR TOOLS WITH COMPLEX REQUEST BODIES. ANY CHANGES TO THIS MODULE WILL +BE OVERWRITTEN BY THE TRANSPILER. +""" + +from typing import Any + +REQUEST_BODY_SCHEMAS: dict[str, Any] = { + "GETCLICKUPACCESSTOKEN": '{"title": "GetAccessTokenrequest", "required": ["client_id", "client_secret", "code"], "type": "object", "properties": {"client_id": {"type": "string", "description": "OAuth app client id"}, "client_secret": {"type": "string", "description": "OAuth app client secret"}, "code": {"type": "string", "description": "Code given in redirect url"}}, "examples": [{"client_id": "your_client_id", "client_secret": "your_client_secret", "code": "authorization_code"}]}', + "CREATETHREADEDCOMMENT": '{"type": "object", "description": "Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1comment/post/requestBody/content/application~1json/schema", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/post/requestBody/content/application~1json/schema"}', + "UPDATETASKCUSTOMFIELD": '{"title": "SetCustomFieldValuerequest", "anyOf": [{"type": "object", "title": "URL Custom Field", "description": "The `value` must be a string with a valid URL.", "required": ["value"], "properties": {"value": {"type": "string", "example": "https://clickup.com/api"}}}, {"type": "object", "title": "Dropdown Custom Field", "description": "Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.", "required": ["value"], "properties": {"value": {"type": "string", "example": "uuid1234"}}}, {"type": "object", "title": "Email Custom Field", "description": "The `value` must be a string with a valid email address.", "required": ["value"], "properties": {"value": {"type": "string", "example": "user@company.com"}}}, {"type": "object", "title": "Phone Custom Field", "description": "The `value` must be a string with a valid country code.", "required": ["value"], "properties": {"value": {"type": "string", "example": "+1 123 456 7890"}}}, {"type": "object", "title": "Date Custom Field", "description": "The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.", "properties": {"value": {"type": "integer", "format": "int32", "example": 1667367645000}, "value_options": {"type": "object", "required": ["time"], "properties": {"time": {"type": "boolean", "example": true}}}}}, {"type": "object", "title": "Short or Long Text Custom Field", "description": "Enter a string of text.", "required": ["value"], "properties": {"value": {"type": "string", "example": "This is short or long text in a Custom Field."}}}, {"type": "object", "title": "Number Custom Field", "description": "Enter a number.", "required": ["value"], "properties": {"value": {"type": "number", "example": -28}}}, {"type": "object", "title": "Money Custom Field", "description": "You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", "required": ["value"], "properties": {"value": {"type": "number", "example": 8000}}}, {"type": "object", "title": "Task Relationship Custom Field", "description": "Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship.", "required": ["value"], "properties": {"value": {"type": "object", "properties": {"add": {"type": "array", "items": {"type": "string"}}, "rem": {"type": "array", "items": {"type": "string"}}}}}}, {"type": "object", "title": "People Custom Field", "description": "Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams)", "required": ["value"], "properties": {"value": {"type": "object", "properties": {"add": {"type": "array", "items": {"type": "number"}}, "rem": {"type": "array", "items": {"type": "number"}}}}}}, {"type": "object", "title": "Emoji (Rating) Custom Field", "description": "Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", "required": ["value"], "properties": {"value": {"type": "integer", "format": "int32", "example": 4}}}, {"type": "object", "title": "Manual Progress Custom Field", "description": "Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", "required": ["value"], "properties": {"value": {"type": "object", "required": ["current"], "properties": {"current": {"type": "number", "example": 20}}}}}, {"type": "object", "title": "Label Custom Field", "description": "Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", "required": ["value"], "properties": {"value": {"type": "array", "items": {"type": "string", "example": ["uuid1234", "uuid9876"]}}}}, {"type": "object", "title": "Location Custom Field", "description": "Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)", "required": ["value"], "properties": {"value": {"type": "object", "properties": {"location": {"type": "object", "properties": {"lat": {"type": "number"}, "lng": {"type": "number"}}}, "formatted_address": {"type": "string"}}}}}, {"type": "object", "title": "Button Custom Field", "description": "Set a button Custom Field to `true` to "click" it. This will trigger the button\'s action as if it was clicked in the UI.", "required": ["value"], "properties": {"value": {"type": "boolean", "example": true}}}]}', + "CREATEFOLDERFROMTEMPLATE": '{"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "description": "Name of the new Folder"}, "options": {"type": "object", "description": "Options for creating the Folder", "properties": {"return_immediately": {"type": "boolean", "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n", "default": true}, "content": {"type": "string", "description": "List description"}, "time_estimate": {"type": "boolean", "description": "Include time (hours, minutes and seconds)"}, "automation": {"type": "boolean", "description": "Import automation options"}, "include_views": {"type": "boolean", "description": "Import views"}, "old_due_date": {"type": "boolean", "description": "Import tasks due dates"}, "old_start_date": {"type": "boolean", "description": "Import tasks start dates"}, "old_followers": {"type": "boolean", "description": "Import tasks watchers"}, "comment_attachments": {"type": "boolean", "description": "Import tasks comment attachments"}, "recur_settings": {"type": "boolean", "description": "Import tasks recurring settings"}, "old_tags": {"type": "boolean", "description": "Import tasks tags"}, "old_statuses": {"type": "boolean", "description": "Import tasks status settings"}, "subtasks": {"type": "boolean", "description": "Import tasks subtasks"}, "custom_type": {"type": "boolean", "description": "Import tasks types"}, "old_assignees": {"type": "boolean", "description": "Import tasks assignees"}, "attachments": {"type": "boolean", "description": "Import tasks attachments"}, "comment": {"type": "boolean", "description": "Import tasks comments"}, "old_status": {"type": "boolean", "description": "Import tasks current statuses"}, "external_dependencies": {"type": "boolean", "description": "Import tasks external dependencies"}, "internal_dependencies": {"type": "boolean", "description": "Import tasks internal dependencies"}, "priority": {"type": "boolean", "description": "Import tasks priority"}, "custom_fields": {"type": "boolean", "description": "Import tasks Custom Fields"}, "old_checklists": {"type": "boolean", "description": "Import tasks checklists"}, "relationships": {"type": "boolean", "description": "Import tasks relationships"}, "old_subtask_assignees": {"type": "boolean", "description": "Import tasks subtasks and assignees combination"}, "start_date": {"type": "string", "format": "date-time", "description": "Project start date for remapping dates"}, "due_date": {"type": "string", "format": "date-time", "description": "Project due date for remapping dates"}, "remap_start_date": {"type": "boolean", "description": "Remap start dates"}, "skip_weekends": {"type": "boolean", "description": "Skip weekends when remapping dates"}, "archived": {"type": "integer", "enum": [1, 2, null], "description": "Include archived tasks (1 or 2 or null)"}}}}}', + "CREATESPACEINWORKSPACE": '{"title": "CreateSpacerequest", "required": ["name", "multiple_assignees", "features"], "type": "object", "properties": {"name": {"type": "string"}, "multiple_assignees": {"type": "boolean"}, "features": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features"}}, "examples": [{"name": "New Space Name", "multiple_assignees": true, "features": {"due_dates": {"enabled": true, "start_date": false, "remap_due_dates": true, "remap_closed_due_date": false}, "time_tracking": {"enabled": false}, "tags": {"enabled": true}, "time_estimates": {"enabled": true}, "checklists": {"enabled": true}, "custom_fields": {"enabled": true}, "remap_dependencies": {"enabled": true}, "dependency_warning": {"enabled": true}, "portfolios": {"enabled": true}}}]}', + "UPDATECLICKUPSPACE": '{"title": "UpdateSpacerequest", "required": ["name", "color", "private", "admin_can_manage", "multiple_assignees", "features"], "type": "object", "properties": {"name": {"type": "string"}, "color": {"type": "string"}, "private": {"type": "boolean"}, "admin_can_manage": {"description": "***Note:** Allowing or restricting admins from managing private Spaces using `"admin_can_manage"` is an [Enterprise Plan](https://clickup.com/pricing) feature.*", "type": "boolean"}, "multiple_assignees": {"type": "boolean"}, "features": {"title": "Features", "required": ["due_dates", "time_tracking", "tags", "time_estimates", "checklists", "custom_fields", "remap_dependencies", "dependency_warning", "portfolios"], "type": "object", "properties": {"due_dates": {"title": "DueDates", "required": ["enabled", "start_date", "remap_due_dates", "remap_closed_due_date"], "type": "object", "properties": {"enabled": {"type": "boolean"}, "start_date": {"type": "boolean"}, "remap_due_dates": {"type": "boolean"}, "remap_closed_due_date": {"type": "boolean"}}, "examples": [{"enabled": true, "start_date": false, "remap_due_dates": true, "remap_closed_due_date": false}]}, "time_tracking": {"title": "TimeTracking", "required": ["enabled"], "type": "object", "properties": {"enabled": {"type": "boolean"}}, "examples": [{"enabled": false}]}, "tags": {"title": "Tags", "required": ["enabled"], "type": "object", "properties": {"enabled": {"type": "boolean"}}, "examples": [{"enabled": true}]}, "time_estimates": {"title": "TimeEstimates", "required": ["enabled"], "type": "object", "properties": {"enabled": {"type": "boolean"}}, "examples": [{"enabled": true}]}, "checklists": {"title": "Checklists", "required": ["enabled"], "type": "object", "properties": {"enabled": {"type": "boolean"}}, "examples": [{"enabled": true}]}, "custom_fields": {"title": "CustomFields", "required": ["enabled"], "type": "object", "properties": {"enabled": {"type": "boolean"}}, "examples": [{"enabled": true}]}, "remap_dependencies": {"title": "RemapDependencies", "required": ["enabled"], "type": "object", "properties": {"enabled": {"type": "boolean"}}, "examples": [{"enabled": true}]}, "dependency_warning": {"title": "DependencyWarning", "required": ["enabled"], "type": "object", "properties": {"enabled": {"type": "boolean"}}, "examples": [{"enabled": true}]}, "portfolios": {"title": "Portfolios", "required": ["enabled"], "type": "object", "properties": {"enabled": {"type": "boolean"}}, "examples": [{"enabled": true}]}}, "examples": [{"due_dates": {"enabled": true, "start_date": false, "remap_due_dates": true, "remap_closed_due_date": false}, "time_tracking": {"enabled": false}, "tags": {"enabled": true}, "time_estimates": {"enabled": true}, "checklists": {"enabled": true}, "custom_fields": {"enabled": true}, "remap_dependencies": {"enabled": true}, "dependency_warning": {"enabled": true}, "portfolios": {"enabled": true}}]}}, "examples": [{"name": "Updated Space Name", "color": "#7B68EE", "private": false, "admin_can_manage": false, "multiple_assignees": false, "features": {"due_dates": {"enabled": false, "start_date": false, "remap_due_dates": false, "remap_closed_due_date": false}, "time_tracking": {"enabled": false}, "tags": {"enabled": false}, "time_estimates": {"enabled": false}, "checklists": {"enabled": true}, "custom_fields": {"enabled": true}, "remap_dependencies": {"enabled": false}, "dependency_warning": {"enabled": false}, "portfolios": {"enabled": false}}}]}', + "DELETESPACETAG": '{"title": "DeleteSpaceTagrequest", "required": ["tag"], "type": "object", "properties": {"tag": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag"}}, "examples": [{"tag": {"name": "Tag name", "tag_fg": "#000000", "tag_bg": "#000000"}}]}', + "CREATENEWCLICKUPTASK": '{"title": "CreateTaskrequest", "required": ["name"], "type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "assignees": {"type": "array", "items": {"type": "integer", "contentEncoding": "int32"}, "description": ""}, "archived": {"type": "boolean"}, "group_assignees": {"type": "array", "items": {"type": "string"}, "description": "Assign multiple user groups to the task."}, "tags": {"type": "array", "items": {"type": "string"}, "description": ""}, "status": {"type": "string"}, "priority": {"type": ["integer", "null"], "contentEncoding": "int32"}, "due_date": {"type": "integer", "contentEncoding": "int64"}, "due_date_time": {"type": "boolean"}, "time_estimate": {"type": "integer", "contentEncoding": "int32"}, "start_date": {"type": "integer", "contentEncoding": "int64"}, "start_date_time": {"type": "boolean"}, "points": {"type": "number", "description": "Add Sprint Points to the task."}, "notify_all": {"type": "boolean", "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment."}, "parent": {"description": "You can create a subtask by including an existing task ID.\\\n \\\nThe `parent` task ID you include can be a subtask, but must be in the same List specified in the path parameter.", "type": ["string", "null"]}, "markdown_content": {"type": "string", "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`."}, "links_to": {"description": "Include a task ID to create a linked dependency with your new task.", "type": ["string", "null"]}, "check_required_custom_fields": {"description": "When creating a task via API any required Custom Fields are ignored by default (`false`).\\\n \\\nYou can enforce required Custom Fields by including `check_required_custom_fields: true`.", "type": "boolean"}, "custom_fields": {"type": "array", "items": {"title": "SetCustomFieldValueOnCreateTaskrequest", "anyOf": [{"type": "object", "title": "URL Custom Field", "description": "The `value` must be a string with a valid URL.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": ["string", "null"], "example": "https://clickup.com/api"}}}, {"type": "object", "title": "Dropdown Custom Field", "description": "Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": ["string", "null"], "example": "uuid1234"}}}, {"type": "object", "title": "Email Custom Field", "description": "The `value` must be a string with a valid email address.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": ["string", "null"], "example": "user@company.com"}}}, {"type": "object", "title": "Phone Custom Field", "description": "The `value` must be a string with a valid country code.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": ["string", "null"], "example": "+1 123 456 7890"}}}, {"type": "object", "title": "Date Custom Field", "description": "The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": ["integer", "null"], "format": "int32", "example": 1667367645000}, "value_options": {"type": "object", "properties": {"time": {"type": "boolean", "example": true}}}}}, {"type": "object", "title": "Short or Long Text Custom Field", "description": "Enter a string of text.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": ["string", "null"], "example": "This is short or long text in a Custom Field."}}}, {"type": "object", "title": "Number Custom Field", "description": "Enter a number.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": ["number", "null"], "example": -28}}}, {"type": "object", "title": "Money Custom Field", "description": "You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": ["number", "null"], "example": 8000}}}, {"type": "object", "title": "Task Relationship Custom Field", "description": "Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship. Task Relationship Custom Fields are nullable: `"value": null`.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": "object", "properties": {"add": {"type": "array", "items": {"type": "string"}}, "rem": {"type": "array", "items": {"type": "string"}}}}}}, {"type": "object", "title": "People Custom Field", "description": "Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams) People Custom Fields are nullable: `"value": null`.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": "object", "properties": {"add": {"type": "array", "items": {"type": "number"}}, "rem": {"type": "array", "items": {"type": "number"}}}}}}, {"type": "object", "title": "Emoji (Rating) Custom Field", "description": "Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": ["integer", "null"], "format": "int32", "example": 4}}}, {"type": "object", "title": "Manual Progress Custom Field", "description": "Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) Manual Progress Custom Fields are nullable: `"value": null`.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": "object", "required": ["current"], "properties": {"current": {"type": "number", "example": 20}}}}}, {"type": "object", "title": "Label Custom Field", "description": "Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) Label Custom Fields are nullable: `"value": null`.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": "array", "items": {"type": "string", "example": ["uuid1234", "uuid9876"]}}}}, {"type": "object", "title": "Location Custom Field", "description": "Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": "object", "properties": {"location": {"type": "object", "properties": {"lat": {"type": "number"}, "lng": {"type": "number"}}}, "formatted_address": {"type": "string"}}}}}, {"type": "object", "title": "Button Custom Field", "description": "Set a button Custom Field to `true` to "click" it. This will trigger the button\'s action as if it was clicked in the UI.", "required": ["id", "value"], "properties": {"id": {"type": "string"}, "value": {"type": ["boolean", "null"], "example": true}}}]}, "description": "You can include one or more Custom Fields to set them when creating a new task.\\\n \\\nCustom Fields that use object and array type values are nullable by sending `"value": null`."}, "custom_item_id": {"type": "number", "description": "The custom task type ID for this task. A value of `null` (default) creates a standard task type "Task".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)."}}, "examples": [{"name": "New Task Name", "description": "New Task Description", "assignees": [183], "archived": false, "group_assignees": ["dd01f92f-48ca-446d-88a1-0beb0e8f5f14"], "tags": ["tag name 1"], "status": "Open", "priority": 3, "due_date": 1508369194377, "due_date_time": false, "time_estimate": 8640000, "start_date": 1567780450202, "start_date_time": false, "points": 3, "notify_all": true, "parent": null, "links_to": null, "check_required_custom_fields": true, "custom_fields": [{"id": "0a52c486-5f05-403b-b4fd-c512ff05131c", "value": 23}, {"id": "03efda77-c7a0-42d3-8afd-fd546353c2f5", "value": "Text field input"}]}]}', + "UPDATETASKINCLICKUP": '{"title": "UpdateTaskrequest", "type": "object", "properties": {"custom_item_id": {"type": ["number", "null"], "description": "The custom task type ID for this task. A value of `null` (default) sets the task type to type "Task".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)."}, "name": {"type": "string"}, "description": {"description": "To clear the task description, include `Description` with `" "`.", "type": "string"}, "markdown_content": {"type": "string", "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`."}, "status": {"type": "string"}, "priority": {"type": "integer", "contentEncoding": "int32"}, "due_date": {"type": "integer", "contentEncoding": "int64"}, "due_date_time": {"type": "boolean"}, "parent": {"description": "You can move a subtask to another parent task by including `"parent"` with a valid `task id`.\\\n \\\nYou cannot convert a subtask to a task by setting `"parent"` to `null`.", "type": "string"}, "time_estimate": {"type": "integer", "contentEncoding": "int32"}, "start_date": {"type": "integer", "contentEncoding": "int64"}, "start_date_time": {"type": "boolean"}, "points": {"type": "number", "description": "Update the task\'s Sprint Points."}, "assignees": {"title": "Assignees", "required": ["add", "rem"], "type": "object", "properties": {"add": {"type": "array", "items": {"type": "integer", "contentEncoding": "int32"}, "description": ""}, "rem": {"type": "array", "items": {"type": "integer", "contentEncoding": "int32"}, "description": ""}}, "examples": [{"add": [182], "rem": [183]}]}, "group_assignees": {"type": "object", "properties": {"add": {"type": "array", "items": {"type": "integer", "contentEncoding": "int32"}, "description": ""}, "rem": {"type": "array", "items": {"type": "integer", "contentEncoding": "int32"}, "description": ""}}}, "watchers": {"title": "Watchers", "required": ["add", "rem"], "type": "object", "properties": {"add": {"type": "array", "items": {"type": "integer", "contentEncoding": "int32"}, "description": ""}, "rem": {"type": "array", "items": {"type": "integer", "contentEncoding": "int32"}, "description": ""}}, "examples": [{"add": [182, 121], "rem": [183, 122]}]}, "archived": {"type": "boolean"}}, "examples": [{"name": "Updated Task Name", "description": "Updated Task Content", "status": "in progress", "priority": 1, "due_date": 1508369194377, "due_date_time": false, "parent": "abc1234", "time_estimate": 8640000, "start_date": 1567780450202, "start_date_time": false, "points": 3, "assignees": {"add": [182], "rem": [183]}, "group_assignees": {"add": ["dd01f92f-48ca-446d-88a1-0beb0e8f5f14"], "rem": ["dd01f92f-48ca-446d-88a1-0beb0e8f5f13"]}, "watchers": {"add": [182], "rem": [183]}, "archived": false}]}', + "CREATELISTFROMFOLDERTEMPLATE": '{"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "description": "Name of the new List"}, "options": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options"}}}', + "CREATELISTFROMTEMPLATE": '{"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "description": "Name of the new List"}, "options": {"type": "object", "description": "Options for creating the List", "properties": {"return_immediately": {"type": "boolean", "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n", "default": true}, "content": {"type": "string", "description": "List description"}, "time_estimate": {"type": "number", "description": "Include time (hours, minutes and seconds)"}, "automation": {"type": "boolean", "description": "Import automation settings"}, "include_views": {"type": "boolean", "description": "Import views"}, "old_due_date": {"type": "boolean", "description": "Import tasks\' due dates"}, "old_start_date": {"type": "boolean", "description": "Import tasks\' start dates"}, "old_followers": {"type": "boolean", "description": "Import tasks\' watchers"}, "comment_attachments": {"type": "boolean", "description": "Import tasks\' comment attachments"}, "recur_settings": {"type": "boolean", "description": "Import tasks\' recurring settings"}, "old_tags": {"type": "boolean", "description": "Import tasks\' tags"}, "old_statuses": {"type": "boolean", "description": "Import tasks\' status settings"}, "subtasks": {"type": "boolean", "description": "Import tasks\' subtasks"}, "custom_type": {"type": "boolean", "description": "Import tasks\' task types"}, "old_assignees": {"type": "boolean", "description": "Import tasks\' assignees"}, "attachments": {"type": "boolean", "description": "Import tasks\' attachments"}, "comment": {"type": "boolean", "description": "Import tasks\' comments"}, "old_status": {"type": "boolean", "description": "Import tasks\' current statuses"}, "external_dependencies": {"type": "boolean", "description": "Import tasks\' external dependencies"}, "internal_dependencies": {"type": "boolean", "description": "Import tasks\' internal dependencies"}, "priority": {"type": "boolean", "description": "Import tasks\' priorities"}, "custom_fields": {"type": "boolean", "description": "Import tasks\' Custom Fields"}, "old_checklists": {"type": "boolean", "description": "Import tasks\' checklists"}, "relationships": {"type": "boolean", "description": "Import tasks\' relationships"}, "old_subtask_assignees": {"type": "boolean", "description": "Import tasks\' subtask assignees"}, "start_date": {"type": "string", "format": "date-time", "description": "Project start date for remapping dates"}, "due_date": {"type": "string", "format": "date-time", "description": "Project due date for remapping dates"}, "remap_start_date": {"type": "boolean", "description": "Remap start dates"}, "skip_weekends": {"type": "boolean", "description": "Skip weekends when remapping dates"}, "archived": {"type": "integer", "enum": [1, 2, null], "description": "Include archived tasks"}}}}}', + "CREATETIMEENTRY": '{"title": "Createatimeentryrequest", "required": ["start", "duration"], "type": "object", "properties": {"description": {"type": "string"}, "tags": {"description": "Users on the Business Plan and above can include a time tracking label.", "type": "array", "items": {"title": "Tags6", "required": ["name", "tag_fg", "tag_bg"], "type": "object", "properties": {"name": {"type": "string"}, "tag_fg": {"type": "string"}, "tag_bg": {"type": "string"}}, "examples": [{"name": "Tag name", "tag_fg": "#000000", "tag_bg": "#000000"}]}}, "start": {"type": "integer", "contentEncoding": "int64"}, "stop": {"type": "integer", "contentEncoding": "int64", "description": "The `duration` parameter can be used instead of the `stop` parameter. "}, "end": {"type": "integer", "contentEncoding": "int64"}, "billable": {"type": "boolean"}, "duration": {"description": "When there are values for both `start` and `end`, `duration` is ignored. The `stop` parameter can be used instead of the `duration` parameter.", "type": "integer", "contentEncoding": "int32"}, "assignee": {"description": "Workspace owners and admins can include any user id. Workspace members can only include their own user id.", "type": "integer", "contentEncoding": "int32"}, "tid": {"type": "string"}}, "examples": [{"description": "from api", "tags": [{"name": "name of tag", "tag_bg": "#BF55EC", "tag_fg": "#FFFFFF"}], "start": 1595282645000, "end": 1595282660000, "billable": true, "duration": 50000, "assignee": 1, "tid": "task_id"}]}', + "UPDATETIMEENTRY": '{"title": "UpdateatimeEntryrequest", "required": ["tags", "tid"], "type": "object", "properties": {"description": {"type": "string"}, "tags": {"description": "Users on the Business Plan and above can include a time tracking label.", "type": "array", "items": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items"}}, "tag_action": {"type": "string"}, "start": {"type": "integer", "contentEncoding": "int64", "description": "When providing `start`, you must also provide `end`."}, "end": {"type": "integer", "contentEncoding": "int64", "description": "When providing `end`, you must also provide `start`."}, "tid": {"type": "string"}, "billable": {"type": "boolean"}, "duration": {"type": "integer", "contentEncoding": "int32"}}, "examples": [{"description": "", "tags": [{"name": "name of tag", "tag_bg": "#BF55EC", "tag_fg": "#FFFFFF"}], "tag_action": "add", "start": 1595289395842, "end": 1595289495842, "tid": "task_id", "billable": true, "duration": 100000}]}', + "REMOVETAGSFROMTIMEENTRIES": '{"title": "Removetagsfromtimeentriesrequest", "required": ["time_entry_ids", "tags"], "type": "object", "properties": {"time_entry_ids": {"type": "array", "items": {"type": "string"}, "description": ""}, "tags": {"type": "array", "items": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries~1start/post/requestBody/content/application~1json/schema/properties/tags/items", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries~1start/post/requestBody/content/application~1json/schema/properties/tags/items"}, "description": ""}}, "examples": [{"time_entry_ids": ["timer_id"], "tags": [{"name": "name of tag"}]}]}', + "ADDTAGTOTIMEENTRY": '{"title": "Addtagsfromtimeentriesrequest", "required": ["time_entry_ids", "tags"], "type": "object", "properties": {"time_entry_ids": {"type": "array", "items": {"type": "string"}, "description": ""}, "tags": {"type": "array", "items": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items"}, "description": ""}}, "examples": [{"time_entry_ids": ["timer_id"], "tags": [{"name": "name of tag", "tag_bg": "#BF55EC", "tag_fg": "#FFFFFF"}]}]}', + "STARTTIMERCLICKUP": '{"title": "StartatimeEntryrequest", "type": "object", "properties": {"description": {"type": "string"}, "tags": {"description": "Users on the Business Plan and above can include a time tracking label.", "type": "array", "items": {"title": "Tags10", "required": ["name"], "type": "object", "properties": {"name": {"type": "string"}}, "examples": [{"name": "name of tag"}]}}, "tid": {"type": "string"}, "billable": {"type": "boolean"}}, "examples": [{"description": "from api", "tags": [{"name": "tag1"}], "tid": "task_id", "billable": false}]}', + "CREATETEAMVIEW": '{"title": "CreateTeamViewrequest", "required": ["name", "type", "grouping", "divide", "sorting", "filters", "columns", "team_sidebar", "settings"], "type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."}, "grouping": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping"}, "divide": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide"}, "sorting": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting"}, "filters": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters"}, "columns": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns"}, "team_sidebar": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar"}, "settings": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings"}}, "examples": [{"name": "New Team View Name", "type": "list", "grouping": {"field": "status", "dir": 1, "collapsed": [], "ignore": false}, "divide": {"field": null, "dir": null, "collapsed": []}, "sorting": {"fields": []}, "filters": {"op": "AND", "fields": [], "search": "", "show_closed": false}, "columns": {"fields": []}, "team_sidebar": {"assignees": [], "assigned_comments": false, "unassigned_tasks": false}, "settings": {"show_task_locations": false, "show_subtasks": 3, "show_subtask_parent_names": false, "show_closed_subtasks": false, "show_assignees": true, "show_images": true, "collapse_empty_columns": null, "me_comments": true, "me_subtasks": true, "me_checklists": true}}]}', + "ADDSPACEVIEW": '{"title": "CreateSpaceViewrequest", "required": ["name", "type", "grouping", "divide", "sorting", "filters", "columns", "team_sidebar", "settings"], "type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."}, "grouping": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping"}, "divide": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide"}, "sorting": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting"}, "filters": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters"}, "columns": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns"}, "team_sidebar": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar"}, "settings": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings"}}, "examples": [{"name": "New Space View Name", "type": "list", "grouping": {"field": "status", "dir": 1, "collapsed": [], "ignore": false}, "divide": {"field": null, "dir": null, "collapsed": []}, "sorting": {"fields": []}, "filters": {"op": "AND", "fields": [], "search": "", "show_closed": false}, "columns": {"fields": []}, "team_sidebar": {"assignees": [], "assigned_comments": false, "unassigned_tasks": false}, "settings": {"show_task_locations": false, "show_subtasks": 3, "show_subtask_parent_names": false, "show_closed_subtasks": false, "show_assignees": true, "show_images": true, "collapse_empty_columns": null, "me_comments": true, "me_subtasks": true, "me_checklists": true}}]}', + "ADDVIEWTOFOLDER": '{"title": "CreateFolderViewrequest", "required": ["name", "type", "grouping", "divide", "sorting", "filters", "columns", "team_sidebar", "settings"], "type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."}, "grouping": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping"}, "divide": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide"}, "sorting": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting"}, "filters": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters"}, "columns": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns"}, "team_sidebar": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar"}, "settings": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings"}}, "examples": [{"name": "New Folder View Name", "type": "list", "grouping": {"field": "status", "dir": 1, "collapsed": [], "ignore": false}, "divide": {"field": null, "dir": null, "collapsed": []}, "sorting": {"fields": []}, "filters": {"op": "AND", "fields": [], "search": "", "show_closed": false}, "columns": {"fields": []}, "team_sidebar": {"assignees": [], "assigned_comments": false, "unassigned_tasks": false}, "settings": {"show_task_locations": false, "show_subtasks": 3, "show_subtask_parent_names": false, "show_closed_subtasks": false, "show_assignees": true, "show_images": true, "collapse_empty_columns": null, "me_comments": true, "me_subtasks": true, "me_checklists": true}}]}', + "ADDVIEWTOCLICKUPLIST": '{"title": "CreateListViewrequest", "required": ["name", "type", "grouping", "divide", "sorting", "filters", "columns", "team_sidebar", "settings"], "type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."}, "grouping": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping"}, "divide": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide"}, "sorting": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting"}, "filters": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters"}, "columns": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns"}, "team_sidebar": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar"}, "settings": {"type": "object", "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings", "additionalProperties": true, "x-moar-broken-reference": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings"}}, "examples": [{"name": "New List View Name", "type": "list", "grouping": {"field": "status", "dir": 1, "collapsed": [], "ignore": false}, "divide": {"field": null, "dir": null, "collapsed": []}, "sorting": {"fields": []}, "filters": {"op": "AND", "fields": [], "search": "", "show_closed": false}, "columns": {"fields": []}, "team_sidebar": {"assignees": [], "assigned_comments": false, "unassigned_tasks": false}, "settings": {"show_task_locations": false, "show_subtasks": 3, "show_subtask_parent_names": false, "show_closed_subtasks": false, "show_assignees": true, "show_images": true, "collapse_empty_columns": null, "me_comments": true, "me_subtasks": true, "me_checklists": true}}]}', + "UPDATEVIEWSETTINGS": '{"title": "UpdateViewrequest", "required": ["name", "type", "parent", "grouping", "divide", "sorting", "filters", "columns", "team_sidebar", "settings"], "type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string"}, "parent": {"title": "Parent", "description": "The parent parameter specifies where the view is located in the ClickUp Hierarchy. Both `id` and `type` are required. \\\n \\\nThe `id` is the id of the Workspace, Space, Folder, or List where the view is located. \\\n \\\nThe `type` value indciates the level of the Hierarchy where the view is located.", "required": ["id", "type"], "type": "object", "properties": {"id": {"type": "string", "description": "The id of the Workspace, Space, Folder, or List where the view is located."}, "type": {"type": "integer", "description": "The level of the Hierarchy where the view is created. \\\n \\\nOptions include: \\\n \\\nWorkspace (Everything Level): `7` \\\n \\\nSpace: `4` \\\n \\\nFolder: `5` \\\n \\\nList: `6`", "contentEncoding": "int32"}}, "examples": [{"id": "512", "type": 7}]}, "grouping": {"title": "Grouping", "required": ["field", "dir", "collapsed", "ignore"], "type": "object", "properties": {"field": {"type": "string", "description": "Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`."}, "dir": {"description": "Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view.", "type": "integer", "contentEncoding": "int32"}, "collapsed": {"type": "array", "items": {"type": "string"}, "description": ""}, "ignore": {"type": "boolean"}}, "examples": [{"field": "status", "dir": 1, "collapsed": [], "ignore": false}]}, "divide": {"title": "Divide", "required": ["collapsed"], "type": "object", "properties": {"field": {"type": ["null"]}, "dir": {"type": ["null"]}, "collapsed": {"type": ["boolean"]}}, "examples": [{"field": null, "dir": null, "collapsed": []}]}, "sorting": {"title": "Sorting", "required": ["fields"], "type": "object", "properties": {"fields": {"type": "array", "items": {"type": "string"}, "description": "Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views)."}}, "examples": [{"fields": [{"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2", "dir": -1, "idx": 0}]}]}, "filters": {"title": "Filters", "required": ["op", "fields", "search", "show_closed"], "type": "object", "properties": {"op": {"type": "string", "description": "The available operator (`op``) values are `AND`` and `OR``."}, "fields": {"type": "array", "items": {"type": "string"}, "description": "View the list of [fields available](doc:filter-views) to filter by."}, "search": {"type": "string"}, "show_closed": {"type": "boolean"}}, "examples": [{"op": "AND", "fields": [], "search": "", "show_closed": false}]}, "columns": {"title": "Columns", "description": "Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy.", "required": ["fields"], "type": "object", "properties": {"fields": {"description": "Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`", "type": "array", "items": {"type": "string"}}}, "examples": [{"fields": []}]}, "team_sidebar": {"title": "TeamSidebar", "required": ["assignees", "assigned_comments", "unassigned_tasks"], "type": "object", "properties": {"assignees": {"type": "array", "items": {"type": "string"}, "description": ""}, "assigned_comments": {"type": "boolean"}, "unassigned_tasks": {"type": "boolean"}}, "examples": [{"assignees": [], "assigned_comments": false, "unassigned_tasks": false}]}, "settings": {"title": "Settings", "required": ["show_task_locations", "show_subtasks", "show_subtask_parent_names", "show_closed_subtasks", "show_assignees", "show_images", "collapse_empty_columns", "me_comments", "me_subtasks", "me_checklists"], "type": "object", "properties": {"show_task_locations": {"type": "boolean"}, "show_subtasks": {"description": "Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.", "type": "integer", "contentEncoding": "int32"}, "show_subtask_parent_names": {"type": "boolean"}, "show_closed_subtasks": {"type": "boolean"}, "show_assignees": {"type": "boolean"}, "show_images": {"type": "boolean"}, "collapse_empty_columns": {"type": ["string", "null"]}, "me_comments": {"type": "boolean"}, "me_subtasks": {"type": "boolean"}, "me_checklists": {"type": "boolean"}}, "examples": [{"show_task_locations": false, "show_subtasks": 3, "show_subtask_parent_names": false, "show_closed_subtasks": false, "show_assignees": true, "show_images": true, "collapse_empty_columns": null, "me_comments": true, "me_subtasks": true, "me_checklists": true}]}}, "examples": [{"name": "New View Name", "type": "list", "parent": {"id": "512", "type": 7}, "grouping": {"field": "status", "dir": 1, "collapsed": [], "ignore": false}, "divide": {"field": null, "dir": null, "collapsed": []}, "sorting": {"fields": []}, "filters": {"op": "AND", "fields": [], "search": "", "show_closed": false}, "columns": {"fields": []}, "team_sidebar": {"assignees": [], "assigned_comments": false, "unassigned_tasks": false}, "settings": {"show_task_locations": false, "show_subtasks": 3, "show_subtask_parent_names": false, "show_closed_subtasks": false, "show_assignees": true, "show_images": true, "collapse_empty_columns": null, "me_comments": true, "me_subtasks": true, "me_checklists": true}}]}', +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddChatViewComment.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddChatViewComment.json new file mode 100644 index 00000000..8aca9d2f --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddChatViewComment.json @@ -0,0 +1,171 @@ +{ + "name": "AddChatViewComment", + "fully_qualified_name": "ClickupApi.AddChatViewComment@0.1.0", + "description": "Add a new comment to a Chat view.\n\nUse this tool to add a comment to a Chat view in ClickUp. This can be used to facilitate discussion and share information in a specific View context.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "view_id", + "required": true, + "description": "The ID of the Chat view where the comment will be added. Expected as a string.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "view_id" + }, + { + "name": "comment_text", + "required": true, + "description": "The text content of the comment to be added to the Chat view.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "comment_text" + }, + { + "name": "send_notifications_to_all", + "required": true, + "description": "Set to true to send notifications to everyone, including the comment creator.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "inferrable": true, + "http_endpoint_parameter_name": "notify_all" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateChatViewComment'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/view/{view_id}/comment", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "view_id", + "tool_parameter_name": "view_id", + "description": "105 (string)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "comment_text", + "tool_parameter_name": "comment_text", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "notify_all", + "tool_parameter_name": "send_notifications_to_all", + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateChatViewCommentrequest\",\n \"required\": [\n \"comment_text\",\n \"notify_all\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"comment_text\": {\n \"type\": \"string\"\n },\n \"notify_all\": {\n \"description\": \"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.\",\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"comment_text\": \"View comment content\",\n \"notify_all\": true\n }\n ]\n },\n \"example\": {\n \"comment_text\": \"View comment content\",\n \"notify_all\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddChecklistItemClickup.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddChecklistItemClickup.json new file mode 100644 index 00000000..7a96aa3b --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddChecklistItemClickup.json @@ -0,0 +1,171 @@ +{ + "name": "AddChecklistItemClickup", + "fully_qualified_name": "ClickupApi.AddChecklistItemClickup@0.1.0", + "description": "Add an item to a checklist in ClickUp tasks.\n\nUse this tool to add a new line item to an existing checklist within a task in ClickUp. This can be useful for task management and ensuring all steps are documented within a checklist.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "checklist_identifier", + "required": true, + "description": "A unique identifier for the checklist. Must be in UUID format.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "checklist_id" + }, + { + "name": "checklist_item_name", + "required": false, + "description": "The name of the checklist item to be added. This should clearly describe the task or item to be completed.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "assignee_user_id", + "required": false, + "description": "The unique ID of the user assigned to the checklist item. This should be an integer value representing the user's ID.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignee" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateChecklistItem'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/checklist/{checklist_id}/checklist_item", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "checklist_id", + "tool_parameter_name": "checklist_identifier", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "checklist_item_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "assignee", + "tool_parameter_name": "assignee_user_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateChecklistItemrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"assignee\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Checklist Item\",\n \"assignee\": 183\n }\n ]\n },\n \"example\": {\n \"name\": \"Checklist Item\",\n \"assignee\": 183\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddChecklistToTask.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddChecklistToTask.json new file mode 100644 index 00000000..671d0cc4 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddChecklistToTask.json @@ -0,0 +1,204 @@ +{ + "name": "AddChecklistToTask", + "fully_qualified_name": "ClickupApi.AddChecklistToTask@0.1.0", + "description": "Add a new checklist to a task in ClickUp.\n\nUse this tool to add a checklist to a specific task in ClickUp by providing the task ID.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_identifier", + "required": true, + "description": "A unique identifier for the task to which the checklist will be added. It can be a custom or default task ID.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "checklist_name", + "required": true, + "description": "The name or title of the checklist to be added to the task. It should be a descriptive string identifying the purpose or contents of the checklist.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "workspace_id_for_custom_task", + "required": false, + "description": "Provide the Workspace ID when 'custom_task_ids' is set to true. It's necessary to reference tasks by custom IDs.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateChecklist'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/checklist", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_for_custom_task", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "checklist_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateChecklistrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Checklist\"\n }\n ]\n },\n \"example\": {\n \"name\": \"Checklist\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddCommentToList.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddCommentToList.json new file mode 100644 index 00000000..bea0b416 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddCommentToList.json @@ -0,0 +1,204 @@ +{ + "name": "AddCommentToList", + "fully_qualified_name": "ClickupApi.AddCommentToList@0.1.0", + "description": "Add a comment to a specific list in ClickUp.\n\nThis tool allows you to add a comment to a specified list in ClickUp. Use it when you need to provide additional information or feedback on a list.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "list_identifier", + "required": true, + "description": "The unique ID of the list where the comment will be added.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "comment_text", + "required": true, + "description": "The text of the comment to be added to the list. This should contain the message or information you wish to convey.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "comment_text" + }, + { + "name": "assignee_id", + "required": true, + "description": "The ID of the user to whom the comment is assigned. This should be an integer value representing the user's unique identifier.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignee" + }, + { + "name": "notify_all", + "required": true, + "description": "If true, notifications are sent to everyone, including the comment creator.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "inferrable": true, + "http_endpoint_parameter_name": "notify_all" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateListComment'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/comment", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "list_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "comment_text", + "tool_parameter_name": "comment_text", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "assignee", + "tool_parameter_name": "assignee_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "notify_all", + "tool_parameter_name": "notify_all", + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateListCommentrequest\",\n \"required\": [\n \"comment_text\",\n \"assignee\",\n \"notify_all\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"comment_text\": {\n \"type\": \"string\"\n },\n \"assignee\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"notify_all\": {\n \"description\": \"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.\",\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"comment_text\": \"List comment content\",\n \"assignee\": 183,\n \"notify_all\": true\n }\n ]\n },\n \"example\": {\n \"comment_text\": \"List comment content\",\n \"assignee\": 183,\n \"notify_all\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddFolderlessListToSpace.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddFolderlessListToSpace.json new file mode 100644 index 00000000..68180d35 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddFolderlessListToSpace.json @@ -0,0 +1,369 @@ +{ + "name": "AddFolderlessListToSpace", + "fully_qualified_name": "ClickupApi.AddFolderlessListToSpace@0.1.0", + "description": "Add a new folderless list to a specified space.\n\nThis tool is used to create a new list within a specified space in ClickUp without associating it with a folder. It facilitates the organization of tasks directly within the space.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_id", + "required": true, + "description": "The unique identifier of the space where the list will be added.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "list_name", + "required": true, + "description": "The name of the new list to be created within the space.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "list_description", + "required": false, + "description": "A text description for the new list. Use plain text. For markdown, use `markdown_content`.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "content" + }, + { + "name": "list_markdown_description", + "required": false, + "description": "Markdown formatted description for the list. Use this instead of a plain text description.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "inferrable": true, + "http_endpoint_parameter_name": "markdown_content" + }, + { + "name": "due_date_timestamp", + "required": false, + "description": "An integer representing the UNIX timestamp for the list's due date. This defines the deadline for the list.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date" + }, + { + "name": "list_priority_level", + "required": false, + "description": "Set the priority level for the list. It should be an integer value indicating the list's urgency or importance.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "priority" + }, + { + "name": "list_owner_user_id", + "required": false, + "description": "The user ID for the list owner to be assigned to the new list.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include a `user_id` to add a List owner." + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignee" + }, + { + "name": "list_color_status", + "required": false, + "description": "Specifies the color representing the List. This is for visual identification and does not affect task statuses.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "inferrable": true, + "http_endpoint_parameter_name": "status" + }, + { + "name": "include_due_time", + "required": false, + "description": "Set to true if the due date should include a specific time.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date_time" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateFolderlessList'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/list", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "space_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "list_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "content", + "tool_parameter_name": "list_description", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "markdown_content", + "tool_parameter_name": "list_markdown_description", + "description": "Use `markdown_content` instead of `content` to format your List description.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date", + "tool_parameter_name": "due_date_timestamp", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date_time", + "tool_parameter_name": "include_due_time", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "priority", + "tool_parameter_name": "list_priority_level", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "assignee", + "tool_parameter_name": "list_owner_user_id", + "description": "Include a `user_id` to add a List owner.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include a `user_id` to add a List owner." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "status", + "tool_parameter_name": "list_color_status", + "description": "**Status** refers to the List color rather than the task Statuses available in the List.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateFolderlessListrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"content\": {\n \"type\": \"string\"\n },\n \"markdown_content\": {\n \"type\": \"string\",\n \"description\": \"Use `markdown_content` instead of `content` to format your List description.\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"due_date_time\": {\n \"type\": \"boolean\"\n },\n \"priority\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"assignee\": {\n \"description\": \"Include a `user_id` to add a List owner.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"status\": {\n \"description\": \"**Status** refers to the List color rather than the task Statuses available in the List.\",\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New List Name\",\n \"content\": \"New List Content\",\n \"due_date\": 1567780450202,\n \"due_date_time\": false,\n \"priority\": 1,\n \"assignee\": 183,\n \"status\": \"red\"\n }\n ]\n },\n \"example\": {\n \"name\": \"New List Name\",\n \"content\": \"New List Content\",\n \"markdown_content\": \"# This is markdown\\n ***bold and italicized text***\",\n \"due_date\": 1567780450202,\n \"due_date_time\": false,\n \"priority\": 1,\n \"assignee\": 183,\n \"status\": \"red\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddGuestToFolder.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddGuestToFolder.json new file mode 100644 index 00000000..bef03849 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddGuestToFolder.json @@ -0,0 +1,204 @@ +{ + "name": "AddGuestToFolder", + "fully_qualified_name": "ClickupApi.AddGuestToFolder@0.1.0", + "description": "Share a folder with a guest in ClickUp's Enterprise Plan.\n\nThis tool shares a specific folder with a guest, available only for ClickUp Workspaces on the Enterprise Plan. Use it to collaborate by granting access to specified guests.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "folder_id", + "required": true, + "description": "The unique integer ID of the folder to be shared with the guest.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + }, + { + "name": "guest_identifier", + "required": true, + "description": "The unique identifier for the guest to whom the folder will be shared. This should be an integer representing the guest's ID.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "guest_id" + }, + { + "name": "guest_permission_level", + "required": true, + "description": "Defines guest's access level: 'read' for view only, 'comment', 'edit', or 'create' for full access.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "inferrable": true, + "http_endpoint_parameter_name": "permission_level" + }, + { + "name": "include_shared_items", + "required": false, + "description": "Set to true to include details of items shared with the guest. Default is true.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_shared" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'AddGuestToFolder'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/folder/{folder_id}/guest/{guest_id}", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "include_shared", + "tool_parameter_name": "include_shared_items", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "folder_id", + "tool_parameter_name": "folder_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "guest_id", + "tool_parameter_name": "guest_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "permission_level", + "tool_parameter_name": "guest_permission_level", + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"AddGuestToFolderrequest\",\n \"required\": [\n \"permission_level\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"permission_level\": {\n \"description\": \"Can be `read` (view only), `comment`, `edit`, or `create` (full).\",\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"permission_level\": \"read\"\n }\n ]\n },\n \"example\": {\n \"permission_level\": \"read\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddGuestToList.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddGuestToList.json new file mode 100644 index 00000000..eb10f8c3 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddGuestToList.json @@ -0,0 +1,204 @@ +{ + "name": "AddGuestToList", + "fully_qualified_name": "ClickupApi.AddGuestToList@0.1.0", + "description": "Add a guest to a specific list in ClickUp.\n\nThis tool adds a guest to a list within ClickUp, available only for Enterprise Plan workspaces.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "list_id", + "required": true, + "description": "The identifier of the list to which the guest will be added.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "guest_id", + "required": true, + "description": "The unique identifier for the guest to be added. This should be an integer value.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "guest_id" + }, + { + "name": "guest_permission_level", + "required": true, + "description": "Permission level for the guest on the list. Options are `read`, `comment`, `edit`, or `create`.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "inferrable": true, + "http_endpoint_parameter_name": "permission_level" + }, + { + "name": "include_shared_details", + "required": false, + "description": "Set to false to exclude shared item details from the guest view; defaults to true to include them.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_shared" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'AddGuestToList'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/guest/{guest_id}", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "include_shared", + "tool_parameter_name": "include_shared_details", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "list_id", + "tool_parameter_name": "list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "guest_id", + "tool_parameter_name": "guest_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "permission_level", + "tool_parameter_name": "guest_permission_level", + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"AddGuestToListrequest\",\n \"required\": [\n \"permission_level\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"permission_level\": {\n \"description\": \"Can be `read` (view only), `comment`, `edit`, or `create` (full).\",\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"permission_level\": \"read\"\n }\n ]\n },\n \"example\": {\n \"permission_level\": \"read\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddSpaceTaskTag.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddSpaceTaskTag.json new file mode 100644 index 00000000..1f63acee --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddSpaceTaskTag.json @@ -0,0 +1,204 @@ +{ + "name": "AddSpaceTaskTag", + "fully_qualified_name": "ClickupApi.AddSpaceTaskTag@0.1.0", + "description": "Add a new task tag to a specified space in ClickUp.\n\nUse this tool to create a new tag for tasks within a specific space in ClickUp. It's useful for organizing tasks by category or priority.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_identifier", + "required": true, + "description": "The unique identifier for the space where the tag will be added. It must be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "tag_name", + "required": true, + "description": "Name of the new tag to be added to the space. It should be a descriptive and concise identifier for categorizing tasks.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag.name" + }, + { + "name": "tag_foreground_color", + "required": true, + "description": "Hex code for the tag's foreground color. It defines the text color of the tag.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag.tag_fg" + }, + { + "name": "tag_background_color", + "required": true, + "description": "Hex code representing the background color for the tag. It should be a string in the format '#RRGGBB'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag.tag_bg" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateSpaceTag'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/tag", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "space_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag.name", + "tool_parameter_name": "tag_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag.tag_fg", + "tool_parameter_name": "tag_foreground_color", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag.tag_bg", + "tool_parameter_name": "tag_background_color", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateSpaceTagrequest\",\n \"required\": [\n \"tag\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"tag\": {\n \"title\": \"Tag\",\n \"required\": [\n \"name\",\n \"tag_fg\",\n \"tag_bg\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"tag_fg\": {\n \"type\": \"string\"\n },\n \"tag_bg\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Tag Name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n ]\n }\n },\n \"examples\": [\n {\n \"tag\": {\n \"name\": \"Tag Name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n }\n ]\n },\n \"example\": {\n \"tag\": {\n \"name\": \"Tag Name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddSpaceView.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddSpaceView.json new file mode 100644 index 00000000..7c65718a --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddSpaceView.json @@ -0,0 +1,284 @@ +{ + "name": "AddSpaceView", + "fully_qualified_name": "ClickupApi.AddSpaceView@0.1.0", + "description": "Add a new view to a ClickUp space.\n\nUse this tool to add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a ClickUp Space.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_id", + "required": true, + "description": "The unique identifier of the ClickUp space where the view will be added. It should be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "view_configuration", + "required": true, + "description": "A JSON object detailing the view's setup, including `name`, `type` (e.g., list, board), and optional attributes like `grouping`, `divide`, `sorting`, `filters`, `columns`, `team_sidebar`, and `settings`.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateSpaceView'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/view", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "space_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "view_configuration", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateSpaceViewrequest\",\n \"required\": [\n \"name\",\n \"type\",\n \"grouping\",\n \"divide\",\n \"sorting\",\n \"filters\",\n \"columns\",\n \"team_sidebar\",\n \"settings\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`.\"\n },\n \"grouping\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\"\n },\n \"divide\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\"\n },\n \"sorting\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\"\n },\n \"filters\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\"\n },\n \"columns\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\"\n },\n \"team_sidebar\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\"\n },\n \"settings\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Space View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": []\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": []\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New Space View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"op\": \"EQ\",\n \"determinor\": null,\n \"idx\": 0,\n \"values\": \"123\"\n }\n ],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": [\n {\n \"field\": \"assignee\",\n \"idx\": 0,\n \"width\": 160,\n \"hidden\": true,\n \"name\": null,\n \"display\": null\n }\n ]\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddTagToTask.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddTagToTask.json new file mode 100644 index 00000000..77c179d8 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddTagToTask.json @@ -0,0 +1,237 @@ +{ + "name": "AddTagToTask", + "fully_qualified_name": "ClickupApi.AddTagToTask@0.1.0", + "description": "Add a tag to a specific task in ClickUp.\n\nUse this tool to assign a tag to a task in ClickUp by specifying the task ID and tag name. It helps in organizing and categorizing tasks efficiently.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_identifier", + "required": true, + "description": "The unique identifier of the task to which the tag will be added. Can be a custom task ID if specified.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "tag_name", + "required": true, + "description": "The name of the tag to add to the task. This should be a string representing the desired tag.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag_name" + }, + { + "name": "content_type", + "required": true, + "description": "Specifies the media type of the request. Typically set to 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + }, + { + "name": "workspace_id_if_custom_task_ids", + "required": false, + "description": "Workspace ID required when referencing a task by its custom task ID. Only needed if `custom_task_ids=true`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true if you want to reference a task using its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'AddTagToTask'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/tag/{tag_name}", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_if_custom_task_ids", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag_name", + "tool_parameter_name": "tag_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddTagToTimeEntry.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddTagToTimeEntry.json new file mode 100644 index 00000000..ebcd5852 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddTagToTimeEntry.json @@ -0,0 +1,172 @@ +{ + "name": "AddTagToTimeEntry", + "fully_qualified_name": "ClickupApi.AddTagToTimeEntry@0.1.0", + "description": "Add a label to a specific time entry in ClickUp.\n\nThis tool is used to attach a label to a time entry for a specific team in ClickUp. It should be called when you want to organize or categorize time entries with tags for better tracking and management.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace where the time entry is located. This is required to specify which team the tag should be added to.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "time_entry_tag_request", + "required": true, + "description": "JSON object containing time_entry_ids (array of strings) and tags (array of JSON objects) to be added.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "time_entry_ids": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Addtagsfromtimeentries'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/time_entries/tags", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "time_entry_tag_request", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "time_entry_ids": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Addtagsfromtimeentriesrequest\",\n \"required\": [\n \"time_entry_ids\",\n \"tags\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"time_entry_ids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"\"\n },\n \"tags\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"time_entry_ids\": [\n \"timer_id\"\n ],\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ]\n }\n ]\n },\n \"example\": {\n \"time_entry_ids\": [\n \"timer_id\"\n ],\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ]\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddTargetToGoal.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddTargetToGoal.json new file mode 100644 index 00000000..b24919da --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddTargetToGoal.json @@ -0,0 +1,369 @@ +{ + "name": "AddTargetToGoal", + "fully_qualified_name": "ClickupApi.AddTargetToGoal@0.1.0", + "description": "Add a target to a specific goal in ClickUp.\n\nUse this tool to add a key result target to an existing goal in ClickUp, enhancing goal tracking and achievement.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "goal_identifier", + "required": true, + "description": "The unique identifier (UUID) of the goal to which the target will be added.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "goal_id" + }, + { + "name": "target_name", + "required": true, + "description": "Specify the name for the target being added to the goal. It should be a descriptive label for easy identification.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "target_owners_ids", + "required": true, + "description": "An array of user IDs representing the owners of the key result target.", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "owners" + }, + { + "name": "target_type", + "required": true, + "description": "Specify the type of target (key result) as one of the following: `number`, `currency`, `boolean`, `percentage`, or `automatic`.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "type" + }, + { + "name": "initial_value_steps", + "required": true, + "description": "Specify the starting value for the target's progress steps, as an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "steps_start" + }, + { + "name": "target_steps_end", + "required": true, + "description": "Specify the final value for the target steps. It indicates the goal completion threshold.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "steps_end" + }, + { + "name": "target_unit", + "required": true, + "description": "Specify the unit for the target if using types like number, currency, or percentage.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "unit" + }, + { + "name": "linked_task_ids", + "required": true, + "description": "An array of task IDs to associate the target with tasks.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter an array of task IDs to link this target with one or more tasks." + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_ids" + }, + { + "name": "list_ids", + "required": true, + "description": "Array of List IDs to associate the target with multiple Lists.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter an array of List IDs to link this target with one or more Lists." + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateKeyResult'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/goal/{goal_id}/key_result", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "goal_id", + "tool_parameter_name": "goal_identifier", + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "target_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "owners", + "tool_parameter_name": "target_owners_ids", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "type", + "tool_parameter_name": "target_type", + "description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "steps_start", + "tool_parameter_name": "initial_value_steps", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "steps_end", + "tool_parameter_name": "target_steps_end", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "unit", + "tool_parameter_name": "target_unit", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_ids", + "tool_parameter_name": "linked_task_ids", + "description": "Enter an array of task IDs to link this target with one or more tasks.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter an array of task IDs to link this target with one or more tasks." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "list_ids", + "tool_parameter_name": "list_ids", + "description": "Enter an array of List IDs to link this target with one or more Lists.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter an array of List IDs to link this target with one or more Lists." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateKeyResultrequest\",\n \"required\": [\n \"name\",\n \"owners\",\n \"type\",\n \"steps_start\",\n \"steps_end\",\n \"unit\",\n \"task_ids\",\n \"list_ids\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"type\": {\n \"description\": \"Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`.\",\n \"type\": \"string\"\n },\n \"steps_start\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"steps_end\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"unit\": {\n \"type\": \"string\"\n },\n \"task_ids\": {\n \"description\": \"Enter an array of task IDs to link this target with one or more tasks.\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"list_ids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Enter an array of List IDs to link this target with one or more Lists.\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Target Name\",\n \"owners\": [\n 183\n ],\n \"type\": \"number\",\n \"steps_start\": 0,\n \"steps_end\": 10,\n \"unit\": \"km\",\n \"task_ids\": [],\n \"list_ids\": []\n }\n ]\n },\n \"example\": {\n \"name\": \"New Key Result Name\",\n \"owners\": [\n 183\n ],\n \"type\": \"number\",\n \"steps_start\": 0,\n \"steps_end\": 10,\n \"unit\": \"km\",\n \"task_ids\": [],\n \"list_ids\": []\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddTaskComment.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddTaskComment.json new file mode 100644 index 00000000..d1130040 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddTaskComment.json @@ -0,0 +1,303 @@ +{ + "name": "AddTaskComment", + "fully_qualified_name": "ClickupApi.AddTaskComment@0.1.0", + "description": "Add a new comment to a specific task on ClickUp.\n\nThis tool allows users to add a new comment to a specified task on ClickUp. It should be called when there's a need to comment on a task, offering a way to communicate updates, feedback, or any relevant information directly related to the task in question.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "specific_task_id", + "required": true, + "description": "The ID of the task to add the comment to. Required for identifying the target task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "comment_content", + "required": true, + "description": "The text of the comment to be added to the task. It should contain any updates, feedback, or relevant information.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "comment_text" + }, + { + "name": "send_notifications_to_all", + "required": true, + "description": "If true, notifications will be sent to everyone, including the creator of the comment.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "inferrable": true, + "http_endpoint_parameter_name": "notify_all" + }, + { + "name": "workspace_id_for_custom_task", + "required": false, + "description": "Provide the Workspace ID when referencing a task by its custom task ID (set `custom_task_ids` to true).", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "comment_assignee_id", + "required": false, + "description": "An integer representing the user ID of the assignee for the comment on the task.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignee" + }, + { + "name": "assignee_group", + "required": false, + "description": "Specifies a group of users (as a comma-separated string) to be assigned to the comment. Ensure the group is relevant to the task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "group_assignee" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateTaskComment'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/comment", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_for_custom_task", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "specific_task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "comment_text", + "tool_parameter_name": "comment_content", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "assignee", + "tool_parameter_name": "comment_assignee_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "group_assignee", + "tool_parameter_name": "assignee_group", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "notify_all", + "tool_parameter_name": "send_notifications_to_all", + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateTaskCommentrequest\",\n \"required\": [\n \"comment_text\",\n \"notify_all\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"comment_text\": {\n \"type\": \"string\"\n },\n \"assignee\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"group_assignee\": {\n \"type\": \"string\",\n \"contentEncoding\": \"int32\",\n \"description\": \"\"\n },\n \"notify_all\": {\n \"description\": \"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.\",\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"comment_text\": \"Task comment content\",\n \"assignee\": 183,\n \"group_assignee\": \"d01f92f-48ca-446d-88a1-0beb0e8f5f14\",\n \"notify_all\": true\n }\n ]\n },\n \"example\": {\n \"comment_text\": \"Task comment content\",\n \"assignee\": 183,\n \"group_assignee\": \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\",\n \"notify_all\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddTaskToClickupList.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddTaskToClickupList.json new file mode 100644 index 00000000..4027c21f --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddTaskToClickupList.json @@ -0,0 +1,138 @@ +{ + "name": "AddTaskToClickupList", + "fully_qualified_name": "ClickupApi.AddTaskToClickupList@0.1.0", + "description": "Add a task to an additional list in ClickUp.\n\nThis tool adds a specified task to an additional list in ClickUp, requiring the 'Tasks in Multiple List' ClickApp to be enabled. Use this tool to manage tasks across multiple lists efficiently.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "target_list_id", + "required": true, + "description": "The unique identifier for the target list where the task will be added. This is required to associate the task with the correct list in ClickUp.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "task_identifier", + "required": true, + "description": "Specify the ID of the task to be added to an additional list in ClickUp.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'AddTaskToList'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/task/{task_id}", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "target_list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddViewToClickupList.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddViewToClickupList.json new file mode 100644 index 00000000..c9cad233 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddViewToClickupList.json @@ -0,0 +1,284 @@ +{ + "name": "AddViewToClickupList", + "fully_qualified_name": "ClickupApi.AddViewToClickupList@0.1.0", + "description": "Add various views to a ClickUp list.\n\nUse this tool to add different types of views (List, Board, Calendar, etc.) to a specific ClickUp list using the list ID.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "clickup_list_id", + "required": true, + "description": "An integer representing the ID of the ClickUp list to which the view will be added.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "view_configuration", + "required": true, + "description": "Configuration settings for the view, including 'name', 'type', 'grouping', 'divide', 'sorting', 'filters', 'columns', 'team_sidebar', and 'settings'.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateListView'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/view", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "clickup_list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "view_configuration", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateListViewrequest\",\n \"required\": [\n \"name\",\n \"type\",\n \"grouping\",\n \"divide\",\n \"sorting\",\n \"filters\",\n \"columns\",\n \"team_sidebar\",\n \"settings\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`.\"\n },\n \"grouping\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\"\n },\n \"divide\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\"\n },\n \"sorting\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\"\n },\n \"filters\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\"\n },\n \"columns\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\"\n },\n \"team_sidebar\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\"\n },\n \"settings\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New List View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": []\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": []\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New List View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"op\": \"EQ\",\n \"determinor\": null,\n \"idx\": 0,\n \"values\": \"123\"\n }\n ],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": [\n {\n \"field\": \"assignee\",\n \"idx\": 0,\n \"width\": 160,\n \"hidden\": true,\n \"name\": null,\n \"display\": null\n }\n ]\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/AddViewToFolder.json b/toolkits/clickup_api/clickup_api/wrapper_tools/AddViewToFolder.json new file mode 100644 index 00000000..f1e29bd5 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/AddViewToFolder.json @@ -0,0 +1,284 @@ +{ + "name": "AddViewToFolder", + "fully_qualified_name": "ClickupApi.AddViewToFolder@0.1.0", + "description": "Add various view types to a ClickUp folder.\n\nUse this tool to add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a specific folder in ClickUp.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "folder_id", + "required": true, + "description": "The unique integer ID of the ClickUp folder where the view will be added. Required for specifying the target folder.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + }, + { + "name": "view_configuration", + "required": true, + "description": "A JSON object detailing the view settings such as type, name, sorting, filters, and other configurations.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateFolderView'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/folder/{folder_id}/view", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "folder_id", + "tool_parameter_name": "folder_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "view_configuration", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateFolderViewrequest\",\n \"required\": [\n \"name\",\n \"type\",\n \"grouping\",\n \"divide\",\n \"sorting\",\n \"filters\",\n \"columns\",\n \"team_sidebar\",\n \"settings\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`.\"\n },\n \"grouping\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\"\n },\n \"divide\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\"\n },\n \"sorting\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\"\n },\n \"filters\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\"\n },\n \"columns\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\"\n },\n \"team_sidebar\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\"\n },\n \"settings\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Folder View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": []\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": []\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New Folder View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"op\": \"EQ\",\n \"determinor\": null,\n \"idx\": 0,\n \"values\": \"123\"\n }\n ],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": [\n {\n \"field\": \"assignee\",\n \"idx\": 0,\n \"width\": 160,\n \"hidden\": true,\n \"name\": null,\n \"display\": null\n }\n ]\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ClickupLegacyTimeTracking.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ClickupLegacyTimeTracking.json new file mode 100644 index 00000000..9a83b95f --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ClickupLegacyTimeTracking.json @@ -0,0 +1,270 @@ +{ + "name": "ClickupLegacyTimeTracking", + "fully_qualified_name": "ClickupApi.ClickupLegacyTimeTracking@0.1.0", + "description": "Log time entry for a ClickUp task using legacy endpoint.\n\nThis tool allows logging time entries for a specific ClickUp task using a legacy API endpoint. It should be called when you need to record time spent on tasks, although it's recommended to use the updated Time Tracking API for new implementations.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "clickup_task_id", + "required": true, + "description": "The unique identifier of the task for which time is being logged. This can refer to either the standard task ID or a custom task ID if specified.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "start_time_unix_epoch", + "required": true, + "description": "The start time of the time entry in Unix epoch format. This is required to log time for a task.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "start" + }, + { + "name": "end_timestamp", + "required": true, + "description": "Epoch timestamp indicating when the time tracking ended for the task.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "end" + }, + { + "name": "time_spent_seconds", + "required": true, + "description": "Duration of time spent on the task in seconds. This is the time you want to log for the specific task.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "time" + }, + { + "name": "workspace_id", + "required": false, + "description": "Provide the Workspace ID when `custom_task_ids` is `true`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Tracktime'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/time", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "clickup_task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "start", + "tool_parameter_name": "start_time_unix_epoch", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "end", + "tool_parameter_name": "end_timestamp", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "time", + "tool_parameter_name": "time_spent_seconds", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"Include the total time or the start time and end time.\\\\\\n \\\\\\nThe total time is in milliseconds and `\\\"start\\\"` and `\\\"end\\\"` values are Unix time in milliseconds.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Tracktimerequest\",\n \"required\": [\n \"start\",\n \"end\",\n \"time\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"start\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"end\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"time\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"start\": 1567780450202,\n \"end\": 1508369194377,\n \"time\": 8640000\n }\n ]\n },\n \"example\": {\n \"start\": 1567780450202,\n \"end\": 1508369194377,\n \"time\": 8640000\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ConfigureWorkspaceGuest.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ConfigureWorkspaceGuest.json new file mode 100644 index 00000000..5622a548 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ConfigureWorkspaceGuest.json @@ -0,0 +1,336 @@ +{ + "name": "ConfigureWorkspaceGuest", + "fully_qualified_name": "ClickupApi.ConfigureWorkspaceGuest@0.1.0", + "description": "Configure options for a guest in a workspace.\n\nThis tool adjusts settings for a guest in a ClickUp workspace, specifically for teams on the Enterprise Plan.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique identifier for the ClickUp workspace where the guest is being configured. This is required for identifying the specific workspace.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "guest_identifier", + "required": true, + "description": "The unique identifier for the guest to be configured in the workspace.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "guest_id" + }, + { + "name": "guest_custom_role_id", + "required": false, + "description": "An integer representing the custom role ID assigned to the guest in the workspace.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_role_id" + }, + { + "name": "allow_viewing_points_estimated", + "required": false, + "description": "Specify if the guest can view estimated points in the workspace. True allows viewing; false restricts it.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "can_see_points_estimated" + }, + { + "name": "allow_guest_to_edit_tags", + "required": false, + "description": "Set to true to allow the guest to edit tags in the workspace; false to disallow.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "can_edit_tags" + }, + { + "name": "allow_viewing_time_spent", + "required": false, + "description": "Set to true to allow the guest to view time spent on tasks, false to restrict.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "can_see_time_spent" + }, + { + "name": "can_see_time_estimates", + "required": false, + "description": "Determines if the guest can view time estimates. Use true to allow, false to restrict.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "can_see_time_estimated" + }, + { + "name": "allow_view_creation", + "required": false, + "description": "A boolean to specify if the guest can create views. True allows view creation, false denies it.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "can_create_views" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'EditGuestOnWorkspace'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/guest/{guest_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "guest_id", + "tool_parameter_name": "guest_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "can_see_points_estimated", + "tool_parameter_name": "allow_viewing_points_estimated", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "can_edit_tags", + "tool_parameter_name": "allow_guest_to_edit_tags", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "can_see_time_spent", + "tool_parameter_name": "allow_viewing_time_spent", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "can_see_time_estimated", + "tool_parameter_name": "can_see_time_estimates", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "can_create_views", + "tool_parameter_name": "allow_view_creation", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_role_id", + "tool_parameter_name": "guest_custom_role_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditGuestOnWorkspacerequest\",\n \"type\": \"object\",\n \"properties\": {\n \"can_see_points_estimated\": {\n \"type\": \"boolean\"\n },\n \"can_edit_tags\": {\n \"type\": \"boolean\"\n },\n \"can_see_time_spent\": {\n \"type\": \"boolean\"\n },\n \"can_see_time_estimated\": {\n \"type\": \"boolean\"\n },\n \"can_create_views\": {\n \"type\": \"boolean\"\n },\n \"custom_role_id\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"can_see_points_estimated\": true,\n \"can_edit_tags\": true,\n \"can_see_time_spent\": true,\n \"can_see_time_estimated\": true,\n \"can_create_views\": true,\n \"custom_role_id\": 12345\n }\n ]\n },\n \"example\": {\n \"can_edit_tags\": true,\n \"can_see_time_spent\": true,\n \"can_see_time_estimated\": true,\n \"can_see_points_estimated\": true,\n \"can_create_views\": true,\n \"custom_role_id\": 12345\n }\n }\n },\n \"required\": false\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateClickupList.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateClickupList.json new file mode 100644 index 00000000..9f61aedd --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateClickupList.json @@ -0,0 +1,369 @@ +{ + "name": "CreateClickupList", + "fully_qualified_name": "ClickupApi.CreateClickupList@0.1.0", + "description": "Create a new list in a ClickUp folder.\n\nUse this tool to add a new list to a specified folder in ClickUp. Ideal for organizing tasks or projects within a folder.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "folder_id", + "required": true, + "description": "The unique integer identifier for the folder where the new list will be added.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + }, + { + "name": "list_name", + "required": true, + "description": "The name of the new list to be created within the specified ClickUp folder.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "list_description", + "required": false, + "description": "A plain text description for the list. Use this to provide details about the list's purpose.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "content" + }, + { + "name": "formatted_list_description", + "required": false, + "description": "Provide a markdown-formatted description for the List. Use this instead of plain text content.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "inferrable": true, + "http_endpoint_parameter_name": "markdown_content" + }, + { + "name": "due_date_timestamp", + "required": false, + "description": "The due date for the list in Unix timestamp format. Determines when the list should be completed.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date" + }, + { + "name": "list_priority", + "required": false, + "description": "An integer value indicating the priority of the list, where a higher number typically means higher priority.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "priority" + }, + { + "name": "list_assignee_user_id", + "required": false, + "description": "The user ID to assign this list to a specific user. This identifies who will be responsible for the list.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include a `user_id` to assign this List." + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignee" + }, + { + "name": "list_color", + "required": false, + "description": "Specifies the color of the List, not related to task statuses.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "inferrable": true, + "http_endpoint_parameter_name": "status" + }, + { + "name": "include_time_in_due_date", + "required": false, + "description": "Set to true to include a specific time with the due date.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date_time" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateList'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/folder/{folder_id}/list", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "folder_id", + "tool_parameter_name": "folder_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "list_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "content", + "tool_parameter_name": "list_description", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "markdown_content", + "tool_parameter_name": "formatted_list_description", + "description": "Use `markdown_content` instead of `content` to format your List description.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date", + "tool_parameter_name": "due_date_timestamp", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date_time", + "tool_parameter_name": "include_time_in_due_date", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "priority", + "tool_parameter_name": "list_priority", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "assignee", + "tool_parameter_name": "list_assignee_user_id", + "description": "Include a `user_id` to assign this List.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include a `user_id` to assign this List." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "status", + "tool_parameter_name": "list_color", + "description": "**Status** refers to the List color rather than the task Statuses available in the List.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateListrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"content\": {\n \"type\": \"string\"\n },\n \"markdown_content\": {\n \"type\": \"string\",\n \"description\": \"Use `markdown_content` instead of `content` to format your List description.\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"due_date_time\": {\n \"type\": \"boolean\"\n },\n \"priority\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"assignee\": {\n \"description\": \"Include a `user_id` to assign this List.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"status\": {\n \"description\": \"**Status** refers to the List color rather than the task Statuses available in the List.\",\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New List Name\",\n \"content\": \"New List Content\",\n \"markdown_content\": \"# This is markdown\\n ***bold and italicized text***\",\n \"due_date\": 1567780450202,\n \"due_date_time\": false,\n \"priority\": 1,\n \"assignee\": 183,\n \"status\": \"red\"\n }\n ]\n },\n \"example\": {\n \"name\": \"New List Name\",\n \"content\": \"New List Content\",\n \"markdown_content\": \"# This is markdown\\n ***bold and italicized text***\",\n \"due_date\": 1567780450202,\n \"due_date_time\": false,\n \"priority\": 1,\n \"assignee\": 183,\n \"status\": \"red\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateFolderFromTemplate.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateFolderFromTemplate.json new file mode 100644 index 00000000..321951cb --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateFolderFromTemplate.json @@ -0,0 +1,695 @@ +{ + "name": "CreateFolderFromTemplate", + "fully_qualified_name": "ClickupApi.CreateFolderFromTemplate@0.1.0", + "description": "Creates a new folder from a template in a ClickUp space.\n\nThis tool creates a new folder using a predefined template within a specified ClickUp space. It can also incorporate nested assets like lists and tasks from the template into the new folder. Templates must be added to your Workspace before use. The operation can be executed asynchronously or synchronously.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "clickup_space_id", + "required": true, + "description": "ID of the ClickUp Space where the folder will be created.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Space where the Folder will be created" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "folder_template_id", + "required": true, + "description": "The ID of the folder template to be used for creating a new folder in a ClickUp space. Ensure the template is added to your Workspace.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Folder template to use." + }, + "inferrable": true, + "http_endpoint_parameter_name": "template_id" + }, + { + "name": "folder_creation_options", + "required": true, + "description": "JSON object containing name and options for creating the folder, including import settings and date remapping.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Name of the new Folder" + }, + "options": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "return_immediately": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n" + }, + "content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "List description" + }, + "time_estimate": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include time (hours, minutes and seconds)" + }, + "automation": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import automation options" + }, + "include_views": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import views" + }, + "old_due_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks due dates" + }, + "old_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks start dates" + }, + "old_followers": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks watchers" + }, + "comment_attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks comment attachments" + }, + "recur_settings": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks recurring settings" + }, + "old_tags": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks tags" + }, + "old_statuses": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks status settings" + }, + "subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks subtasks" + }, + "custom_type": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks types" + }, + "old_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks assignees" + }, + "attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks attachments" + }, + "comment": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks comments" + }, + "old_status": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks current statuses" + }, + "external_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks external dependencies" + }, + "internal_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks internal dependencies" + }, + "priority": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks priority" + }, + "custom_fields": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks Custom Fields" + }, + "old_checklists": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks checklists" + }, + "relationships": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks relationships" + }, + "old_subtask_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks subtasks and assignees combination" + }, + "start_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project start date for remapping dates" + }, + "due_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project due date for remapping dates" + }, + "remap_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Remap start dates" + }, + "skip_weekends": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Skip weekends when remapping dates" + }, + "archived": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "1", + "2", + "None" + ], + "properties": null, + "inner_properties": null, + "description": "Include archived tasks (1 or 2 or null)" + } + }, + "inner_properties": null, + "description": "Options for creating the Folder" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateFolderFromTemplate'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/folder_template/{template_id}", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "clickup_space_id", + "description": "ID of the Space where the Folder will be created", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Space where the Folder will be created" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "template_id", + "tool_parameter_name": "folder_template_id", + "description": "ID of the Folder template to use.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Folder template to use." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "folder_creation_options", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Name of the new Folder" + }, + "options": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "return_immediately": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n" + }, + "content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "List description" + }, + "time_estimate": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include time (hours, minutes and seconds)" + }, + "automation": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import automation options" + }, + "include_views": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import views" + }, + "old_due_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks due dates" + }, + "old_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks start dates" + }, + "old_followers": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks watchers" + }, + "comment_attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks comment attachments" + }, + "recur_settings": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks recurring settings" + }, + "old_tags": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks tags" + }, + "old_statuses": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks status settings" + }, + "subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks subtasks" + }, + "custom_type": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks types" + }, + "old_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks assignees" + }, + "attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks attachments" + }, + "comment": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks comments" + }, + "old_status": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks current statuses" + }, + "external_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks external dependencies" + }, + "internal_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks internal dependencies" + }, + "priority": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks priority" + }, + "custom_fields": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks Custom Fields" + }, + "old_checklists": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks checklists" + }, + "relationships": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks relationships" + }, + "old_subtask_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks subtasks and assignees combination" + }, + "start_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project start date for remapping dates" + }, + "due_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project due date for remapping dates" + }, + "remap_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Remap start dates" + }, + "skip_weekends": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Skip weekends when remapping dates" + }, + "archived": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "1", + "2", + "None" + ], + "properties": null, + "inner_properties": null, + "description": "Include archived tasks (1 or 2 or null)" + } + }, + "inner_properties": null, + "description": "Options for creating the Folder" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"name\"\n ],\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the new Folder\"\n },\n \"options\": {\n \"type\": \"object\",\n \"description\": \"Options for creating the Folder\",\n \"properties\": {\n \"return_immediately\": {\n \"type\": \"boolean\",\n \"description\": \"Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\\n\",\n \"default\": true\n },\n \"content\": {\n \"type\": \"string\",\n \"description\": \"List description\"\n },\n \"time_estimate\": {\n \"type\": \"boolean\",\n \"description\": \"Include time (hours, minutes and seconds)\"\n },\n \"automation\": {\n \"type\": \"boolean\",\n \"description\": \"Import automation options\"\n },\n \"include_views\": {\n \"type\": \"boolean\",\n \"description\": \"Import views\"\n },\n \"old_due_date\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks due dates\"\n },\n \"old_start_date\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks start dates\"\n },\n \"old_followers\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks watchers\"\n },\n \"comment_attachments\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks comment attachments\"\n },\n \"recur_settings\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks recurring settings\"\n },\n \"old_tags\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks tags\"\n },\n \"old_statuses\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks status settings\"\n },\n \"subtasks\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks subtasks\"\n },\n \"custom_type\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks types\"\n },\n \"old_assignees\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks assignees\"\n },\n \"attachments\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks attachments\"\n },\n \"comment\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks comments\"\n },\n \"old_status\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks current statuses\"\n },\n \"external_dependencies\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks external dependencies\"\n },\n \"internal_dependencies\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks internal dependencies\"\n },\n \"priority\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks priority\"\n },\n \"custom_fields\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks Custom Fields\"\n },\n \"old_checklists\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks checklists\"\n },\n \"relationships\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks relationships\"\n },\n \"old_subtask_assignees\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks subtasks and assignees combination\"\n },\n \"start_date\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"Project start date for remapping dates\"\n },\n \"due_date\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"Project due date for remapping dates\"\n },\n \"remap_start_date\": {\n \"type\": \"boolean\",\n \"description\": \"Remap start dates\"\n },\n \"skip_weekends\": {\n \"type\": \"boolean\",\n \"description\": \"Skip weekends when remapping dates\"\n },\n \"archived\": {\n \"type\": \"integer\",\n \"enum\": [\n 1,\n 2,\n null\n ],\n \"description\": \"Include archived tasks (1 or 2 or null)\"\n }\n }\n }\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateFolderInSpace.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateFolderInSpace.json new file mode 100644 index 00000000..8ce230dc --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateFolderInSpace.json @@ -0,0 +1,138 @@ +{ + "name": "CreateFolderInSpace", + "fully_qualified_name": "ClickupApi.CreateFolderInSpace@0.1.0", + "description": "Add a new Folder to a Space in ClickUp.\n\nThis tool allows you to create a new folder within a specified space in ClickUp. Use it when you need to organize tasks or projects into a new folder under an existing space.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_id", + "required": true, + "description": "The unique identifier for the ClickUp Space where the folder will be created. It should be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "folder_name", + "required": true, + "description": "The name of the new folder to be created in the specified space. It should be a string representing the folder's title.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateFolder'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/folder", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "space_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "folder_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateFolderrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Folder Name\"\n }\n ]\n },\n \"example\": {\n \"name\": \"New Folder Name\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateListFromFolderTemplate.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateListFromFolderTemplate.json new file mode 100644 index 00000000..ccf43afb --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateListFromFolderTemplate.json @@ -0,0 +1,205 @@ +{ + "name": "CreateListFromFolderTemplate", + "fully_qualified_name": "ClickupApi.CreateListFromFolderTemplate@0.1.0", + "description": "Create a new list in a folder using a template.\n\nUse this tool to create a new list in a ClickUp folder using an existing list template. Ensure the template is added to your Workspace library before invoking this tool. The tool returns the future List ID immediately, though the list creation may continue asynchronously.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "folder_identifier", + "required": true, + "description": "The ID of the folder where the new list will be created using the specified template.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Folder where the List will be created" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + }, + { + "name": "template_id_for_list_creation", + "required": true, + "description": "ID of the template to use for creating a new list in the folder. Ensure the template is added to your Workspace library.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the template to use" + }, + "inferrable": true, + "http_endpoint_parameter_name": "template_id" + }, + { + "name": "list_details", + "required": true, + "description": "A JSON object containing the properties for the new list, such as 'name' for the list name and 'options' for additional configurations.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Name of the new List" + }, + "options": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateFolderListFromTemplate'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/folder/{folder_id}/list_template/{template_id}", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "folder_id", + "tool_parameter_name": "folder_identifier", + "description": "ID of the Folder where the List will be created", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Folder where the List will be created" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "template_id", + "tool_parameter_name": "template_id_for_list_creation", + "description": "ID of the template to use", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the template to use" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "list_details", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Name of the new List" + }, + "options": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"name\"\n ],\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the new List\"\n },\n \"options\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options\"\n }\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateListFromTemplate.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateListFromTemplate.json new file mode 100644 index 00000000..1ce0b2c6 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateListFromTemplate.json @@ -0,0 +1,695 @@ +{ + "name": "CreateListFromTemplate", + "fully_qualified_name": "ClickupApi.CreateListFromTemplate@0.1.0", + "description": "Create a new list in a ClickUp space using a template.\n\nThis tool creates a new list within a specified ClickUp space using a provided list template. Publicly shared templates must be added to the Workspace before they can be used. The operation can be performed asynchronously or synchronously based on the 'return_immediately' parameter.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_id_for_list_creation", + "required": true, + "description": "ID of the ClickUp Space where the new List will be created using the template.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Space where the List will be created" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "template_id", + "required": true, + "description": "ID of the template to use for creating the list in the specified ClickUp space. It must be accessible in your Workspace.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the template to use" + }, + "inferrable": true, + "http_endpoint_parameter_name": "template_id" + }, + { + "name": "list_creation_options", + "required": true, + "description": "JSON object containing various settings for creating the list, such as 'name', 'options', and other specific parameters. Includes flags for aspects like importing automations, views, and subtasks, remapping dates, and more.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Name of the new List" + }, + "options": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "return_immediately": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n" + }, + "content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "List description" + }, + "time_estimate": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include time (hours, minutes and seconds)" + }, + "automation": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import automation settings" + }, + "include_views": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import views" + }, + "old_due_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' due dates" + }, + "old_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' start dates" + }, + "old_followers": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' watchers" + }, + "comment_attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' comment attachments" + }, + "recur_settings": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' recurring settings" + }, + "old_tags": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' tags" + }, + "old_statuses": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' status settings" + }, + "subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' subtasks" + }, + "custom_type": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' task types" + }, + "old_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' assignees" + }, + "attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' attachments" + }, + "comment": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' comments" + }, + "old_status": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' current statuses" + }, + "external_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' external dependencies" + }, + "internal_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' internal dependencies" + }, + "priority": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' priorities" + }, + "custom_fields": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' Custom Fields" + }, + "old_checklists": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' checklists" + }, + "relationships": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' relationships" + }, + "old_subtask_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' subtask assignees" + }, + "start_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project start date for remapping dates" + }, + "due_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project due date for remapping dates" + }, + "remap_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Remap start dates" + }, + "skip_weekends": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Skip weekends when remapping dates" + }, + "archived": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "1", + "2", + "None" + ], + "properties": null, + "inner_properties": null, + "description": "Include archived tasks" + } + }, + "inner_properties": null, + "description": "Options for creating the List" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateSpaceListFromTemplate'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/list_template/{template_id}", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "space_id_for_list_creation", + "description": "ID of the Space where the List will be created", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the Space where the List will be created" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "template_id", + "tool_parameter_name": "template_id", + "description": "ID of the template to use", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the template to use" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "list_creation_options", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Name of the new List" + }, + "options": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "return_immediately": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n" + }, + "content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "List description" + }, + "time_estimate": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include time (hours, minutes and seconds)" + }, + "automation": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import automation settings" + }, + "include_views": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import views" + }, + "old_due_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' due dates" + }, + "old_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' start dates" + }, + "old_followers": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' watchers" + }, + "comment_attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' comment attachments" + }, + "recur_settings": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' recurring settings" + }, + "old_tags": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' tags" + }, + "old_statuses": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' status settings" + }, + "subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' subtasks" + }, + "custom_type": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' task types" + }, + "old_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' assignees" + }, + "attachments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' attachments" + }, + "comment": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' comments" + }, + "old_status": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' current statuses" + }, + "external_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' external dependencies" + }, + "internal_dependencies": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' internal dependencies" + }, + "priority": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' priorities" + }, + "custom_fields": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' Custom Fields" + }, + "old_checklists": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' checklists" + }, + "relationships": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' relationships" + }, + "old_subtask_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Import tasks' subtask assignees" + }, + "start_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project start date for remapping dates" + }, + "due_date": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Project due date for remapping dates" + }, + "remap_start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Remap start dates" + }, + "skip_weekends": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Skip weekends when remapping dates" + }, + "archived": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "1", + "2", + "None" + ], + "properties": null, + "inner_properties": null, + "description": "Include archived tasks" + } + }, + "inner_properties": null, + "description": "Options for creating the List" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"name\"\n ],\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the new List\"\n },\n \"options\": {\n \"type\": \"object\",\n \"description\": \"Options for creating the List\",\n \"properties\": {\n \"return_immediately\": {\n \"type\": \"boolean\",\n \"description\": \"Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\\n\",\n \"default\": true\n },\n \"content\": {\n \"type\": \"string\",\n \"description\": \"List description\"\n },\n \"time_estimate\": {\n \"type\": \"number\",\n \"description\": \"Include time (hours, minutes and seconds)\"\n },\n \"automation\": {\n \"type\": \"boolean\",\n \"description\": \"Import automation settings\"\n },\n \"include_views\": {\n \"type\": \"boolean\",\n \"description\": \"Import views\"\n },\n \"old_due_date\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' due dates\"\n },\n \"old_start_date\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' start dates\"\n },\n \"old_followers\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' watchers\"\n },\n \"comment_attachments\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' comment attachments\"\n },\n \"recur_settings\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' recurring settings\"\n },\n \"old_tags\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' tags\"\n },\n \"old_statuses\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' status settings\"\n },\n \"subtasks\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' subtasks\"\n },\n \"custom_type\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' task types\"\n },\n \"old_assignees\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' assignees\"\n },\n \"attachments\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' attachments\"\n },\n \"comment\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' comments\"\n },\n \"old_status\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' current statuses\"\n },\n \"external_dependencies\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' external dependencies\"\n },\n \"internal_dependencies\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' internal dependencies\"\n },\n \"priority\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' priorities\"\n },\n \"custom_fields\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' Custom Fields\"\n },\n \"old_checklists\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' checklists\"\n },\n \"relationships\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' relationships\"\n },\n \"old_subtask_assignees\": {\n \"type\": \"boolean\",\n \"description\": \"Import tasks' subtask assignees\"\n },\n \"start_date\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"Project start date for remapping dates\"\n },\n \"due_date\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"Project due date for remapping dates\"\n },\n \"remap_start_date\": {\n \"type\": \"boolean\",\n \"description\": \"Remap start dates\"\n },\n \"skip_weekends\": {\n \"type\": \"boolean\",\n \"description\": \"Skip weekends when remapping dates\"\n },\n \"archived\": {\n \"type\": \"integer\",\n \"enum\": [\n 1,\n 2,\n null\n ],\n \"description\": \"Include archived tasks\"\n }\n }\n }\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateNewClickupTask.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateNewClickupTask.json new file mode 100644 index 00000000..7761329b --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateNewClickupTask.json @@ -0,0 +1,476 @@ +{ + "name": "CreateNewClickupTask", + "fully_qualified_name": "ClickupApi.CreateNewClickupTask@0.1.0", + "description": "Create a new task in ClickUp.\n\nThis tool is used to create a new task in a specified list on ClickUp. It should be called when you need to add a task to your ClickUp project management system.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "target_list_id", + "required": true, + "description": "The ID of the list where the new task will be created. This should be an integer identifying the list in ClickUp.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "task_details", + "required": true, + "description": "JSON object containing task details such as name, description, assignees, status, priority, due dates, and more. Formats and fields are required as specified by ClickUp's task creation endpoint.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "assignees": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "archived": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "group_assignees": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Assign multiple user groups to the task." + }, + "tags": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "status": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "priority": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "time_estimate": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "points": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Add Sprint Points to the task." + }, + "notify_all": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "parent": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "You can create a subtask by including an existing task ID.\\\n \\\nThe `parent` task ID you include can be a subtask, but must be in the same List specified in the path parameter." + }, + "markdown_content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`." + }, + "links_to": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include a task ID to create a linked dependency with your new task." + }, + "check_required_custom_fields": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When creating a task via API any required Custom Fields are ignored by default (`false`).\\\n \\\nYou can enforce required Custom Fields by including `check_required_custom_fields: true`." + }, + "custom_fields": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "You can include one or more Custom Fields to set them when creating a new task.\\\n \\\nCustom Fields that use object and array type values are nullable by sending `\"value\": null`." + }, + "custom_item_id": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The custom task type ID for this task. A value of `null` (default) creates a standard task type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateTask'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/task", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "target_list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "task_details", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "assignees": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "archived": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "group_assignees": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Assign multiple user groups to the task." + }, + "tags": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "status": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "priority": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "time_estimate": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "points": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Add Sprint Points to the task." + }, + "notify_all": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment." + }, + "parent": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "You can create a subtask by including an existing task ID.\\\n \\\nThe `parent` task ID you include can be a subtask, but must be in the same List specified in the path parameter." + }, + "markdown_content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`." + }, + "links_to": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include a task ID to create a linked dependency with your new task." + }, + "check_required_custom_fields": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When creating a task via API any required Custom Fields are ignored by default (`false`).\\\n \\\nYou can enforce required Custom Fields by including `check_required_custom_fields: true`." + }, + "custom_fields": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "You can include one or more Custom Fields to set them when creating a new task.\\\n \\\nCustom Fields that use object and array type values are nullable by sending `\"value\": null`." + }, + "custom_item_id": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The custom task type ID for this task. A value of `null` (default) creates a standard task type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateTaskrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"assignees\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"archived\": {\n \"type\": \"boolean\"\n },\n \"group_assignees\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Assign multiple user groups to the task.\"\n },\n \"tags\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"priority\": {\n \"type\": [\n \"integer\",\n \"null\"\n ],\n \"contentEncoding\": \"int32\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"due_date_time\": {\n \"type\": \"boolean\"\n },\n \"time_estimate\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"start_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"start_date_time\": {\n \"type\": \"boolean\"\n },\n \"points\": {\n \"type\": \"number\",\n \"description\": \"Add Sprint Points to the task.\"\n },\n \"notify_all\": {\n \"type\": \"boolean\",\n \"description\": \"If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.\"\n },\n \"parent\": {\n \"description\": \"You can create a subtask by including an existing task ID.\\\\\\n \\\\\\nThe `parent` task ID you include can be a subtask, but must be in the same List specified in the path parameter.\",\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"markdown_content\": {\n \"type\": \"string\",\n \"description\": \"Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`.\"\n },\n \"links_to\": {\n \"description\": \"Include a task ID to create a linked dependency with your new task.\",\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"check_required_custom_fields\": {\n \"description\": \"When creating a task via API any required Custom Fields are ignored by default (`false`).\\\\\\n \\\\\\nYou can enforce required Custom Fields by including `check_required_custom_fields: true`.\",\n \"type\": \"boolean\"\n },\n \"custom_fields\": {\n \"type\": \"array\",\n \"items\": {\n \"title\": \"SetCustomFieldValueOnCreateTaskrequest\",\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"title\": \"URL Custom Field\",\n \"description\": \"The `value` must be a string with a valid URL.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"example\": \"https://clickup.com/api\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Dropdown Custom Field\",\n \"description\": \"Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"example\": \"uuid1234\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Email Custom Field\",\n \"description\": \"The `value` must be a string with a valid email address.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"example\": \"user@company.com\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Phone Custom Field\",\n \"description\": \"The `value` must be a string with a valid country code.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"example\": \"+1 123 456 7890\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Date Custom Field\",\n \"description\": \"The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"integer\",\n \"null\"\n ],\n \"format\": \"int32\",\n \"example\": 1667367645000\n },\n \"value_options\": {\n \"type\": \"object\",\n \"properties\": {\n \"time\": {\n \"type\": \"boolean\",\n \"example\": true\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Short or Long Text Custom Field\",\n \"description\": \"Enter a string of text.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"example\": \"This is short or long text in a Custom Field.\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Number Custom Field\",\n \"description\": \"Enter a number.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"number\",\n \"null\"\n ],\n \"example\": -28\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Money Custom Field\",\n \"description\": \"You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"number\",\n \"null\"\n ],\n \"example\": 8000\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Task Relationship Custom Field\",\n \"description\": \"Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship. Task Relationship Custom Fields are nullable: `\\\"value\\\": null`.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"People Custom Field\",\n \"description\": \"Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams) People Custom Fields are nullable: `\\\"value\\\": null`.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Emoji (Rating) Custom Field\",\n \"description\": \"Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"integer\",\n \"null\"\n ],\n \"format\": \"int32\",\n \"example\": 4\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Manual Progress Custom Field\",\n \"description\": \"Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) Manual Progress Custom Fields are nullable: `\\\"value\\\": null`.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": \"object\",\n \"required\": [\n \"current\"\n ],\n \"properties\": {\n \"current\": {\n \"type\": \"number\",\n \"example\": 20\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Label Custom Field\",\n \"description\": \"Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) Label Custom Fields are nullable: `\\\"value\\\": null`.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"example\": [\n \"uuid1234\",\n \"uuid9876\"\n ]\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Location Custom Field\",\n \"description\": \"Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"object\",\n \"properties\": {\n \"lat\": {\n \"type\": \"number\"\n },\n \"lng\": {\n \"type\": \"number\"\n }\n }\n },\n \"formatted_address\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Button Custom Field\",\n \"description\": \"Set a button Custom Field to `true` to \\\"click\\\" it. This will trigger the button's action as if it was clicked in the UI.\",\n \"required\": [\n \"id\",\n \"value\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"value\": {\n \"type\": [\n \"boolean\",\n \"null\"\n ],\n \"example\": true\n }\n }\n }\n ]\n },\n \"description\": \"You can include one or more Custom Fields to set them when creating a new task.\\\\\\n \\\\\\nCustom Fields that use object and array type values are nullable by sending `\\\"value\\\": null`.\"\n },\n \"custom_item_id\": {\n \"type\": \"number\",\n \"description\": \"The custom task type ID for this task. A value of `null` (default) creates a standard task type \\\"Task\\\".\\\\\\n \\\\\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems).\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Task Name\",\n \"description\": \"New Task Description\",\n \"assignees\": [\n 183\n ],\n \"archived\": false,\n \"group_assignees\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\"\n ],\n \"tags\": [\n \"tag name 1\"\n ],\n \"status\": \"Open\",\n \"priority\": 3,\n \"due_date\": 1508369194377,\n \"due_date_time\": false,\n \"time_estimate\": 8640000,\n \"start_date\": 1567780450202,\n \"start_date_time\": false,\n \"points\": 3,\n \"notify_all\": true,\n \"parent\": null,\n \"links_to\": null,\n \"check_required_custom_fields\": true,\n \"custom_fields\": [\n {\n \"id\": \"0a52c486-5f05-403b-b4fd-c512ff05131c\",\n \"value\": 23\n },\n {\n \"id\": \"03efda77-c7a0-42d3-8afd-fd546353c2f5\",\n \"value\": \"Text field input\"\n }\n ]\n }\n ]\n },\n \"example\": {\n \"name\": \"New Task Name\",\n \"description\": \"New Task Description\",\n \"markdown_description\": \"New Task Description\",\n \"assignees\": [\n 183\n ],\n \"archived\": false,\n \"group_assignees\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\"\n ],\n \"email_assignees\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f13\"\n ],\n \"tags\": [\n \"tag name 1\"\n ],\n \"status\": \"Open\",\n \"priority\": 3,\n \"due_date\": 1508369194377,\n \"due_date_time\": false,\n \"time_estimate\": 8640000,\n \"start_date\": 1567780450202,\n \"start_date_time\": false,\n \"points\": 3,\n \"notify_all\": true,\n \"parent\": null,\n \"links_to\": null,\n \"check_required_custom_fields\": true,\n \"custom_fields\": [\n {\n \"id\": \"0a52c486-5f05-403b-b4fd-c512ff05131c\",\n \"value\": \"This is a string of text added to a Custom Field.\"\n }\n ]\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateSpaceInWorkspace.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateSpaceInWorkspace.json new file mode 100644 index 00000000..e9403152 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateSpaceInWorkspace.json @@ -0,0 +1,188 @@ +{ + "name": "CreateSpaceInWorkspace", + "fully_qualified_name": "ClickupApi.CreateSpaceInWorkspace@0.1.0", + "description": "Add a new Space to a Workspace.\n\nUse this tool to create a new space within a specified workspace on ClickUp. It should be called when a user wants to organize tasks or projects under a new space in their team environment.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace where the new space will be added. It should be an integer value.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "new_space_configuration", + "required": true, + "description": "JSON object with details for the new space, including its name, multiple assignees option, and features.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "multiple_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "features": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateSpace'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/space", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "new_space_configuration", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "multiple_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "features": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateSpacerequest\",\n \"required\": [\n \"name\",\n \"multiple_assignees\",\n \"features\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"multiple_assignees\": {\n \"type\": \"boolean\"\n },\n \"features\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Space Name\",\n \"multiple_assignees\": true,\n \"features\": {\n \"due_dates\": {\n \"enabled\": true,\n \"start_date\": false,\n \"remap_due_dates\": true,\n \"remap_closed_due_date\": false\n },\n \"time_tracking\": {\n \"enabled\": false\n },\n \"tags\": {\n \"enabled\": true\n },\n \"time_estimates\": {\n \"enabled\": true\n },\n \"checklists\": {\n \"enabled\": true\n },\n \"custom_fields\": {\n \"enabled\": true\n },\n \"remap_dependencies\": {\n \"enabled\": true\n },\n \"dependency_warning\": {\n \"enabled\": true\n },\n \"portfolios\": {\n \"enabled\": true\n }\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New Space Name\",\n \"multiple_assignees\": true,\n \"features\": {\n \"due_dates\": {\n \"enabled\": true,\n \"start_date\": false,\n \"remap_due_dates\": true,\n \"remap_closed_due_date\": false\n },\n \"time_tracking\": {\n \"enabled\": false\n },\n \"tags\": {\n \"enabled\": true\n },\n \"time_estimates\": {\n \"enabled\": true\n },\n \"checklists\": {\n \"enabled\": true\n },\n \"custom_fields\": {\n \"enabled\": true\n },\n \"remap_dependencies\": {\n \"enabled\": true\n },\n \"dependency_warning\": {\n \"enabled\": true\n },\n \"portfolios\": {\n \"enabled\": true\n }\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateTaskFromTemplate.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateTaskFromTemplate.json new file mode 100644 index 00000000..aaf7f386 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateTaskFromTemplate.json @@ -0,0 +1,171 @@ +{ + "name": "CreateTaskFromTemplate", + "fully_qualified_name": "ClickupApi.CreateTaskFromTemplate@0.1.0", + "description": "Create a task using an existing template.\n\nThis tool creates a new task in ClickUp using a specified task template from your workspace. Templates must be added to your Workspace before use. Ideal for automating the creation of standardized tasks.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "target_list_id", + "required": true, + "description": "The ID of the list where the task will be created. This should be an integer associated with the desired list in your workspace.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "task_template_id", + "required": true, + "description": "A string representing the ID of the task template to be used for task creation. Ensure the template is added to your workspace.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "template_id" + }, + { + "name": "task_name", + "required": true, + "description": "The name of the task to be created using the template.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateTaskFromTemplate'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/taskTemplate/{template_id}", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "target_list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "template_id", + "tool_parameter_name": "task_template_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "task_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateTaskFromTemplaterequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New task name\"\n }\n ]\n },\n \"example\": {\n \"name\": \"New task name\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateTeamView.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateTeamView.json new file mode 100644 index 00000000..7e896fd8 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateTeamView.json @@ -0,0 +1,284 @@ +{ + "name": "CreateTeamView", + "fully_qualified_name": "ClickupApi.CreateTeamView@0.1.0", + "description": "Add various views to a workspace at the Everything Level.\n\nThis tool allows you to add different types of views such as List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt to a specified workspace within a team. Use this when you need to create or organize views for better workspace management.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique identifier for the workspace where the view will be added. This corresponds to the team or workspace ID.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "view_configuration", + "required": true, + "description": "JSON object specifying the view details: name, type (e.g., list, board), and optional configurations like grouping, divide, sorting, filters, columns, sidebar, and settings.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateTeamView'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/view", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "view_configuration", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping" + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide" + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting" + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters" + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns" + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar" + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateTeamViewrequest\",\n \"required\": [\n \"name\",\n \"type\",\n \"grouping\",\n \"divide\",\n \"sorting\",\n \"filters\",\n \"columns\",\n \"team_sidebar\",\n \"settings\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"description\": \"The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`.\"\n },\n \"grouping\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping\"\n },\n \"divide\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide\"\n },\n \"sorting\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting\"\n },\n \"filters\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters\"\n },\n \"columns\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns\"\n },\n \"team_sidebar\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar\"\n },\n \"settings\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New Team View Name\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": []\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": []\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New Everything level View\",\n \"type\": \"list\",\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n },\n \"filters\": {\n \"op\": \"AND\",\n \"field\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"op\": \"EQ\",\n \"determinor\": null,\n \"idx\": 0,\n \"values\": \"123\"\n }\n ],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": [\n {\n \"field\": \"assignee\",\n \"idx\": 0,\n \"width\": 160,\n \"hidden\": true,\n \"name\": null,\n \"display\": null\n }\n ]\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateThreadedComment.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateThreadedComment.json new file mode 100644 index 00000000..b8c83ad8 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateThreadedComment.json @@ -0,0 +1,138 @@ +{ + "name": "CreateThreadedComment", + "fully_qualified_name": "ClickupApi.CreateThreadedComment@0.1.0", + "description": "Create a threaded comment in a ClickUp task.\n\nThis tool is used to create a threaded comment as a reply to an existing comment in a ClickUp task. It is useful when you want to continue a discussion or provide additional information to a specific comment thread.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "parent_comment_id", + "required": true, + "description": "The ID of the parent comment to which the threaded reply will be attached. It should be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "comment_id" + }, + { + "name": "threaded_comment_content", + "required": true, + "description": "This is the content of the threaded comment to be added. Provide the text that forms the body of the reply.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateThreadedComment'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/comment/{comment_id}/reply", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "comment_id", + "tool_parameter_name": "parent_comment_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "threaded_comment_content", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1task~1%7Btask_id%7D~1comment/post/requestBody/content/application~1json/schema\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1task~1%7Btask_id%7D~1comment/post/requestBody/content/application~1json/schema\"\n },\n \"example\": {\n \"comment_text\": \"Task comment content\",\n \"assignee\": 183,\n \"group_assignee\": \"d01f92f-48ca-446d-88a1-0beb0e8f5f14\",\n \"notify_all\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateTimeEntry.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateTimeEntry.json new file mode 100644 index 00000000..5415a771 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateTimeEntry.json @@ -0,0 +1,400 @@ +{ + "name": "CreateTimeEntry", + "fully_qualified_name": "ClickupApi.CreateTimeEntry@0.1.0", + "description": "Create a new time entry for tracking work.\n\nUse this tool to log a new time entry for a specific team. If the duration is negative, it indicates that a timer is running for the user.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "team_id_numeric", + "required": true, + "description": "The numeric ID of the workspace. Required if referencing a task by custom task ID.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_Id" + }, + { + "name": "time_entry_details", + "required": true, + "description": "JSON object providing details for the time entry, including 'description', 'start', 'stop', 'tags', 'billable', 'assignee', 'tid'.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tag_fg": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tag_bg": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "description": "Users on the Business Plan and above can include a time tracking label." + }, + "start": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "stop": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The `duration` parameter can be used instead of the `stop` parameter. " + }, + "end": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "billable": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "duration": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When there are values for both `start` and `end`, `duration` is ignored. The `stop` parameter can be used instead of the `duration` parameter." + }, + "assignee": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace owners and admins can include any user id. Workspace members can only include their own user id." + }, + "tid": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "Associate a time entry with a task using the `tid` parameter." + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "workspace_id", + "required": false, + "description": "Required if `custom_task_ids` is true. Provide the Workspace ID for the team.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task id.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Createatimeentry'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_Id}/time_entries", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_Id", + "tool_parameter_name": "team_id_numeric", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "time_entry_details", + "description": "Associate a time entry with a task using the `tid` parameter.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tag_fg": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tag_bg": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "description": "Users on the Business Plan and above can include a time tracking label." + }, + "start": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "stop": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The `duration` parameter can be used instead of the `stop` parameter. " + }, + "end": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "billable": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "duration": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When there are values for both `start` and `end`, `duration` is ignored. The `stop` parameter can be used instead of the `duration` parameter." + }, + "assignee": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace owners and admins can include any user id. Workspace members can only include their own user id." + }, + "tid": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "Associate a time entry with a task using the `tid` parameter." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"Associate a time entry with a task using the `tid` parameter.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Createatimeentryrequest\",\n \"required\": [\n \"start\",\n \"duration\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\"\n },\n \"tags\": {\n \"description\": \"Users on the Business Plan and above can include a time tracking label.\",\n \"type\": \"array\",\n \"items\": {\n \"title\": \"Tags6\",\n \"required\": [\n \"name\",\n \"tag_fg\",\n \"tag_bg\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"tag_fg\": {\n \"type\": \"string\"\n },\n \"tag_bg\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Tag name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n ]\n }\n },\n \"start\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"stop\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\",\n \"description\": \"The `duration` parameter can be used instead of the `stop` parameter. \"\n },\n \"end\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"billable\": {\n \"type\": \"boolean\"\n },\n \"duration\": {\n \"description\": \"When there are values for both `start` and `end`, `duration` is ignored. The `stop` parameter can be used instead of the `duration` parameter.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"assignee\": {\n \"description\": \"Workspace owners and admins can include any user id. Workspace members can only include their own user id.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"tid\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"description\": \"from api\",\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ],\n \"start\": 1595282645000,\n \"end\": 1595282660000,\n \"billable\": true,\n \"duration\": 50000,\n \"assignee\": 1,\n \"tid\": \"task_id\"\n }\n ]\n },\n \"example\": {\n \"description\": \"from api\",\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ],\n \"start\": 1595282645000,\n \"billable\": true,\n \"duration\": 50000,\n \"assignee\": 1,\n \"tid\": \"task_id\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateUserGroup.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateUserGroup.json new file mode 100644 index 00000000..298f63aa --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateUserGroup.json @@ -0,0 +1,204 @@ +{ + "name": "CreateUserGroup", + "fully_qualified_name": "ClickupApi.CreateUserGroup@0.1.0", + "description": "Create a user group within a ClickUp workspace.\n\nUse this tool to organize and manage users by creating a user group within a specific ClickUp workspace. Note that adding a guest with view-only permissions converts them to a paid guest, potentially incurring additional costs.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique ID of the ClickUp workspace where the user group will be created.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "group_name", + "required": true, + "description": "The name of the user group to be created within the workspace. This should be a descriptive name to identify the group easily.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "user_group_members", + "required": true, + "description": "List of user IDs to include in the user group. Each ID should be an integer representing a user within the workspace.", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "members" + }, + { + "name": "group_handle", + "required": false, + "description": "A unique string identifier for the user group to be created. This will be used as the group's handle within the workspace.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "handle" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateUserGroup'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/group", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "group_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "handle", + "tool_parameter_name": "group_handle", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "members", + "tool_parameter_name": "user_group_members", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateTeamrequest\",\n \"required\": [\n \"name\",\n \"members\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"handle\": {\n \"type\": \"string\"\n },\n \"members\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"name\": \"New team name\",\n \"handle\": \"newteamname\",\n \"members\": [\n 123456,\n 987654\n ]\n }\n ]\n },\n \"example\": {\n \"name\": \"New User Group name\",\n \"handle\": \"newusergroupname\",\n \"members\": [\n 123456,\n 987654\n ]\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/CreateWorkspaceGoal.json b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateWorkspaceGoal.json new file mode 100644 index 00000000..a1f2b3d1 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/CreateWorkspaceGoal.json @@ -0,0 +1,303 @@ +{ + "name": "CreateWorkspaceGoal", + "fully_qualified_name": "ClickupApi.CreateWorkspaceGoal@0.1.0", + "description": "Add a new goal to a specified workspace.\n\nThis tool allows you to create a new goal in a specific workspace by providing the necessary details. Use it to set objectives and track progress within teams.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace where the goal will be added. This is a numeric value.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "goal_name", + "required": true, + "description": "The name or title of the goal to be added to the workspace.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "due_date_timestamp", + "required": true, + "description": "The due date for the goal as a Unix timestamp in milliseconds. Represents when the goal should be completed.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date" + }, + { + "name": "goal_description", + "required": true, + "description": "A brief explanation of the goal to be added, providing context and details.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "description" + }, + { + "name": "goal_owners", + "required": true, + "description": "Array of user IDs for those assigned to own the goal, allowing multiple owners.", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of user IDs." + }, + "inferrable": true, + "http_endpoint_parameter_name": "owners" + }, + { + "name": "goal_color", + "required": true, + "description": "The color code for the goal. Expected to be a string representing a color, such as a hex code like '#FF5733'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "color" + }, + { + "name": "allow_multiple_owners", + "required": true, + "description": "Set to true to allow a goal to have multiple owners, or false for a single owner.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "multiple_owners" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateGoal'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/goal", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "goal_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date", + "tool_parameter_name": "due_date_timestamp", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "description", + "tool_parameter_name": "goal_description", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "multiple_owners", + "tool_parameter_name": "allow_multiple_owners", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "owners", + "tool_parameter_name": "goal_owners", + "description": "Array of user IDs.", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of user IDs." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "color", + "tool_parameter_name": "goal_color", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateGoalrequest\",\n \"required\": [\n \"name\",\n \"due_date\",\n \"description\",\n \"multiple_owners\",\n \"owners\",\n \"color\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"multiple_owners\": {\n \"type\": \"boolean\"\n },\n \"owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"Array of user IDs.\"\n },\n \"color\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Goal Name\",\n \"due_date\": 1568036964079,\n \"description\": \"Goal Description\",\n \"multiple_owners\": true,\n \"owners\": [\n 183\n ],\n \"color\": \"#32a852\"\n }\n ]\n },\n \"example\": {\n \"name\": \"Goal Name\",\n \"due_date\": 1568036964079,\n \"description\": \"Goal Description\",\n \"multiple_owners\": true,\n \"owners\": [\n 183\n ],\n \"color\": \"#32a852\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteChecklist.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteChecklist.json new file mode 100644 index 00000000..692c3f0e --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteChecklist.json @@ -0,0 +1,105 @@ +{ + "name": "DeleteChecklist", + "fully_qualified_name": "ClickupApi.DeleteChecklist@0.1.0", + "description": "Deletes a checklist from a task in ClickUp.\n\nUse this tool to delete a specific checklist from a task in ClickUp by providing the checklist ID. Ideal for when you need to manage or reorganize task checklists.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "checklist_id", + "required": true, + "description": "The unique identifier for the checklist to be deleted. It should be in UUID format.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "checklist_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteChecklist'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/checklist/{checklist_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "checklist_id", + "tool_parameter_name": "checklist_id", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteGoal.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteGoal.json new file mode 100644 index 00000000..afa20c25 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteGoal.json @@ -0,0 +1,138 @@ +{ + "name": "DeleteGoal", + "fully_qualified_name": "ClickupApi.DeleteGoal@0.1.0", + "description": "Deletes a goal from your workspace in ClickUp.\n\nUse this tool to remove a specified goal from your ClickUp workspace by providing the goal ID.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "goal_identifier", + "required": true, + "description": "The unique identifier for the goal to be deleted. It must be a valid UUID.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "goal_id" + }, + { + "name": "content_type_header", + "required": true, + "description": "Specify the Content-Type header. Typically set to 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteGoal'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/goal/{goal_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "goal_id", + "tool_parameter_name": "goal_identifier", + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteGoalTarget.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteGoalTarget.json new file mode 100644 index 00000000..595c42ca --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteGoalTarget.json @@ -0,0 +1,105 @@ +{ + "name": "DeleteGoalTarget", + "fully_qualified_name": "ClickupApi.DeleteGoalTarget@0.1.0", + "description": "Delete a target from a goal in ClickUp.\n\nUse this tool to delete a key result (target) from a goal in ClickUp when a specific target needs to be removed.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "goal_target_id", + "required": true, + "description": "The unique identifier (UUID) of the key result to delete from the goal in ClickUp.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "8480-49bc-8c57-e569747efe93 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "key_result_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteKeyResult'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/key_result/{key_result_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "key_result_id", + "tool_parameter_name": "goal_target_id", + "description": "8480-49bc-8c57-e569747efe93 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "8480-49bc-8c57-e569747efe93 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteSpaceTag.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteSpaceTag.json new file mode 100644 index 00000000..c60be7d8 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteSpaceTag.json @@ -0,0 +1,189 @@ +{ + "name": "DeleteSpaceTag", + "fully_qualified_name": "ClickupApi.DeleteSpaceTag@0.1.0", + "description": "Delete a task tag from a space in ClickUp.\n\nUse this tool to delete a specific task tag from a designated space in ClickUp. Ideal for cleaning up or reorganizing tags within a space.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_identifier", + "required": true, + "description": "The unique identifier of the space from which the tag will be deleted. This should be an integer value.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "tag_name_to_delete", + "required": true, + "description": "The name of the tag to be deleted from the specified space. Ensure this tag name exists in the target space.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag_name" + }, + { + "name": "tag_to_delete", + "required": true, + "description": "JSON object specifying the tag to be deleted from the space.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "tag": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteSpaceTag'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/tag/{tag_name}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "space_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag_name", + "tool_parameter_name": "tag_name_to_delete", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "tag_to_delete", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "tag": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"DeleteSpaceTagrequest\",\n \"required\": [\n \"tag\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"tag\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag\"\n }\n },\n \"examples\": [\n {\n \"tag\": {\n \"name\": \"Tag name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n }\n ]\n },\n \"example\": {\n \"tag\": {\n \"name\": \"Tag name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTask.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTask.json new file mode 100644 index 00000000..5ffdd782 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTask.json @@ -0,0 +1,204 @@ +{ + "name": "DeleteTask", + "fully_qualified_name": "ClickupApi.DeleteTask@0.1.0", + "description": "Delete a task from your ClickUp Workspace.\n\nUse this tool to delete a specific task from your ClickUp Workspace by providing the task ID. It should be called when you want to permanently remove a task.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_id", + "required": true, + "description": "The ID of the task to be deleted. This is mandatory and should be a valid task identifier.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "content_type", + "required": true, + "description": "Specify the media type of the resource. Typically set as 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + }, + { + "name": "workspace_id", + "required": false, + "description": "Provide the Workspace ID when referencing a task by its custom task ID. Required if `custom_task_ids` is true.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true if referencing a task by custom task ID is required.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteTask'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by its custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTaskChecklistItem.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTaskChecklistItem.json new file mode 100644 index 00000000..5d0504ad --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTaskChecklistItem.json @@ -0,0 +1,138 @@ +{ + "name": "DeleteTaskChecklistItem", + "fully_qualified_name": "ClickupApi.DeleteTaskChecklistItem@0.1.0", + "description": "Delete an item from a task checklist in ClickUp.\n\nUse this tool to delete a specific line item from a checklist associated with a task. Ideal for managing and updating task checklists by removing unnecessary or completed items.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "checklist_identifier", + "required": true, + "description": "The unique identifier (UUID) for the checklist. Used to specify the checklist from which the item will be deleted.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "checklist_id" + }, + { + "name": "checklist_item_uuid", + "required": true, + "description": "The unique identifier (UUID) of the checklist item to be deleted.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "checklist_item_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteChecklistItem'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "checklist_id", + "tool_parameter_name": "checklist_identifier", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "checklist_item_id", + "tool_parameter_name": "checklist_item_uuid", + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTaskComment.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTaskComment.json new file mode 100644 index 00000000..bf8d5493 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTaskComment.json @@ -0,0 +1,105 @@ +{ + "name": "DeleteTaskComment", + "fully_qualified_name": "ClickupApi.DeleteTaskComment@0.1.0", + "description": "Delete a comment from a task.\n\nUse this tool to delete a specific comment from a task. It should be called when you need to remove a comment based on its unique identifier.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "comment_id", + "required": true, + "description": "The unique integer identifier of the comment to be deleted.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "comment_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteComment'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/comment/{comment_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "comment_id", + "tool_parameter_name": "comment_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTimeEntry.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTimeEntry.json new file mode 100644 index 00000000..e49da44c --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteTimeEntry.json @@ -0,0 +1,171 @@ +{ + "name": "DeleteTimeEntry", + "fully_qualified_name": "ClickupApi.DeleteTimeEntry@0.1.0", + "description": "Deletes a time entry from a ClickUp workspace.\n\nUse this tool to delete a specific time entry from a ClickUp workspace. This should be called when you need to remove a recorded time entry by specifying the team and timer identifiers.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique identifier for the ClickUp workspace from which you want to delete the time entry.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "timer_ids_to_delete", + "required": true, + "description": "Comma-separated list of timer IDs to delete.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of timer ids to delete separated by commas" + }, + "inferrable": true, + "http_endpoint_parameter_name": "timer_id" + }, + { + "name": "content_type_header", + "required": true, + "description": "Specify the content type of the request, usually 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteatimeEntry'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/time_entries/{timer_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "timer_id", + "tool_parameter_name": "timer_ids_to_delete", + "description": "Array of timer ids to delete separated by commas", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of timer ids to delete separated by commas" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteUserGroup.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteUserGroup.json new file mode 100644 index 00000000..e2e6aae0 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteUserGroup.json @@ -0,0 +1,105 @@ +{ + "name": "DeleteUserGroup", + "fully_qualified_name": "ClickupApi.DeleteUserGroup@0.1.0", + "description": "Delete a user group from your ClickUp workspace.\n\nThis tool removes a user group from your ClickUp workspace based on the provided group ID.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "user_group_id", + "required": true, + "description": "The identifier of the user group to be deleted from the workspace.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "User Group ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "group_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteTeam'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/group/{group_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "group_id", + "tool_parameter_name": "user_group_id", + "description": "User Group ID", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "User Group ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteView.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteView.json new file mode 100644 index 00000000..b3cd04c3 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteView.json @@ -0,0 +1,105 @@ +{ + "name": "DeleteView", + "fully_qualified_name": "ClickupApi.DeleteView@0.1.0", + "description": "Delete a specified view from ClickUp.\n\nUse this tool to delete a specific view in ClickUp by providing the view ID. Useful for managing and organizing views by removing those that are no longer needed.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "view_id", + "required": true, + "description": "The ID of the view to be deleted in ClickUp. Must be provided as a string.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "view_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteView'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/view/{view_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "view_id", + "tool_parameter_name": "view_id", + "description": "105 (string)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWebhook.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWebhook.json new file mode 100644 index 00000000..4c0ac63d --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWebhook.json @@ -0,0 +1,105 @@ +{ + "name": "DeleteWebhook", + "fully_qualified_name": "ClickupApi.DeleteWebhook@0.1.0", + "description": "Delete a webhook to stop event monitoring.\n\nUse this tool to delete a webhook, which will stop monitoring events and locations associated with it. Useful for managing and updating your event tracking preferences.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "webhook_id", + "required": true, + "description": "The unique identifier for the webhook to be deleted. Must be in UUID format.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e506-4a29-9d42-26e504e3435e (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "webhook_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteWebhook'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/webhook/{webhook_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "webhook_id", + "tool_parameter_name": "webhook_id", + "description": "e506-4a29-9d42-26e504e3435e (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e506-4a29-9d42-26e504e3435e (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceFolder.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceFolder.json new file mode 100644 index 00000000..90a34b5f --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceFolder.json @@ -0,0 +1,105 @@ +{ + "name": "DeleteWorkspaceFolder", + "fully_qualified_name": "ClickupApi.DeleteWorkspaceFolder@0.1.0", + "description": "Delete a folder from your ClickUp workspace.\n\nUse this tool to permanently delete a specific folder from your ClickUp workspace. Ensure you have the correct folder ID before performing this action.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "folder_id", + "required": true, + "description": "The unique ID of the folder to be deleted from your ClickUp workspace. Ensure this ID is correct to avoid unintended deletions.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteFolder'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/folder/{folder_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "folder_id", + "tool_parameter_name": "folder_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceList.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceList.json new file mode 100644 index 00000000..b7cfa49c --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceList.json @@ -0,0 +1,138 @@ +{ + "name": "DeleteWorkspaceList", + "fully_qualified_name": "ClickupApi.DeleteWorkspaceList@0.1.0", + "description": "Delete a list from your ClickUp workspace.\n\nUse this tool to remove a specific list from your ClickUp workspace when it's no longer needed.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_list_id", + "required": true, + "description": "The unique integer ID of the list to be deleted from the ClickUp workspace.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "content_type_header", + "required": true, + "description": "Specifies the media type of the request. Typically set to 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteList'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "workspace_list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceSpace.json b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceSpace.json new file mode 100644 index 00000000..89f07078 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/DeleteWorkspaceSpace.json @@ -0,0 +1,105 @@ +{ + "name": "DeleteWorkspaceSpace", + "fully_qualified_name": "ClickupApi.DeleteWorkspaceSpace@0.1.0", + "description": "Delete a space from your ClickUp workspace.\n\nUse this tool to delete a specific space in your ClickUp workspace by providing the space ID. It permanently removes the space and all associated data.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_space_id", + "required": true, + "description": "The unique identifier for the space to delete in your ClickUp workspace. Provide the specific space ID to permanently remove the space and its data.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteSpace'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "workspace_space_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/EditChecklist.json b/toolkits/clickup_api/clickup_api/wrapper_tools/EditChecklist.json new file mode 100644 index 00000000..eb3aae63 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/EditChecklist.json @@ -0,0 +1,171 @@ +{ + "name": "EditChecklist", + "fully_qualified_name": "ClickupApi.EditChecklist@0.1.0", + "description": "Rename or reorder a task checklist in ClickUp.\n\nUse this tool to rename a checklist or change its order within a task in ClickUp. It is suitable when you need to update the checklist name or adjust its position in relation to other checklists in a specific task.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "checklist_id", + "required": true, + "description": "The unique identifier (UUID) of the checklist to be edited or reordered.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "checklist_id" + }, + { + "name": "checklist_name", + "required": false, + "description": "The new name for the checklist. Leave empty if you do not wish to rename.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "checklist_position", + "required": false, + "description": "Specify the order in which the checklist should appear on a task. Use 0 to place it at the top.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Position refers to the order of appearance of checklists on a task.\\\n \\\nTo set a checklist to appear at the top of the checklists section of a task, use `\"position\": 0`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "position" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'EditChecklist'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/checklist/{checklist_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "checklist_id", + "tool_parameter_name": "checklist_id", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "checklist_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "position", + "tool_parameter_name": "checklist_position", + "description": "Position refers to the order of appearance of checklists on a task.\\\n \\\nTo set a checklist to appear at the top of the checklists section of a task, use `\"position\": 0`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Position refers to the order of appearance of checklists on a task.\\\n \\\nTo set a checklist to appear at the top of the checklists section of a task, use `\"position\": 0`." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditChecklistrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"position\": {\n \"description\": \"Position refers to the order of appearance of checklists on a task.\\\\\\n \\\\\\nTo set a checklist to appear at the top of the checklists section of a task, use `\\\"position\\\": 0`.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Checklist\",\n \"position\": 1\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Checklist\",\n \"position\": 1\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/EditLegacyTimeEntry.json b/toolkits/clickup_api/clickup_api/wrapper_tools/EditLegacyTimeEntry.json new file mode 100644 index 00000000..f49879fb --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/EditLegacyTimeEntry.json @@ -0,0 +1,303 @@ +{ + "name": "EditLegacyTimeEntry", + "fully_qualified_name": "ClickupApi.EditLegacyTimeEntry@0.1.0", + "description": "Edit a legacy time tracked entry for a task in ClickUp.\n\nUse this tool to modify an existing time entry on a specific task using the legacy endpoint in ClickUp. It's recommended to use newer APIs for time tracking, but this can be used for older integrations.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_identifier", + "required": true, + "description": "The unique identifier of the task for which the legacy time entry is being edited. This is required to specify the task in ClickUp.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "legacy_time_interval_id", + "required": true, + "description": "The unique identifier for the time interval to be edited.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "interval_id" + }, + { + "name": "start_timestamp", + "required": true, + "description": "The start time of the time entry as a Unix timestamp in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "start" + }, + { + "name": "end_time_epoch", + "required": true, + "description": "The end time of the tracked interval in Unix epoch format. It marks when the time entry should conclude.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "end" + }, + { + "name": "time_duration_in_seconds", + "required": true, + "description": "The total time duration (in seconds) for the time entry to be updated. This modifies the tracked time for a specific task.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "time" + }, + { + "name": "workspace_id", + "required": false, + "description": "The Workspace ID required when custom task IDs are used. This must be set if `custom_task_ids` is `true`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Edittimetracked'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/time/{interval_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "interval_id", + "tool_parameter_name": "legacy_time_interval_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "start", + "tool_parameter_name": "start_timestamp", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "end", + "tool_parameter_name": "end_time_epoch", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "time", + "tool_parameter_name": "time_duration_in_seconds", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"Edit the start, end, or total time of a time tracked entry.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Edittimetrackedrequest\",\n \"required\": [\n \"start\",\n \"end\",\n \"time\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"start\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"end\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"time\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"start\": 1567780450202,\n \"end\": 1508369194377,\n \"time\": 8640000\n }\n ]\n },\n \"example\": {\n \"start\": 1567780450202,\n \"end\": 1508369194377,\n \"time\": 8640000\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetAuthorizedTeams.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetAuthorizedTeams.json new file mode 100644 index 00000000..d22c0c84 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetAuthorizedTeams.json @@ -0,0 +1,70 @@ +{ + "name": "GetAuthorizedTeams", + "fully_qualified_name": "ClickupApi.GetAuthorizedTeams@0.1.0", + "description": "Retrieve the workspaces for the authenticated user.\n\nUse this tool to get a list of workspaces (teams) available to the user who is currently authenticated. It provides an overview of the user's accessible workspaces in ClickUp.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [] + }, + "output": { + "description": "Response from the API endpoint 'GetAuthorizedTeams'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team", + "http_method": "GET", + "headers": {}, + "parameters": [], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetClickupAccessToken.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetClickupAccessToken.json new file mode 100644 index 00000000..d0949083 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetClickupAccessToken.json @@ -0,0 +1,155 @@ +{ + "name": "GetClickupAccessToken", + "fully_qualified_name": "ClickupApi.GetClickupAccessToken@0.1.0", + "description": "Obtain an OAuth access token for ClickUp API authentication.\n\nUse this tool to obtain an OAuth access token for authenticating applications with the ClickUp API. This tool is not for personal API tokens and does not support the 'Try It' feature in browser-based API documentation.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "oauth_credentials", + "required": true, + "description": "JSON object containing 'client_id', 'client_secret', and 'code' for OAuth access.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "client_id": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "OAuth app client id" + }, + "client_secret": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "OAuth app client secret" + }, + "code": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Code given in redirect url" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetAccessToken'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/oauth/token", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "requestBody", + "tool_parameter_name": "oauth_credentials", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "client_id": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "OAuth app client id" + }, + "client_secret": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "OAuth app client secret" + }, + "code": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Code given in redirect url" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"GetAccessTokenrequest\",\n \"required\": [\n \"client_id\",\n \"client_secret\",\n \"code\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"client_id\": {\n \"type\": \"string\",\n \"description\": \"OAuth app client id\"\n },\n \"client_secret\": {\n \"type\": \"string\",\n \"description\": \"OAuth app client secret\"\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \"Code given in redirect url\"\n }\n },\n \"examples\": [\n {\n \"client_id\": \"your_client_id\",\n \"client_secret\": \"your_client_secret\",\n \"code\": \"authorization_code\"\n }\n ]\n },\n \"example\": {\n \"client_id\": \"your_client_id\",\n \"client_secret\": \"your_client_secret\",\n \"code\": \"authorization_code\"\n }\n },\n \"application/x-www-form-urlencoded\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1oauth~1token/post/requestBody/content/application~1json/schema\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1oauth~1token/post/requestBody/content/application~1json/schema\"\n },\n \"example\": {\n \"client_id\": \"your_client_id\",\n \"client_secret\": \"your_client_secret\",\n \"code\": \"authorization_code\"\n }\n }\n }\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetClickupUserDetails.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetClickupUserDetails.json new file mode 100644 index 00000000..210746a8 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetClickupUserDetails.json @@ -0,0 +1,70 @@ +{ + "name": "GetClickupUserDetails", + "fully_qualified_name": "ClickupApi.GetClickupUserDetails@0.1.0", + "description": "Get details of the authenticated ClickUp user's account.\n\n", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [] + }, + "output": { + "description": "Response from the API endpoint 'GetAuthorizedUser'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/user", + "http_method": "GET", + "headers": {}, + "parameters": [], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetCurrentRunningTimeEntry.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetCurrentRunningTimeEntry.json new file mode 100644 index 00000000..7e24ad8e --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetCurrentRunningTimeEntry.json @@ -0,0 +1,171 @@ +{ + "name": "GetCurrentRunningTimeEntry", + "fully_qualified_name": "ClickupApi.GetCurrentRunningTimeEntry@0.1.0", + "description": "Retrieve the current running time entry for the user.\n\nUse this tool to view the time entry that is currently tracking time for the authenticated user. It indicates which timer is actively running. A negative duration suggests an ongoing timer.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace to retrieve the running time entry for. It identifies the specific workspace within ClickUp.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "content_type_header", + "required": true, + "description": "The MIME type of the content, e.g., 'application/json'. Required for HTTP content negotiation.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + }, + { + "name": "assignee_user_id", + "required": false, + "description": "The user ID of the time entry assignee for whom the current running timer is being retrieved. This identifies which user's timer is actively running.", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "user id" + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignee" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Getrunningtimeentry'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/time_entries/current", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "assignee", + "tool_parameter_name": "assignee_user_id", + "description": "user id", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "user id" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetFilteredTeamTasks.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetFilteredTeamTasks.json new file mode 100644 index 00000000..93ed6636 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetFilteredTeamTasks.json @@ -0,0 +1,864 @@ +{ + "name": "GetFilteredTeamTasks", + "fully_qualified_name": "ClickupApi.GetFilteredTeamTasks@0.1.0", + "description": "Retrieve tasks from a workspace based on specified filters.\n\nThis tool retrieves tasks from a specified workspace that meet certain criteria. The response is limited to 100 tasks per page, and only tasks that the user has access to are returned. The tool is useful for viewing filtered task information from multiple lists, folders, or spaces.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace to retrieve tasks from. Must be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_Id" + }, + { + "name": "page_number_to_fetch", + "required": false, + "description": "Page number to fetch, starting at 0, in the paginated list of tasks.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Page to fetch (starts at 0)." + }, + "inferrable": true, + "http_endpoint_parameter_name": "page" + }, + { + "name": "order_tasks_by", + "required": false, + "description": "Specify the field by which to order tasks. Options include: 'id', 'created', 'updated', 'due_date'. Defaults to 'created'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "order_by" + }, + { + "name": "filter_by_space_ids", + "required": false, + "description": "An array of space IDs to filter tasks by. Example values: ['1234', '6789'].", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Spaces. For example: \\\n \\\n`?space_ids[]=1234&space_ids[]=6789`" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_ids[]" + }, + { + "name": "filter_by_project_ids", + "required": false, + "description": "An array of folder IDs to filter tasks by specific folders. For example, ['1234', '6789'].", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Folders. For example: \\\n \\\n`?project_ids[]=1234&project_ids[]=6789`" + }, + "inferrable": true, + "http_endpoint_parameter_name": "project_ids[]" + }, + { + "name": "filter_by_list_ids", + "required": false, + "description": "An array of list IDs to filter tasks by. Example: [\"1234\", \"6789\"].", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Lists. For example: \\\n \\\n`?list_ids[]=1234&list_ids[]=6789` " + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_ids[]" + }, + { + "name": "status_filters", + "required": false, + "description": "Filter tasks by their statuses. Use '%20' for spaces. Example: ['to%20do', 'in%20progress'].", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by statuses. Use `%20` to represent a space character. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`" + }, + "inferrable": true, + "http_endpoint_parameter_name": "statuses[]" + }, + { + "name": "assignee_ids", + "required": false, + "description": "Filter tasks by assignee using their ClickUp user IDs.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Assignees using people's ClickUp user id. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`" + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignees[]" + }, + { + "name": "filter_by_tags", + "required": false, + "description": "Filter tasks by tags. Use `%20` for spaces within tags. Example: `urgent%20task`.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by tags. User `%20` to represent a space character. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tags[]" + }, + { + "name": "due_date_greater_than", + "required": false, + "description": "Filter tasks by a due date greater than the specified Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date greater than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date_gt" + }, + { + "name": "due_date_before", + "required": false, + "description": "Filter tasks with due dates earlier than the specified Unix timestamp in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date less than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date_lt" + }, + { + "name": "filter_created_date_after", + "required": false, + "description": "Filter tasks by creation date greater than the specified Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created greater than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_created_gt" + }, + { + "name": "filter_by_date_created_before", + "required": false, + "description": "Filter tasks created before this date. Specify as Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created less than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_created_lt" + }, + { + "name": "filter_by_updated_date_greater_than", + "required": false, + "description": "Filter tasks by their updated date, greater than the specified Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated greater than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_updated_gt" + }, + { + "name": "filter_by_update_date_before", + "required": false, + "description": "Filter tasks updated before a specific date, provided as Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated less than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_updated_lt" + }, + { + "name": "filter_by_date_done_after", + "required": false, + "description": "Filter tasks by the completion date after the given Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done greater than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_done_gt" + }, + { + "name": "filter_by_done_date_before", + "required": false, + "description": "Filter tasks completed before a specific date. Provide the date in Unix time (milliseconds).", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done less than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_done_lt" + }, + { + "name": "filter_by_custom_fields", + "required": false, + "description": "Include tasks with specific values in Custom Fields. Provide an array of objects with field_id, operator, and value keys.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"}{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. The `=` operator isn't supported with Label Custom Fields.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_fields" + }, + { + "name": "parent_task_id", + "required": false, + "description": "Include the parent task ID to return subtasks in the response.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the parent task ID to return subtasks." + }, + "inferrable": true, + "http_endpoint_parameter_name": "parent" + }, + { + "name": "custom_task_type_filters", + "required": false, + "description": "Filter tasks by custom task types. Use `0` for tasks, `1` for Milestones, and other numbers for Workspace-defined types.", + "value_schema": { + "val_type": "array", + "inner_val_type": "number", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_items[]" + }, + { + "name": "display_tasks_in_reverse_order", + "required": false, + "description": "Set to true to display tasks in reverse order.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Tasks are displayed in reverse order." + }, + "inferrable": true, + "http_endpoint_parameter_name": "reverse" + }, + { + "name": "include_subtasks", + "required": false, + "description": "Set to true to include subtasks, or false to exclude them. Defaults to false (exclude).", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or exclude subtasks. By default, subtasks are excluded." + }, + "inferrable": true, + "http_endpoint_parameter_name": "subtasks" + }, + { + "name": "include_closed_tasks", + "required": false, + "description": "Set to true to include closed tasks, false to exclude them. By default, closed tasks are excluded.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_closed" + }, + { + "name": "include_markdown_description", + "required": false, + "description": "Set to true to return task descriptions in Markdown format. Default is false.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_markdown_description" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetFilteredTeamTasks'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_Id}/task", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "page", + "tool_parameter_name": "page_number_to_fetch", + "description": "Page to fetch (starts at 0).", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Page to fetch (starts at 0)." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "order_by", + "tool_parameter_name": "order_tasks_by", + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "reverse", + "tool_parameter_name": "display_tasks_in_reverse_order", + "description": "Tasks are displayed in reverse order.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Tasks are displayed in reverse order." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "subtasks", + "tool_parameter_name": "include_subtasks", + "description": "Include or exclude subtasks. By default, subtasks are excluded.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or exclude subtasks. By default, subtasks are excluded." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "space_ids[]", + "tool_parameter_name": "filter_by_space_ids", + "description": "Filter by Spaces. For example: \\\n \\\n`?space_ids[]=1234&space_ids[]=6789`", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Spaces. For example: \\\n \\\n`?space_ids[]=1234&space_ids[]=6789`" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "project_ids[]", + "tool_parameter_name": "filter_by_project_ids", + "description": "Filter by Folders. For example: \\\n \\\n`?project_ids[]=1234&project_ids[]=6789`", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Folders. For example: \\\n \\\n`?project_ids[]=1234&project_ids[]=6789`" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "list_ids[]", + "tool_parameter_name": "filter_by_list_ids", + "description": "Filter by Lists. For example: \\\n \\\n`?list_ids[]=1234&list_ids[]=6789` ", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Lists. For example: \\\n \\\n`?list_ids[]=1234&list_ids[]=6789` " + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "statuses[]", + "tool_parameter_name": "status_filters", + "description": "Filter by statuses. Use `%20` to represent a space character. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by statuses. Use `%20` to represent a space character. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_closed", + "tool_parameter_name": "include_closed_tasks", + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "assignees[]", + "tool_parameter_name": "assignee_ids", + "description": "Filter by Assignees using people's ClickUp user id. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Assignees using people's ClickUp user id. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tags[]", + "tool_parameter_name": "filter_by_tags", + "description": "Filter by tags. User `%20` to represent a space character. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by tags. User `%20` to represent a space character. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date_gt", + "tool_parameter_name": "due_date_greater_than", + "description": "Filter by due date greater than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date greater than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date_lt", + "tool_parameter_name": "due_date_before", + "description": "Filter by due date less than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date less than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_created_gt", + "tool_parameter_name": "filter_created_date_after", + "description": "Filter by date created greater than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created greater than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_created_lt", + "tool_parameter_name": "filter_by_date_created_before", + "description": "Filter by date created less than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created less than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_updated_gt", + "tool_parameter_name": "filter_by_updated_date_greater_than", + "description": "Filter by date updated greater than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated greater than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_updated_lt", + "tool_parameter_name": "filter_by_update_date_before", + "description": "Filter by date updated less than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated less than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_done_gt", + "tool_parameter_name": "filter_by_date_done_after", + "description": "Filter by date done greater than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done greater than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_done_lt", + "tool_parameter_name": "filter_by_done_date_before", + "description": "Filter by date done less than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done less than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_fields", + "tool_parameter_name": "filter_by_custom_fields", + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"}{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. The `=` operator isn't supported with Label Custom Fields.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"}{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. The `=` operator isn't supported with Label Custom Fields.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "parent", + "tool_parameter_name": "parent_task_id", + "description": "Include the parent task ID to return subtasks.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the parent task ID to return subtasks." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_markdown_description", + "tool_parameter_name": "include_markdown_description", + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_items[]", + "tool_parameter_name": "custom_task_type_filters", + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace.", + "value_schema": { + "val_type": "array", + "inner_val_type": "number", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_Id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderCustomFields.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderCustomFields.json new file mode 100644 index 00000000..04108e77 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderCustomFields.json @@ -0,0 +1,138 @@ +{ + "name": "GetFolderCustomFields", + "fully_qualified_name": "ClickupApi.GetFolderCustomFields@0.1.0", + "description": "Retrieve accessible custom fields from a folder in ClickUp.\n\nThis tool retrieves the custom fields that are accessible at the folder level in ClickUp. It's useful when you need to know what folder-level custom fields are available for a specific folder. Custom fields created at the list level aren't included.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "folder_id", + "required": true, + "description": "The unique identifier of the folder to retrieve custom fields from. Must be an integer corresponding to a specific folder in ClickUp.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + }, + { + "name": "content_type", + "required": true, + "description": "The MIME type of the content being sent. Typically, use 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'getFolderAvailableFields'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/folder/{folder_id}/field", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "folder_id", + "tool_parameter_name": "folder_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderViews.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderViews.json new file mode 100644 index 00000000..a5350ee0 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderViews.json @@ -0,0 +1,105 @@ +{ + "name": "GetFolderViews", + "fully_qualified_name": "ClickupApi.GetFolderViews@0.1.0", + "description": "Retrieve available task and page views for a Folder in ClickUp.\n\n", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "folder_id", + "required": true, + "description": "The ID of the folder to retrieve views for. This should be an integer value.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetFolderViews'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/folder/{folder_id}/view", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "folder_id", + "tool_parameter_name": "folder_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderlessLists.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderlessLists.json new file mode 100644 index 00000000..927eda95 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetFolderlessLists.json @@ -0,0 +1,138 @@ +{ + "name": "GetFolderlessLists", + "fully_qualified_name": "ClickupApi.GetFolderlessLists@0.1.0", + "description": "View Lists in a Space not located in a Folder.\n\nUse this tool to retrieve lists within a specified space that are not contained within any folder, providing an organized view of unassigned lists.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_identifier", + "required": true, + "description": "The unique identifier of the space to retrieve the folderless lists from. It should be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "include_archived_lists", + "required": false, + "description": "Specify true to include archived lists, or false to exclude them.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "archived" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetFolderlessLists'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/list", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "archived", + "tool_parameter_name": "include_archived_lists", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "space_id", + "tool_parameter_name": "space_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetGoalDetails.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetGoalDetails.json new file mode 100644 index 00000000..33794307 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetGoalDetails.json @@ -0,0 +1,105 @@ +{ + "name": "GetGoalDetails", + "fully_qualified_name": "ClickupApi.GetGoalDetails@0.1.0", + "description": "Retrieve detailed information about a specific goal including its targets.\n\n", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "goal_identifier", + "required": true, + "description": "The unique identifier (UUID) for the goal to retrieve details and targets.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "goal_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetGoal'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/goal/{goal_id}", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "goal_id", + "tool_parameter_name": "goal_identifier", + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetGuestInformation.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetGuestInformation.json new file mode 100644 index 00000000..861b5b1d --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetGuestInformation.json @@ -0,0 +1,138 @@ +{ + "name": "GetGuestInformation", + "fully_qualified_name": "ClickupApi.GetGuestInformation@0.1.0", + "description": "Retrieve information about a guest in a workspace.\n\nThis tool is used to view details about a guest in a ClickUp workspace. It is available only for Workspaces on the Enterprise Plan. Use it when you need to obtain guest-related information, such as profile or access details.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the ClickUp workspace. This is required for identifying the specific workspace where the guest information is being retrieved.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "guest_identifier", + "required": true, + "description": "An integer representing the unique ID of the guest whose information is to be retrieved.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "guest_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetGuest'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/guest/{guest_id}", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "guest_id", + "tool_parameter_name": "guest_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetListComments.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetListComments.json new file mode 100644 index 00000000..5791a0f6 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetListComments.json @@ -0,0 +1,171 @@ +{ + "name": "GetListComments", + "fully_qualified_name": "ClickupApi.GetListComments@0.1.0", + "description": "View comments from a specific ClickUp list.\n\nUse this tool to retrieve the most recent comments from a specified ClickUp list. It returns up to 25 comments by default. To fetch older comments, utilize the optional parameters `start` and `start_id`.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "list_id", + "required": true, + "description": "The unique integer identifier of the ClickUp list for which comments are being retrieved.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "start_date_unix_millis", + "required": false, + "description": "Enter the date of a list info comment using Unix time in milliseconds to retrieve comments starting from this timestamp.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the `date` of a List info comment using Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "start" + }, + { + "name": "oldest_comment_id", + "required": false, + "description": "ID of the oldest comment to start retrieving additional comments from.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the Comment `id` of a List info comment." + }, + "inferrable": true, + "http_endpoint_parameter_name": "start_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetListComments'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/comment", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "start", + "tool_parameter_name": "start_date_unix_millis", + "description": "Enter the `date` of a List info comment using Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the `date` of a List info comment using Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "start_id", + "tool_parameter_name": "oldest_comment_id", + "description": "Enter the Comment `id` of a List info comment.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the Comment `id` of a List info comment." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "list_id", + "tool_parameter_name": "list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetListMembers.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetListMembers.json new file mode 100644 index 00000000..d278fefd --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetListMembers.json @@ -0,0 +1,105 @@ +{ + "name": "GetListMembers", + "fully_qualified_name": "ClickupApi.GetListMembers@0.1.0", + "description": "Retrieve members with access to a specific list in ClickUp.\n\nUse this tool to get the members of a ClickUp workspace who have access to a specified list. It helps in managing and viewing user access to project resources.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "list_id", + "required": true, + "description": "The unique identifier for the list in ClickUp. It is required to fetch the members with access to this list.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetListMembers'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/member", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetListTasks.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetListTasks.json new file mode 100644 index 00000000..ac001486 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetListTasks.json @@ -0,0 +1,864 @@ +{ + "name": "GetListTasks", + "fully_qualified_name": "ClickupApi.GetListTasks@0.1.0", + "description": "Retrieve tasks from a specific list in ClickUp.\n\nThis tool retrieves tasks from a specified list in ClickUp, limited to 100 tasks per page. It includes tasks where the specified list is their home, while also allowing inclusion of tasks from multiple lists by using the `include_timl` parameter. It provides details accessible to the user, including time spent on tasks with time entries.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "list_identifier", + "required": true, + "description": "The unique identifier for the list. Find it by copying the link and extracting the number following /li in the URL.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To find the list_id: \\ 1. In the Sidebar, hover over the List and click the **ellipsis ...** menu. \\ 2. Select **Copy link.** \\ 3. Use the copied URL to find the list_id. The list_id is the number that follows /li in the URL." + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "page_number_to_fetch", + "required": false, + "description": "Specify the page number to fetch tasks from, starting at 0.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Page to fetch (starts at 0)." + }, + "inferrable": true, + "http_endpoint_parameter_name": "page" + }, + { + "name": "order_by_field", + "required": false, + "description": "Specify the field to order tasks by. Options: 'id', 'created', 'updated', 'due_date'. Defaults to 'created'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "order_by" + }, + { + "name": "filter_by_statuses", + "required": false, + "description": "Filter tasks by their statuses. Use an array of status strings, such as ['to do', 'in progress'].", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by statuses. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`" + }, + "inferrable": true, + "http_endpoint_parameter_name": "statuses" + }, + { + "name": "filter_by_assignees", + "required": false, + "description": "Filter tasks by assignee IDs. Provide an array of assignee IDs to filter tasks assigned to specific users.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Assignees. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`" + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignees" + }, + { + "name": "filter_by_watchers", + "required": false, + "description": "An array of watcher IDs to filter tasks by watchers. Each ID should be a string.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by watchers." + }, + "inferrable": true, + "http_endpoint_parameter_name": "watchers" + }, + { + "name": "filter_by_tags", + "required": false, + "description": "Filter tasks by a list of tags. Provide an array of strings representing the tags to filter by.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by tags. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tags" + }, + { + "name": "filter_due_date_greater_than", + "required": false, + "description": "Filter tasks by a due date greater than the provided Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date greater than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date_gt" + }, + { + "name": "filter_due_date_before", + "required": false, + "description": "Filter tasks with due dates earlier than the specified Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date less than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date_lt" + }, + { + "name": "filter_date_created_after", + "required": false, + "description": "Filter tasks created after this Unix timestamp in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created greater than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_created_gt" + }, + { + "name": "date_created_less_than", + "required": false, + "description": "Filter tasks created before the specified Unix timestamp in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created less than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_created_lt" + }, + { + "name": "filter_date_updated_after", + "required": false, + "description": "Filter tasks updated after the specified Unix timestamp in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated greater than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_updated_gt" + }, + { + "name": "filter_date_updated_less_than", + "required": false, + "description": "Filter tasks updated before a specific date, using Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated less than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_updated_lt" + }, + { + "name": "filter_date_done_after", + "required": false, + "description": "Filter tasks completed after a specified date in Unix time (milliseconds).", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done greater than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_done_gt" + }, + { + "name": "filter_by_date_done_before", + "required": false, + "description": "Filter tasks completed before a specified Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done less than Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "date_done_lt" + }, + { + "name": "filter_by_custom_fields", + "required": false, + "description": "Include tasks with specific values in one or more Custom Fields. Use a JSON array of objects, where each object includes 'field_id', 'operator', and 'value'.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_fields" + }, + { + "name": "filter_by_custom_field", + "required": false, + "description": "Include tasks with specific values in one Custom Field. This can be a Custom Relationship. Provide an array of strings representing the field values.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_field" + }, + { + "name": "custom_task_type_filters", + "required": false, + "description": "An array of numbers to filter tasks by custom types. Use 0 for tasks, 1 for Milestones, and other numbers for custom types defined in your Workspace.", + "value_schema": { + "val_type": "array", + "inner_val_type": "number", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_items" + }, + { + "name": "include_archived_tasks", + "required": false, + "description": "Set to true to include archived tasks in the results. By default, archived tasks are excluded.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "archived" + }, + { + "name": "include_markdown_task_descriptions", + "required": false, + "description": "Set to true to return task descriptions in Markdown format.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_markdown_description" + }, + { + "name": "display_tasks_in_reverse_order", + "required": false, + "description": "Set to true to display tasks in reverse order.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Tasks are displayed in reverse order." + }, + "inferrable": true, + "http_endpoint_parameter_name": "reverse" + }, + { + "name": "include_subtasks", + "required": false, + "description": "Set to true to include subtasks; false to exclude them. Defaults to false.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or exclude subtasks. By default, subtasks are excluded." + }, + "inferrable": true, + "http_endpoint_parameter_name": "subtasks" + }, + { + "name": "include_closed_tasks", + "required": false, + "description": "Set to true to include closed tasks in the response. Defaults to false to exclude them.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_closed" + }, + { + "name": "include_tasks_in_multiple_lists", + "required": false, + "description": "Set to true to include tasks that exist in multiple lists. By default, these tasks are excluded.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include Tasks in Multiple Lists. By default, tasks that exist in multiple lists are excluded from the response.\\\n \\\nTo include tasks that exist in multiple lists, use `include_timl: true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_timl" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetTasks'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/task", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "archived", + "tool_parameter_name": "include_archived_tasks", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_markdown_description", + "tool_parameter_name": "include_markdown_task_descriptions", + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "page", + "tool_parameter_name": "page_number_to_fetch", + "description": "Page to fetch (starts at 0).", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Page to fetch (starts at 0)." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "order_by", + "tool_parameter_name": "order_by_field", + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "reverse", + "tool_parameter_name": "display_tasks_in_reverse_order", + "description": "Tasks are displayed in reverse order.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Tasks are displayed in reverse order." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "subtasks", + "tool_parameter_name": "include_subtasks", + "description": "Include or exclude subtasks. By default, subtasks are excluded.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or exclude subtasks. By default, subtasks are excluded." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "statuses", + "tool_parameter_name": "filter_by_statuses", + "description": "Filter by statuses. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by statuses. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_closed", + "tool_parameter_name": "include_closed_tasks", + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_timl", + "tool_parameter_name": "include_tasks_in_multiple_lists", + "description": "Include Tasks in Multiple Lists. By default, tasks that exist in multiple lists are excluded from the response.\\\n \\\nTo include tasks that exist in multiple lists, use `include_timl: true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include Tasks in Multiple Lists. By default, tasks that exist in multiple lists are excluded from the response.\\\n \\\nTo include tasks that exist in multiple lists, use `include_timl: true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "assignees", + "tool_parameter_name": "filter_by_assignees", + "description": "Filter by Assignees. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by Assignees. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "watchers", + "tool_parameter_name": "filter_by_watchers", + "description": "Filter by watchers.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by watchers." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tags", + "tool_parameter_name": "filter_by_tags", + "description": "Filter by tags. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by tags. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date_gt", + "tool_parameter_name": "filter_due_date_greater_than", + "description": "Filter by due date greater than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date greater than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date_lt", + "tool_parameter_name": "filter_due_date_before", + "description": "Filter by due date less than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by due date less than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_created_gt", + "tool_parameter_name": "filter_date_created_after", + "description": "Filter by date created greater than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created greater than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_created_lt", + "tool_parameter_name": "date_created_less_than", + "description": "Filter by date created less than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date created less than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_updated_gt", + "tool_parameter_name": "filter_date_updated_after", + "description": "Filter by date updated greater than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated greater than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_updated_lt", + "tool_parameter_name": "filter_date_updated_less_than", + "description": "Filter by date updated less than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date updated less than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_done_gt", + "tool_parameter_name": "filter_date_done_after", + "description": "Filter by date done greater than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done greater than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "date_done_lt", + "tool_parameter_name": "filter_by_date_done_before", + "description": "Filter by date done less than Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by date done less than Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_fields", + "tool_parameter_name": "filter_by_custom_fields", + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_field", + "tool_parameter_name": "filter_by_custom_field", + "description": "Include tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_items", + "tool_parameter_name": "custom_task_type_filters", + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace.", + "value_schema": { + "val_type": "array", + "inner_val_type": "number", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "list_id", + "tool_parameter_name": "list_identifier", + "description": "To find the list_id: \\ 1. In the Sidebar, hover over the List and click the **ellipsis ...** menu. \\ 2. Select **Copy link.** \\ 3. Use the copied URL to find the list_id. The list_id is the number that follows /li in the URL.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To find the list_id: \\ 1. In the Sidebar, hover over the List and click the **ellipsis ...** menu. \\ 2. Select **Copy link.** \\ 3. Use the copied URL to find the list_id. The list_id is the number that follows /li in the URL." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetListViews.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetListViews.json new file mode 100644 index 00000000..78a6ea36 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetListViews.json @@ -0,0 +1,105 @@ +{ + "name": "GetListViews", + "fully_qualified_name": "ClickupApi.GetListViews@0.1.0", + "description": "Retrieve available views for a specific list.\n\nUse this tool to view the task and page views available for a specific list in ClickUp. It retrieves both regular and required views.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "target_list_id", + "required": true, + "description": "The unique identifier for the list to retrieve views from. This should be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetListViews'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/view", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "target_list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceCustomFields.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceCustomFields.json new file mode 100644 index 00000000..e4e02e9b --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceCustomFields.json @@ -0,0 +1,138 @@ +{ + "name": "GetSpaceCustomFields", + "fully_qualified_name": "ClickupApi.GetSpaceCustomFields@0.1.0", + "description": "Retrieve custom fields accessible in a specific ClickUp space.\n\nThis tool retrieves the custom fields available to you in a specified ClickUp space. It returns only the custom fields created at the space level, excluding those at the folder and list levels.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_identifier", + "required": true, + "description": "The unique identifier for the ClickUp space from which to fetch available custom fields. It should be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "content_type_header", + "required": true, + "description": "The MIME type for the request header, typically 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'getSpaceAvailableFields'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/field", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "space_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceFolders.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceFolders.json new file mode 100644 index 00000000..b40c1cdb --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceFolders.json @@ -0,0 +1,138 @@ +{ + "name": "GetSpaceFolders", + "fully_qualified_name": "ClickupApi.GetSpaceFolders@0.1.0", + "description": "Retrieve a list of folders from a specified space.\n\nUse this tool to view folders within a specific space in ClickUp. It is useful when you need to access or manage the folders in a particular workspace.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_id", + "required": true, + "description": "The unique identifier of the space from which to retrieve folders. This is required to specify which space's folders are being requested.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "include_archived_folders", + "required": false, + "description": "Set to true to include archived folders in the results.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "archived" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetFolders'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/folder", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "archived", + "tool_parameter_name": "include_archived_folders", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "space_id", + "tool_parameter_name": "space_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceTags.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceTags.json new file mode 100644 index 00000000..9b89627a --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceTags.json @@ -0,0 +1,138 @@ +{ + "name": "GetSpaceTags", + "fully_qualified_name": "ClickupApi.GetSpaceTags@0.1.0", + "description": "Retrieve task tags for a specified space.\n\nUse this tool to view the task tags available within a specific space. It helps in identifying and managing tags associated with tasks.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_identifier", + "required": true, + "description": "An integer representing the ID of the space for which to retrieve task tags. This ID is required to specify the space.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "content_type_header", + "required": true, + "description": "The MIME type of the request. Generally set to 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetSpaceTags'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/tag", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "space_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceViews.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceViews.json new file mode 100644 index 00000000..ec16619d --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetSpaceViews.json @@ -0,0 +1,105 @@ +{ + "name": "GetSpaceViews", + "fully_qualified_name": "ClickupApi.GetSpaceViews@0.1.0", + "description": "Retrieve the task and page views for a specified Space.\n\nThis tool is used to obtain the task and page views available within a specific Space in ClickUp. It should be called when you need to explore or list the views associated with a given space by providing the space ID.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_identifier", + "required": true, + "description": "The unique integer ID of the space for which to retrieve task and page views.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetSpaceViews'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/view", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "space_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskComments.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskComments.json new file mode 100644 index 00000000..6d7cb55f --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskComments.json @@ -0,0 +1,237 @@ +{ + "name": "GetTaskComments", + "fully_qualified_name": "ClickupApi.GetTaskComments@0.1.0", + "description": "Retrieve comments from a specified task in ClickUp.\n\nUse this tool to view comments on a specific task within ClickUp. If no 'start' and 'start_id' parameters are provided, it will return the latest 25 comments. Provide 'start' and 'start_id' to paginate through older comments.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_identifier", + "required": true, + "description": "Specify the unique identifier of the task whose comments you want to retrieve.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "workspace_id_for_custom_task", + "required": false, + "description": "Provide the Workspace ID when using a custom task ID (requires `custom_task_ids` to be true).", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "comment_date_unix_time_ms", + "required": false, + "description": "Specify the date of a task comment using Unix time in milliseconds for pagination.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the `date` of a task comment using Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "start" + }, + { + "name": "comment_start_id", + "required": false, + "description": "The ID of the earliest comment to start retrieving from, used for pagination.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the Comment `id` of a task comment." + }, + "inferrable": true, + "http_endpoint_parameter_name": "start_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to `true` if you want to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetTaskComments'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/comment", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_for_custom_task", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "start", + "tool_parameter_name": "comment_date_unix_time_ms", + "description": "Enter the `date` of a task comment using Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the `date` of a task comment using Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "start_id", + "tool_parameter_name": "comment_start_id", + "description": "Enter the Comment `id` of a task comment.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the Comment `id` of a task comment." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskMembers.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskMembers.json new file mode 100644 index 00000000..a3df955a --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskMembers.json @@ -0,0 +1,105 @@ +{ + "name": "GetTaskMembers", + "fully_qualified_name": "ClickupApi.GetTaskMembers@0.1.0", + "description": "Retrieve members with direct access to a task.\n\nUse this tool to view the people who have direct access to a specific task in ClickUp. It does not include members with inherited permissions through the hierarchy.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_identifier", + "required": true, + "description": "The unique identifier of the task to retrieve members for. This ID is necessary to specify the task in question.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetTaskMembers'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/member", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskTimeInStatus.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskTimeInStatus.json new file mode 100644 index 00000000..f683d852 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTaskTimeInStatus.json @@ -0,0 +1,204 @@ +{ + "name": "GetTaskTimeInStatus", + "fully_qualified_name": "ClickupApi.GetTaskTimeInStatus@0.1.0", + "description": "Retrieve duration of tasks in various statuses.\n\nUse this tool to find out how long multiple tasks have remained in each status. The Total Time in Status ClickApp must be enabled by the Workspace owner or an admin.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_ids_list", + "required": true, + "description": "A list of up to 100 task IDs to check duration in status. Include each task ID separated by commas.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include this paramater once per `task_id`.\nYou can include up to 100 task ids per request.\nFor example: `task_ids=3cuh&task_ids=g4fs`" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_ids" + }, + { + "name": "content_type_header", + "required": true, + "description": "The MIME type of the body of the request. Typically set to 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + }, + { + "name": "workspace_id_for_custom_task_ids", + "required": false, + "description": "Provide the Workspace ID if using custom task IDs. Required when `custom_task_ids` is `true`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference tasks by custom task IDs.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetBulkTasks'TimeinStatus'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/bulk_time_in_status/task_ids", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "task_ids", + "tool_parameter_name": "task_ids_list", + "description": "Include this paramater once per `task_id`.\nYou can include up to 100 task ids per request.\nFor example: `task_ids=3cuh&task_ids=g4fs`", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include this paramater once per `task_id`.\nYou can include up to 100 task ids per request.\nFor example: `task_ids=3cuh&task_ids=g4fs`" + }, + "accepted_as": "query", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_for_custom_task_ids", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetTeamViews.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTeamViews.json new file mode 100644 index 00000000..30547a4b --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTeamViews.json @@ -0,0 +1,105 @@ +{ + "name": "GetTeamViews", + "fully_qualified_name": "ClickupApi.GetTeamViews@0.1.0", + "description": "Retrieve task and page views at the workspace level.\n\nUse this tool to view the task and page views available at the Everything Level of a specified workspace in ClickUp.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace to retrieve task and page views from in ClickUp.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetTeamViews'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/view", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetTimeEntriesInDateRange.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTimeEntriesInDateRange.json new file mode 100644 index 00000000..3e81981a --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTimeEntriesInDateRange.json @@ -0,0 +1,600 @@ +{ + "name": "GetTimeEntriesInDateRange", + "fully_qualified_name": "ClickupApi.GetTimeEntriesInDateRange@0.1.0", + "description": "Retrieve time entries within a specified date range.\n\nUse this tool to view time entries filtered by start and end dates. By default, it returns entries from the last 30 days for the authenticated user. To access entries for other users, use the 'assignee' parameter. You may apply location filters with 'space_id', 'folder_id', 'list_id', or 'task_id', but only one at a time. Note: Negative duration entries indicate a running timer.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "Specify the Workspace ID for filtering time entries when using custom task IDs.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_Id" + }, + { + "name": "content_type", + "required": true, + "description": "Specifies the format of the response content. Usually set to 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + }, + { + "name": "start_date_in_unix_milliseconds", + "required": false, + "description": "The start date of the time entries in Unix time (milliseconds).", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Unix time in milliseconds" + }, + "inferrable": true, + "http_endpoint_parameter_name": "start_date" + }, + { + "name": "end_date_unix_milliseconds", + "required": false, + "description": "Specify the end date in Unix time (milliseconds) to filter time entries up to this point.", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Unix time in milliseconds" + }, + "inferrable": true, + "http_endpoint_parameter_name": "end_date" + }, + { + "name": "filter_by_assignee", + "required": false, + "description": "Filter by user IDs. Use commas to separate multiple IDs (e.g., '1234,9876'). Only accessible to Workspace Owners/Admins.", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by `user_id`. For multiple assignees, separate `user_id` using commas.\\\n \\\n **Example:** `assignee=1234,9876`\\\n \\\n***Note:** Only Workspace Owners/Admins have access to do this.*" + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignee" + }, + { + "name": "space_id", + "required": false, + "description": "Include time entries associated only with tasks in the specified Space using its ID.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with tasks in a specific Space." + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "folder_id", + "required": false, + "description": "Include time entries for tasks in a specific folder by providing its ID. Only one location filter (space, folder, list, or task) can be used at a time.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with tasks in a specific Folder." + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + }, + { + "name": "specific_list_id", + "required": false, + "description": "Include only time entries associated with tasks in a specified List by providing the List ID.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with tasks in a specific List." + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "specific_task_id", + "required": false, + "description": "Include only time entries associated with the specified task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with a specific task." + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "workspace_id_for_custom_task_ids", + "required": false, + "description": "Provide the Workspace ID when referencing a task by its custom task ID, and `custom_task_ids` is set to true.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "include_task_tags", + "required": false, + "description": "Set to true to include task tags in the response for associated time entries.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include task tags in the response for time entries associated with tasks." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_task_tags" + }, + { + "name": "include_location_names", + "required": false, + "description": "Include the names of the List, Folder, and Space in the response along with their IDs when set to true.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the names of the List, Folder, and Space along with the `list_id`,`folder_id`, and `space_id`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_location_names" + }, + { + "name": "include_approval_history", + "required": false, + "description": "Set to true to include the approval history for each time entry, with status changes, notes, and approvers.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the history of the approval for each time entry. Adds status changes, notes, and approvers." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_approval_history" + }, + { + "name": "include_approval_details", + "required": false, + "description": "Include detailed approval information for each time entry, such as Approver ID, Approved Time, List of Approvers, and Approval Status.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the details of the approval for each time entry. Adds Approver ID, Approved Time, List of Approvers, and Approval Status." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_approval_details" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference tasks by their custom task IDs. Requires specifying the team_id.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + }, + { + "name": "include_only_billable_entries", + "required": false, + "description": "Set to `true` to include only billable time entries, or `false` for non-billable entries.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include only billable time entries by using a value of `true` or only non-billable time entries by using a value of `false`.\\\n \\\nFor example: `?is_billable=true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "is_billable" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Gettimeentrieswithinadaterange'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_Id}/time_entries", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "start_date", + "tool_parameter_name": "start_date_in_unix_milliseconds", + "description": "Unix time in milliseconds", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Unix time in milliseconds" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "end_date", + "tool_parameter_name": "end_date_unix_milliseconds", + "description": "Unix time in milliseconds", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Unix time in milliseconds" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "assignee", + "tool_parameter_name": "filter_by_assignee", + "description": "Filter by `user_id`. For multiple assignees, separate `user_id` using commas.\\\n \\\n **Example:** `assignee=1234,9876`\\\n \\\n***Note:** Only Workspace Owners/Admins have access to do this.*", + "value_schema": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Filter by `user_id`. For multiple assignees, separate `user_id` using commas.\\\n \\\n **Example:** `assignee=1234,9876`\\\n \\\n***Note:** Only Workspace Owners/Admins have access to do this.*" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_task_tags", + "tool_parameter_name": "include_task_tags", + "description": "Include task tags in the response for time entries associated with tasks.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include task tags in the response for time entries associated with tasks." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_location_names", + "tool_parameter_name": "include_location_names", + "description": "Include the names of the List, Folder, and Space along with the `list_id`,`folder_id`, and `space_id`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the names of the List, Folder, and Space along with the `list_id`,`folder_id`, and `space_id`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_approval_history", + "tool_parameter_name": "include_approval_history", + "description": "Include the history of the approval for each time entry. Adds status changes, notes, and approvers.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the history of the approval for each time entry. Adds status changes, notes, and approvers." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_approval_details", + "tool_parameter_name": "include_approval_details", + "description": "Include the details of the approval for each time entry. Adds Approver ID, Approved Time, List of Approvers, and Approval Status.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the details of the approval for each time entry. Adds Approver ID, Approved Time, List of Approvers, and Approval Status." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "space_id", + "tool_parameter_name": "space_id", + "description": "Only include time entries associated with tasks in a specific Space.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with tasks in a specific Space." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "folder_id", + "tool_parameter_name": "folder_id", + "description": "Only include time entries associated with tasks in a specific Folder.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with tasks in a specific Folder." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "list_id", + "tool_parameter_name": "specific_list_id", + "description": "Only include time entries associated with tasks in a specific List.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with tasks in a specific List." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "specific_task_id", + "description": "Only include time entries associated with a specific task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Only include time entries associated with a specific task." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_for_custom_task_ids", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "is_billable", + "tool_parameter_name": "include_only_billable_entries", + "description": "Include only billable time entries by using a value of `true` or only non-billable time entries by using a value of `false`.\\\n \\\nFor example: `?is_billable=true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include only billable time entries by using a value of `true` or only non-billable time entries by using a value of `false`.\\\n \\\nFor example: `?is_billable=true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_Id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetTimeEntryTags.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTimeEntryTags.json new file mode 100644 index 00000000..8e2343a4 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTimeEntryTags.json @@ -0,0 +1,138 @@ +{ + "name": "GetTimeEntryTags", + "fully_qualified_name": "ClickupApi.GetTimeEntryTags@0.1.0", + "description": "Retrieve all tags from time entries in a workspace.\n\nUse this tool to view all labels that have been applied to time entries within a specified workspace.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique ID of the workspace to retrieve tags from.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "content_type_header", + "required": true, + "description": "The media type of the resource, usually set to 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Getalltagsfromtimeentries'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/time_entries/tags", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetTrackedTimeForTask.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTrackedTimeForTask.json new file mode 100644 index 00000000..2577c27a --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetTrackedTimeForTask.json @@ -0,0 +1,204 @@ +{ + "name": "GetTrackedTimeForTask", + "fully_qualified_name": "ClickupApi.GetTrackedTimeForTask@0.1.0", + "description": "Fetch tracked time for a specific task.\n\nUse this tool to get the tracked time recorded for a specific task in ClickUp. It's useful for retrieving time spent details on tasks, though it doesn't handle new time entries.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_id", + "required": true, + "description": "The unique identifier for the task whose tracked time you want to retrieve.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "set_content_type_header", + "required": true, + "description": "Set the Content-Type header for the request, typically as 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + }, + { + "name": "workspace_id", + "required": false, + "description": "The ID of the Workspace to be provided when referencing a task by its custom task ID. Required if `custom_task_ids` is `true`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference tasks by their custom task IDs instead of default IDs.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Gettrackedtime'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/time", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "set_content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetUserGroupsInWorkspace.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetUserGroupsInWorkspace.json new file mode 100644 index 00000000..ccaccbb0 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetUserGroupsInWorkspace.json @@ -0,0 +1,138 @@ +{ + "name": "GetUserGroupsInWorkspace", + "fully_qualified_name": "ClickupApi.GetUserGroupsInWorkspace@0.1.0", + "description": "Retrieve user groups in a ClickUp workspace.\n\nUse this tool to view the user groups within a specific ClickUp workspace. It's useful for managing and organizing user permissions and roles within a team environment.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the ClickUp workspace to retrieve user groups from.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "user_group_ids", + "required": false, + "description": "List one or more User Group IDs to retrieve details about specific user groups in the workspace.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter one or more User Group IDs to retrieve information about specific User Group." + }, + "inferrable": true, + "http_endpoint_parameter_name": "group_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetTeams1'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/group", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "query", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "group_ids", + "tool_parameter_name": "user_group_ids", + "description": "Enter one or more User Group IDs to retrieve information about specific User Group.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter one or more User Group IDs to retrieve information about specific User Group." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetVisibleTasksInView.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetVisibleTasksInView.json new file mode 100644 index 00000000..f82de8a9 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetVisibleTasksInView.json @@ -0,0 +1,138 @@ +{ + "name": "GetVisibleTasksInView", + "fully_qualified_name": "ClickupApi.GetVisibleTasksInView@0.1.0", + "description": "Retrieve all visible tasks from a ClickUp view.\n\nUse this tool to obtain a list of all tasks that are visible in a specific view within ClickUp. It is useful for task management and organization within the platform.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "pagination_page_number", + "required": true, + "description": "The specific page number of tasks to retrieve. Used for pagination in task lists, starting at 1.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "page" + }, + { + "name": "view_identifier", + "required": true, + "description": "The ID of the ClickUp view from which to retrieve visible tasks. Must be a string.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "view_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetViewTasks'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/view/{view_id}/task", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "page", + "tool_parameter_name": "pagination_page_number", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "query", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "view_id", + "tool_parameter_name": "view_identifier", + "description": "105 (string)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceCustomRoles.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceCustomRoles.json new file mode 100644 index 00000000..dd331e79 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceCustomRoles.json @@ -0,0 +1,138 @@ +{ + "name": "GetWorkspaceCustomRoles", + "fully_qualified_name": "ClickupApi.GetWorkspaceCustomRoles@0.1.0", + "description": "Retrieve custom roles from a specific workspace.\n\nThis tool is used to retrieve the custom roles available in a specified workspace on ClickUp. It should be called when you need to view or manage roles in a ClickUp workspace.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique identifier for the workspace to retrieve custom roles from.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "include_members", + "required": false, + "description": "Include member details in the response. Set to true to include, false to exclude.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_members" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetCustomRoles'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/customroles", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "include_members", + "tool_parameter_name": "include_members", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceCustomTaskTypes.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceCustomTaskTypes.json new file mode 100644 index 00000000..4e6f49b9 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceCustomTaskTypes.json @@ -0,0 +1,105 @@ +{ + "name": "GetWorkspaceCustomTaskTypes", + "fully_qualified_name": "ClickupApi.GetWorkspaceCustomTaskTypes@0.1.0", + "description": "Retrieve custom task types for a specific workspace.\n\nUse this tool to view the custom task types available in a specified workspace. Ideal for gaining insight into workspace-specific configurations and custom workflows.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the Workspace to retrieve custom task types for.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetCustomItems'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/custom_item", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspacePlan.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspacePlan.json new file mode 100644 index 00000000..19b058f8 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspacePlan.json @@ -0,0 +1,105 @@ +{ + "name": "GetWorkspacePlan", + "fully_qualified_name": "ClickupApi.GetWorkspacePlan@0.1.0", + "description": "Retrieve the current subscription plan for a workspace.\n\nUse this tool to get details about the current subscription plan for a specified workspace in ClickUp. It should be called when you need to view the plan or pricing details associated with a workspace.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique ID for the workspace whose subscription plan you want to retrieve.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetWorkspaceplan'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/plan", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceSeatDetails.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceSeatDetails.json new file mode 100644 index 00000000..447eacef --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceSeatDetails.json @@ -0,0 +1,105 @@ +{ + "name": "GetWorkspaceSeatDetails", + "fully_qualified_name": "ClickupApi.GetWorkspaceSeatDetails@0.1.0", + "description": "Retrieve seat details for a workspace.\n\nUse this tool to view the used, total, and available member and guest seats for a specified workspace in ClickUp.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique ID of the workspace for which seat details are to be retrieved.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetWorkspaceseats'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/seats", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceSpaces.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceSpaces.json new file mode 100644 index 00000000..9b57288e --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceSpaces.json @@ -0,0 +1,105 @@ +{ + "name": "GetWorkspaceSpaces", + "fully_qualified_name": "ClickupApi.GetWorkspaceSpaces@0.1.0", + "description": "Retrieve available Spaces in a Workspace.\n\nUse this tool to get information about the Spaces available in a specific Workspace identified by its space ID.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_space_id", + "required": true, + "description": "The unique identifier for the specific space in the workspace to retrieve details.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetSpace'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "workspace_space_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceUserInfo.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceUserInfo.json new file mode 100644 index 00000000..2bd61427 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceUserInfo.json @@ -0,0 +1,171 @@ +{ + "name": "GetWorkspaceUserInfo", + "fully_qualified_name": "ClickupApi.GetWorkspaceUserInfo@0.1.0", + "description": "Retrieve user information from a specified workspace.\n\nCall this tool to get details about a user from a specific workspace on the ClickUp platform. This tool is applicable only to Workspaces that are on the Enterprise Plan.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique ID of the Workspace. Used to specify which Workspace's user information is to be retrieved.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "user_id", + "required": true, + "description": "The unique identifier of the user to retrieve information for. This is required to specify which user's information is being accessed in the workspace.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "user_id" + }, + { + "name": "show_shared_items", + "required": false, + "description": "Set to `true` to include details of shared items; `false` excludes them by default.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_shared" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetUser'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/user/{user_id}", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "include_shared", + "tool_parameter_name": "show_shared_items", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "user_id", + "tool_parameter_name": "user_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceWebhooks.json b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceWebhooks.json new file mode 100644 index 00000000..336f5fb1 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/GetWorkspaceWebhooks.json @@ -0,0 +1,105 @@ +{ + "name": "GetWorkspaceWebhooks", + "fully_qualified_name": "ClickupApi.GetWorkspaceWebhooks@0.1.0", + "description": "Retrieve webhooks for a workspace.\n\nUse this tool to view the webhooks created via the API for a specific Workspace. It returns webhooks created by the authenticated user.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the Workspace to retrieve the webhooks for.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetWebhooks'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/webhook", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/InviteGuestToWorkspace.json b/toolkits/clickup_api/clickup_api/wrapper_tools/InviteGuestToWorkspace.json new file mode 100644 index 00000000..7d553c28 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/InviteGuestToWorkspace.json @@ -0,0 +1,336 @@ +{ + "name": "InviteGuestToWorkspace", + "fully_qualified_name": "ClickupApi.InviteGuestToWorkspace@0.1.0", + "description": "Invite a guest to join a ClickUp workspace.\n\nThis tool is used to invite a guest to a ClickUp workspace on an Enterprise Plan. Ensure the guest has access to specific items in the workspace using additional endpoints.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The integer ID of the Workspace to which the guest will be invited.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "guest_email", + "required": true, + "description": "The email address of the guest to be invited to the workspace. Ensure it is correctly formatted.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "email" + }, + { + "name": "custom_role_id", + "required": false, + "description": "The ID of the custom role to assign to the guest. Must be an integer value.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_role_id" + }, + { + "name": "allow_tag_editing", + "required": false, + "description": "Set to true if the guest should be allowed to edit tags in the workspace.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "can_edit_tags" + }, + { + "name": "allow_view_time_spent", + "required": false, + "description": "Allow the guest to view time spent in the workspace. Accepts a boolean value: true to allow, false to deny.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "can_see_time_spent" + }, + { + "name": "can_view_estimated_times", + "required": false, + "description": "Set to true to allow the guest to view estimated times for tasks.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "can_see_time_estimated" + }, + { + "name": "allow_guest_to_create_views", + "required": false, + "description": "Indicates if the guest can create views in the workspace. Accepts a boolean value.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "can_create_views" + }, + { + "name": "can_view_points_estimated", + "required": false, + "description": "Set to true to allow the guest to view estimated points for tasks.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "can_see_points_estimated" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'InviteGuestToWorkspace'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/guest", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "email", + "tool_parameter_name": "guest_email", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "can_edit_tags", + "tool_parameter_name": "allow_tag_editing", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "can_see_time_spent", + "tool_parameter_name": "allow_view_time_spent", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "can_see_time_estimated", + "tool_parameter_name": "can_view_estimated_times", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "can_create_views", + "tool_parameter_name": "allow_guest_to_create_views", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "can_see_points_estimated", + "tool_parameter_name": "can_view_points_estimated", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_role_id", + "tool_parameter_name": "custom_role_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"InviteGuestToWorkspacerequest\",\n \"required\": [\n \"email\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"email\": {\n \"type\": \"string\"\n },\n \"can_edit_tags\": {\n \"type\": \"boolean\"\n },\n \"can_see_time_spent\": {\n \"type\": \"boolean\"\n },\n \"can_see_time_estimated\": {\n \"type\": \"boolean\"\n },\n \"can_create_views\": {\n \"type\": \"boolean\"\n },\n \"can_see_points_estimated\": {\n \"type\": \"boolean\"\n },\n \"custom_role_id\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"email\": \"guest@example.com\",\n \"can_edit_tags\": true,\n \"can_see_time_spent\": true,\n \"can_see_time_estimated\": true,\n \"can_create_views\": true,\n \"can_see_points_estimated\": true,\n \"custom_role_id\": 12345\n }\n ]\n },\n \"example\": {\n \"email\": \"guest@example.com\",\n \"can_edit_tags\": true,\n \"can_see_time_spent\": true,\n \"can_see_time_estimated\": true,\n \"can_create_views\": true,\n \"custom_role_id\": 12345\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/InviteUserToWorkspace.json b/toolkits/clickup_api/clickup_api/wrapper_tools/InviteUserToWorkspace.json new file mode 100644 index 00000000..ff46d8f6 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/InviteUserToWorkspace.json @@ -0,0 +1,204 @@ +{ + "name": "InviteUserToWorkspace", + "fully_qualified_name": "ClickupApi.InviteUserToWorkspace@0.1.0", + "description": "Invite a user to your ClickUp Workspace as a member.\n\nUse this tool to invite someone to your ClickUp Workspace as a member. This is suitable for Workspaces on the Enterprise Plan. For inviting guests, use the appropriate tool instead.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique ID of the workspace to which the user is being invited.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "user_email", + "required": true, + "description": "The email address of the user to be invited to the Workspace. Must be a valid email format.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "email" + }, + { + "name": "invite_as_admin", + "required": true, + "description": "Indicate if the user should be invited as an admin. True for admin, False for regular member.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "admin" + }, + { + "name": "custom_role_id", + "required": false, + "description": "The ID of the custom role to assign to the user in the Workspace. Must be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_role_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'InviteUserToWorkspace'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/user", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "email", + "tool_parameter_name": "user_email", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "admin", + "tool_parameter_name": "invite_as_admin", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_role_id", + "tool_parameter_name": "custom_role_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"InviteUserToWorkspacerequest\",\n \"required\": [\n \"email\",\n \"admin\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"email\": {\n \"type\": \"string\"\n },\n \"admin\": {\n \"type\": \"boolean\"\n },\n \"custom_role_id\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"email\": \"user@example.com\",\n \"admin\": true,\n \"custom_role_id\": 112233\n }\n ]\n },\n \"example\": {\n \"email\": \"user@example.com\",\n \"admin\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/LinkTasksClickup.json b/toolkits/clickup_api/clickup_api/wrapper_tools/LinkTasksClickup.json new file mode 100644 index 00000000..8f98e34c --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/LinkTasksClickup.json @@ -0,0 +1,204 @@ +{ + "name": "LinkTasksClickup", + "fully_qualified_name": "ClickupApi.LinkTasksClickup@0.1.0", + "description": "Link two ClickUp tasks together.\n\nThis tool allows you to link two tasks in ClickUp via the Task Links feature in the right-hand sidebar of a task. It should be called when you need to associate tasks directly, but does not support linking to other types of objects.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "source_task_id", + "required": true, + "description": "The ID of the task from which the link will be initiated.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The task to initiate the link from." + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "task_to_link_to", + "required": true, + "description": "The ID of the task to link to the initiating task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The task to link to." + }, + "inferrable": true, + "http_endpoint_parameter_name": "links_to" + }, + { + "name": "workspace_id_for_custom_task", + "required": false, + "description": "Provide the Workspace ID if referencing a task by custom task id (when custom_task_ids is true).", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'AddTaskLink'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/link/{links_to}", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_for_custom_task", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "source_task_id", + "description": "The task to initiate the link from.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The task to initiate the link from." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "links_to", + "tool_parameter_name": "task_to_link_to", + "description": "The task to link to.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The task to link to." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/MergeTasksInClickup.json b/toolkits/clickup_api/clickup_api/wrapper_tools/MergeTasksInClickup.json new file mode 100644 index 00000000..d7c85bdd --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/MergeTasksInClickup.json @@ -0,0 +1,138 @@ +{ + "name": "MergeTasksInClickup", + "fully_qualified_name": "ClickupApi.MergeTasksInClickup@0.1.0", + "description": "Merge multiple tasks into a target task in ClickUp.\n\nUse this tool to merge several tasks into a specified target task within ClickUp. The target task is identified by the task_id, with source tasks provided in the request. This is useful when consolidating tasks for better project management.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "target_task_id", + "required": true, + "description": "ID of the target task into which other tasks will be merged.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the target task that other tasks will be merged into." + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "source_task_ids_to_merge", + "required": true, + "description": "Array of task IDs to merge into the target task in ClickUp.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of task IDs to merge into the target task." + }, + "inferrable": true, + "http_endpoint_parameter_name": "source_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'mergeTasks'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/merge", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "task_id", + "tool_parameter_name": "target_task_id", + "description": "ID of the target task that other tasks will be merged into.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "ID of the target task that other tasks will be merged into." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "source_task_ids", + "tool_parameter_name": "source_task_ids_to_merge", + "description": "Array of task IDs to merge into the target task.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of task IDs to merge into the target task." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"source_task_ids\"\n ],\n \"properties\": {\n \"source_task_ids\": {\n \"type\": \"array\",\n \"description\": \"Array of task IDs to merge into the target task.\",\n \"items\": {\n \"type\": \"string\"\n },\n \"examples\": [\n [\n \"abc123\",\n \"def456\"\n ]\n ]\n }\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveCustomFieldValue.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveCustomFieldValue.json new file mode 100644 index 00000000..55e5e91b --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveCustomFieldValue.json @@ -0,0 +1,204 @@ +{ + "name": "RemoveCustomFieldValue", + "fully_qualified_name": "ClickupApi.RemoveCustomFieldValue@0.1.0", + "description": "Remove a custom field value from a ClickUp task.\n\nUse this tool to remove the data from a custom field on a ClickUp task without deleting the field option itself.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_identifier", + "required": true, + "description": "The unique identifier of the task from which you want to remove the custom field value.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "custom_field_id", + "required": true, + "description": "UUID of the custom field to be removed from the task. Example: b8a8-48d8-a0c6-b4200788a683", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "field_id" + }, + { + "name": "workspace_id", + "required": false, + "description": "Provide the Workspace ID when referencing a task by custom task id.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'RemoveCustomFieldValue'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/field/{field_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "field_id", + "tool_parameter_name": "custom_field_id", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromFolder.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromFolder.json new file mode 100644 index 00000000..f6560575 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromFolder.json @@ -0,0 +1,171 @@ +{ + "name": "RemoveGuestFromFolder", + "fully_qualified_name": "ClickupApi.RemoveGuestFromFolder@0.1.0", + "description": "Revoke a guest's access to a specified folder.\n\nUse this tool to remove a guest's access to a specific folder in ClickUp workspaces on the Enterprise Plan.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "folder_identifier", + "required": true, + "description": "The unique identifier for the folder from which the guest's access should be revoked. This ID is essential to specify the exact folder within the ClickUp workspace.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + }, + { + "name": "guest_identifier", + "required": true, + "description": "The unique numeric ID of the guest to be removed from the folder. This is required to identify which guest's access is being revoked.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "guest_id" + }, + { + "name": "include_shared_items", + "required": false, + "description": "Set to true to include details of items shared with the guest. Defaults to true.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_shared" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'RemoveGuestFromFolder'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/folder/{folder_id}/guest/{guest_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "include_shared", + "tool_parameter_name": "include_shared_items", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "folder_id", + "tool_parameter_name": "folder_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "guest_id", + "tool_parameter_name": "guest_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromList.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromList.json new file mode 100644 index 00000000..8714362d --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromList.json @@ -0,0 +1,171 @@ +{ + "name": "RemoveGuestFromList", + "fully_qualified_name": "ClickupApi.RemoveGuestFromList@0.1.0", + "description": "Revoke a guest's access to a specific list in ClickUp.\n\nThis tool removes a guest's access from a specified list within ClickUp. It is available only for Workspaces on the Enterprise Plan.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "list_identifier", + "required": true, + "description": "The unique identifier for the list from which the guest's access will be revoked. This must be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "guest_user_id", + "required": true, + "description": "The unique identifier of the guest whose access is to be revoked from the list.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "guest_id" + }, + { + "name": "include_shared_details", + "required": false, + "description": "Set to `true` to include details of items shared with the guest. Default is `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_shared" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'RemoveGuestFromList'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/guest/{guest_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "include_shared", + "tool_parameter_name": "include_shared_details", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "list_id", + "tool_parameter_name": "list_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "guest_id", + "tool_parameter_name": "guest_user_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromTask.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromTask.json new file mode 100644 index 00000000..b564b1a5 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromTask.json @@ -0,0 +1,237 @@ +{ + "name": "RemoveGuestFromTask", + "fully_qualified_name": "ClickupApi.RemoveGuestFromTask@0.1.0", + "description": "Revoke a guest's access to a specific task in ClickUp.\n\nUse this tool to remove a guest from a task in ClickUp. This action is available only for Workspaces on the Enterprise Plan.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_id", + "required": true, + "description": "The unique identifier of the task from which the guest's access should be revoked. This is required to specify the task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "guest_id", + "required": true, + "description": "The ID of the guest to remove from the task. This is a required integer value.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "guest_id" + }, + { + "name": "workspace_id_for_custom_task", + "required": false, + "description": "Provide the Workspace ID when referencing a task by its custom task ID. This is required if 'custom_task_ids' is set to 'true'.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "include_shared_details", + "required": false, + "description": "Set to `true` to include details of items shared with the guest. Default is `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_shared" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'RemoveGuestFromTask'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/guest/{guest_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "include_shared", + "tool_parameter_name": "include_shared_details", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_for_custom_task", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "guest_id", + "tool_parameter_name": "guest_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromWorkspace.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromWorkspace.json new file mode 100644 index 00000000..a5b96e41 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveGuestFromWorkspace.json @@ -0,0 +1,138 @@ +{ + "name": "RemoveGuestFromWorkspace", + "fully_qualified_name": "ClickupApi.RemoveGuestFromWorkspace@0.1.0", + "description": "Revoke a guest's access to a ClickUp workspace.\n\nRemove a guest from a ClickUp workspace. Available only for Workspaces on the Enterprise Plan.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique ID of the ClickUp workspace from which the guest will be removed. This is an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "guest_id", + "required": true, + "description": "The unique identifier for the guest to be removed from the workspace. This should be an integer value.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "guest_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'RemoveGuestFromWorkspace'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/guest/{guest_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "guest_id", + "tool_parameter_name": "guest_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTagFromTask.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTagFromTask.json new file mode 100644 index 00000000..855f9fc2 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTagFromTask.json @@ -0,0 +1,237 @@ +{ + "name": "RemoveTagFromTask", + "fully_qualified_name": "ClickupApi.RemoveTagFromTask@0.1.0", + "description": "Remove a tag from a specific task in ClickUp.\n\nUse this tool to remove a specified tag from a task in ClickUp without deleting the tag from the space.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_id", + "required": true, + "description": "The unique identifier of the task from which the tag will be removed. Use the task's regular ID unless custom task IDs are enabled.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "tag_name_to_remove", + "required": true, + "description": "The name of the tag to remove from the specified task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag_name" + }, + { + "name": "content_type_header", + "required": true, + "description": "Specifies the media type of the request. Commonly set to 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + }, + { + "name": "workspace_id_for_custom_task", + "required": false, + "description": "The Workspace ID required when referencing a task by its custom ID (if custom_task_ids is true).", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID, or false to use the standard ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'RemoveTagFromTask'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/tag/{tag_name}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_for_custom_task", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag_name", + "tool_parameter_name": "tag_name_to_remove", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTagsFromTimeEntries.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTagsFromTimeEntries.json new file mode 100644 index 00000000..0596fe8c --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTagsFromTimeEntries.json @@ -0,0 +1,172 @@ +{ + "name": "RemoveTagsFromTimeEntries", + "fully_qualified_name": "ClickupApi.RemoveTagsFromTimeEntries@0.1.0", + "description": "Remove labels from specific time entries.\n\nUse this tool to remove labels from time entries without affecting the labels in the Workspace.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique ID of the Workspace from which to remove labels from time entries. Must be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "time_entry_tags_payload", + "required": true, + "description": "A JSON object containing the IDs of the time entries and the tags to be removed. The object should have two fields: `time_entry_ids` (an array of strings for the IDs) and `tags` (an array of objects for tags to be removed).", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "time_entry_ids": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Removetagsfromtimeentries'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/time_entries/tags", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "time_entry_tags_payload", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "time_entry_ids": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Removetagsfromtimeentriesrequest\",\n \"required\": [\n \"time_entry_ids\",\n \"tags\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"time_entry_ids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"\"\n },\n \"tags\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries~1start/post/requestBody/content/application~1json/schema/properties/tags/items\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries~1start/post/requestBody/content/application~1json/schema/properties/tags/items\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"time_entry_ids\": [\n \"timer_id\"\n ],\n \"tags\": [\n {\n \"name\": \"name of tag\"\n }\n ]\n }\n ]\n },\n \"example\": {\n \"time_entry_ids\": [\n \"timer_id\"\n ],\n \"tags\": [\n {\n \"name\": \"name of tag\"\n }\n ]\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskDependency.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskDependency.json new file mode 100644 index 00000000..2565ae0c --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskDependency.json @@ -0,0 +1,237 @@ +{ + "name": "RemoveTaskDependency", + "fully_qualified_name": "ClickupApi.RemoveTaskDependency@0.1.0", + "description": "Remove a dependency relationship between tasks.\n\nThis tool is used to remove the dependency relationship between two or more tasks in ClickUp. Call this when two tasks that are currently dependent on one another need to be independent.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "depends_on_task_id", + "required": true, + "description": "The ID of the task that another task depends on. Provide a valid task ID to specify the dependent task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "depends_on" + }, + { + "name": "dependent_task_id", + "required": true, + "description": "The task ID that is dependent on another. Provide a valid task ID as a string.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "dependency_of" + }, + { + "name": "task_id_to_remove_dependency", + "required": true, + "description": "Specify the task ID from which the dependency is to be removed. This is required to identify the task involved in the dependency relationship.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "workspace_id", + "required": false, + "description": "Provide the Workspace ID when using custom task IDs by setting `custom_task_ids` to `true`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true if referencing tasks by their custom task IDs is desired.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteDependency'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/dependency", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "depends_on", + "tool_parameter_name": "depends_on_task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "query", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "dependency_of", + "tool_parameter_name": "dependent_task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "query", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_id_to_remove_dependency", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskFromAdditionalList.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskFromAdditionalList.json new file mode 100644 index 00000000..9f0762f4 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskFromAdditionalList.json @@ -0,0 +1,138 @@ +{ + "name": "RemoveTaskFromAdditionalList", + "fully_qualified_name": "ClickupApi.RemoveTaskFromAdditionalList@0.1.0", + "description": "Remove a task from an additional list in ClickUp.\n\nUse this tool to remove a task from an additional list, not the task's home list. Requires the 'Tasks in Multiple Lists' feature to be enabled in ClickUp.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "additional_list_id", + "required": true, + "description": "The ID of the additional list from which the task should be removed. This is required for identifying the secondary list, not the task's home list.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "task_identifier", + "required": true, + "description": "The unique identifier for the task to be removed from the additional list.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'RemoveTaskFromList'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/task/{task_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "additional_list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskLink.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskLink.json new file mode 100644 index 00000000..62d68ecf --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTaskLink.json @@ -0,0 +1,204 @@ +{ + "name": "RemoveTaskLink", + "fully_qualified_name": "ClickupApi.RemoveTaskLink@0.1.0", + "description": "Remove the link between two tasks.\n\nUse this tool to delete an existing link between two tasks in ClickUp. It is helpful when you need to unlink tasks that are no longer related.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "primary_task_id", + "required": true, + "description": "The ID of the primary task from which to remove the link. This is required to identify the task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "linked_task_id", + "required": true, + "description": "The task ID of the task to which the original task is linked. This specifies the connection to be removed.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "links_to" + }, + { + "name": "workspace_id", + "required": false, + "description": "Provide the Workspace ID when `custom_task_ids` is set to `true`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'DeleteTaskLink'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/link/{links_to}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "primary_task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "links_to", + "tool_parameter_name": "linked_task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTimeEntry.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTimeEntry.json new file mode 100644 index 00000000..838dc4c9 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveTimeEntry.json @@ -0,0 +1,237 @@ +{ + "name": "RemoveTimeEntry", + "fully_qualified_name": "ClickupApi.RemoveTimeEntry@0.1.0", + "description": "Delete a specific time entry from a task.\n\nUse this tool to delete a specific time tracking entry from a task. It's useful for managing or correcting time logs by removing unwanted entries.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_identifier", + "required": true, + "description": "The identifier of the task from which to delete the time entry. This must match the task ID used in ClickUp.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "interval_id_for_removal", + "required": true, + "description": "The unique identifier of the time entry to delete from a task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "interval_id" + }, + { + "name": "content_type_header", + "required": true, + "description": "Specify the media type of the resource (usually 'application/json').", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + }, + { + "name": "workspace_id", + "required": false, + "description": "Provide the Workspace ID when `use_custom_task_ids` is `true`. Required to identify the workspace in ClickUp.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Deletetimetracked'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/time/{interval_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "interval_id", + "tool_parameter_name": "interval_id_for_removal", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveUserFromWorkspace.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveUserFromWorkspace.json new file mode 100644 index 00000000..f5b91cf7 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RemoveUserFromWorkspace.json @@ -0,0 +1,138 @@ +{ + "name": "RemoveUserFromWorkspace", + "fully_qualified_name": "ClickupApi.RemoveUserFromWorkspace@0.1.0", + "description": "Remove a user from a ClickUp workspace.\n\nUse this tool to deactivate a user from a ClickUp workspace, applicable for Workspaces on the Enterprise Plan.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the Workspace in ClickUp from which the user will be removed.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "user_id", + "required": true, + "description": "The ID of the user to be deactivated from the workspace.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "user_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'RemoveUserFromWorkspace'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/user/{user_id}", + "http_method": "DELETE", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "user_id", + "tool_parameter_name": "user_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RenameClickupFolder.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RenameClickupFolder.json new file mode 100644 index 00000000..d1bad501 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RenameClickupFolder.json @@ -0,0 +1,138 @@ +{ + "name": "RenameClickupFolder", + "fully_qualified_name": "ClickupApi.RenameClickupFolder@0.1.0", + "description": "Rename a folder in ClickUp.\n\nUse this tool to update the name of a folder in ClickUp by specifying the folder ID and the new name.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "folder_id_clickup", + "required": true, + "description": "The unique identifier for the ClickUp folder you wish to rename.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + }, + { + "name": "new_folder_name", + "required": true, + "description": "Specify the new name for the folder. This is the name that the folder will be renamed to in ClickUp.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'UpdateFolder'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/folder/{folder_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "folder_id", + "tool_parameter_name": "folder_id_clickup", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "new_folder_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateFolderrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Folder Name\"\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Folder Name\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RenameTimeEntryLabel.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RenameTimeEntryLabel.json new file mode 100644 index 00000000..60e33ebb --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RenameTimeEntryLabel.json @@ -0,0 +1,237 @@ +{ + "name": "RenameTimeEntryLabel", + "fully_qualified_name": "ClickupApi.RenameTimeEntryLabel@0.1.0", + "description": "Rename a time entry label in ClickUp.\n\nUse this tool to change the name of a label associated with time entries for a specific team in ClickUp.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace where the label is located. This is required to specify the team in ClickUp whose label you want to rename.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "current_label_name", + "required": true, + "description": "The current name of the time entry label that needs to be renamed.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "new_label_name", + "required": true, + "description": "The new name for the time entry label to be applied in ClickUp.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "new_name" + }, + { + "name": "label_background_color", + "required": true, + "description": "Hex code for the new background color of the label (e.g., '#FFFFFF').", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag_bg" + }, + { + "name": "foreground_color_for_tag", + "required": true, + "description": "Specify the hexadecimal foreground color for the tag (e.g., '#FFFFFF').", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag_fg" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Changetagnamesfromtimeentries'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/time_entries/tags", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "current_label_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "new_name", + "tool_parameter_name": "new_label_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag_bg", + "tool_parameter_name": "label_background_color", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag_fg", + "tool_parameter_name": "foreground_color_for_tag", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"Changetagnamesfromtimeentriesrequest\",\n \"required\": [\n \"name\",\n \"new_name\",\n \"tag_bg\",\n \"tag_fg\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"new_name\": {\n \"type\": \"string\"\n },\n \"tag_bg\": {\n \"type\": \"string\"\n },\n \"tag_fg\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"old tag name\",\n \"new_name\": \"new tag name\",\n \"tag_bg\": \"#000000\",\n \"tag_fg\": \"#000000\"\n }\n ]\n },\n \"example\": {\n \"name\": \"old tag name\",\n \"new_name\": \"new tag name\",\n \"tag_bg\": \"#000000\",\n \"tag_fg\": \"#000000\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/RetrieveAvailableSpaces.json b/toolkits/clickup_api/clickup_api/wrapper_tools/RetrieveAvailableSpaces.json new file mode 100644 index 00000000..b645369a --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/RetrieveAvailableSpaces.json @@ -0,0 +1,138 @@ +{ + "name": "RetrieveAvailableSpaces", + "fully_qualified_name": "ClickupApi.RetrieveAvailableSpaces@0.1.0", + "description": "View available Spaces in a Workspace.\n\nThe tool retrieves the Spaces within a specified Workspace, providing member info for private Spaces if applicable.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace to retrieve available spaces from.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "include_archived_spaces", + "required": false, + "description": "Set to true to include archived Spaces in the results. Otherwise, only active Spaces are returned.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "archived" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetSpaces'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/space", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "archived", + "tool_parameter_name": "include_archived_spaces", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/SetTaskDependency.json b/toolkits/clickup_api/clickup_api/wrapper_tools/SetTaskDependency.json new file mode 100644 index 00000000..c35e57f1 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/SetTaskDependency.json @@ -0,0 +1,237 @@ +{ + "name": "SetTaskDependency", + "fully_qualified_name": "ClickupApi.SetTaskDependency@0.1.0", + "description": "Set a task as waiting on or blocking another task.\n\nUse this tool to establish a dependency between tasks in ClickUp, either setting a task as waiting on another or as blocking one.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_id_of_dependency", + "required": true, + "description": "The ID of the task that is waiting on or blocking another task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is the task which is waiting on or blocking another task." + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "workspace_id", + "required": false, + "description": "Provide the Workspace ID when `custom_task_ids` is true. Necessary for task identification.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "depends_on_task_id", + "required": false, + "description": "Specify the task ID that this task depends on or is blocked by. It should be a valid task ID in ClickUp.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "depends_on" + }, + { + "name": "dependent_task_id", + "required": false, + "description": "The ID of the task that the specified task depends on or is blocking. This establishes the task dependency relationship.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "depedency_of" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'AddDependency'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/dependency", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_id_of_dependency", + "description": "This is the task which is waiting on or blocking another task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is the task which is waiting on or blocking another task." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "depends_on", + "tool_parameter_name": "depends_on_task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "depedency_of", + "tool_parameter_name": "dependent_task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"Use the `depends_on` parameter in the request body to specify the task that must be completed before the task in the path parameter.\\\\\\n \\\\\\nUse the `dependency_of` parameter in the request body to specify the task that's waiting for the task in the path parameter to be completed.\\\\\\n \\\\\\nYou can only use one per request.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"AddDependencyrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"depends_on\": {\n \"type\": \"string\"\n },\n \"depedency_of\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"depends_on\": \"9hw\"\n }\n ]\n },\n \"example\": {\n \"depends_on\": \"9hw\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/SetupClickupWebhook.json b/toolkits/clickup_api/clickup_api/wrapper_tools/SetupClickupWebhook.json new file mode 100644 index 00000000..b30bcaff --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/SetupClickupWebhook.json @@ -0,0 +1,303 @@ +{ + "name": "SetupClickupWebhook", + "fully_qualified_name": "ClickupApi.SetupClickupWebhook@0.1.0", + "description": "Set up a ClickUp webhook to monitor events.\n\nUse this tool to create a webhook in ClickUp, enabling monitoring of events for a specific team. Useful for triggering actions or notifications based on certain events within a ClickUp team.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace where the webhook will be set up. Use this to specify the team context for monitoring.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "webhook_url", + "required": true, + "description": "The URL where the webhook will send POST requests. Must be reachable to receive event data.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "endpoint" + }, + { + "name": "event_types", + "required": true, + "description": "An array of event types to subscribe to, or use `*` to subscribe to all events. Refer to ClickUp documentation for available options.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "See [documentation](doc:webhooks#task-webhooks) for available event options. Use `*` to subscribe to all events." + }, + "inferrable": true, + "http_endpoint_parameter_name": "events" + }, + { + "name": "space_identifier", + "required": false, + "description": "The numeric ID of the space within a ClickUp workspace for which the webhook is set up.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "folder_id", + "required": false, + "description": "Specify the folder ID in ClickUp for which the webhook is to be created. It should be an integer value representing the folder.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + }, + { + "name": "target_list_id", + "required": false, + "description": "The ID of the list in ClickUp for which you want to set up a webhook.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "specific_task_id", + "required": false, + "description": "Unique identifier for a specific task to monitor. Leave empty if not targeting a specific task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'CreateWebhook'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/webhook", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "endpoint", + "tool_parameter_name": "webhook_url", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "events", + "tool_parameter_name": "event_types", + "description": "See [documentation](doc:webhooks#task-webhooks) for available event options. Use `*` to subscribe to all events.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "See [documentation](doc:webhooks#task-webhooks) for available event options. Use `*` to subscribe to all events." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "space_id", + "tool_parameter_name": "space_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "folder_id", + "tool_parameter_name": "folder_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "list_id", + "tool_parameter_name": "target_list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "specific_task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"You can subscribe to specific events, and one specific location per webhook. [Learn more](doc:webhooks).\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"CreateWebhookrequest\",\n \"required\": [\n \"endpoint\",\n \"events\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"endpoint\": {\n \"type\": \"string\"\n },\n \"events\": {\n \"type\": \"array\",\n \"description\": \"See [documentation](doc:webhooks#task-webhooks) for available event options. Use `*` to subscribe to all events.\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"space_id\": {\n \"type\": \"integer\"\n },\n \"folder_id\": {\n \"type\": \"integer\"\n },\n \"list_id\": {\n \"type\": \"integer\"\n },\n \"task_id\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"endpoint\": \"https://yourdomain.com/webhook\",\n \"events\": [\n \"taskCreated\",\n \"taskUpdated\",\n \"taskDeleted\",\n \"taskPriorityUpdated\",\n \"taskStatusUpdated\",\n \"taskAssigneeUpdated\",\n \"taskDueDateUpdated\",\n \"taskTagUpdated\",\n \"taskMoved\",\n \"taskCommentPosted\",\n \"taskCommentUpdated\",\n \"taskTimeEstimateUpdated\",\n \"taskTimeTrackedUpdated\",\n \"listCreated\",\n \"listUpdated\",\n \"listDeleted\",\n \"folderCreated\",\n \"folderUpdated\",\n \"folderDeleted\",\n \"spaceCreated\",\n \"spaceUpdated\",\n \"spaceDeleted\",\n \"goalCreated\",\n \"goalUpdated\",\n \"goalDeleted\",\n \"keyResultCreated\",\n \"keyResultUpdated\",\n \"keyResultDeleted\"\n ],\n \"space_id\": 1234,\n \"folder_id\": 5678,\n \"list_id\": 9876,\n \"task_id\": \"abc1234\"\n }\n ]\n },\n \"example\": {\n \"endpoint\": \"https://yourdomain.com/webhook\",\n \"events\": [\n \"taskCreated\",\n \"taskUpdated\",\n \"taskDeleted\",\n \"taskPriorityUpdated\",\n \"taskStatusUpdated\",\n \"taskAssigneeUpdated\",\n \"taskDueDateUpdated\",\n \"taskTagUpdated\",\n \"taskMoved\",\n \"taskCommentPosted\",\n \"taskCommentUpdated\",\n \"taskTimeEstimateUpdated\",\n \"taskTimeTrackedUpdated\",\n \"listCreated\",\n \"listUpdated\",\n \"listDeleted\",\n \"folderCreated\",\n \"folderUpdated\",\n \"folderDeleted\",\n \"spaceCreated\",\n \"spaceUpdated\",\n \"spaceDeleted\",\n \"goalCreated\",\n \"goalUpdated\",\n \"goalDeleted\",\n \"keyResultCreated\",\n \"keyResultUpdated\",\n \"keyResultDeleted\"\n ],\n \"space_id\": 1234,\n \"folder_id\": 5678,\n \"list_id\": 9876,\n \"task_id\": \"abc1234\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ShareTaskWithGuest.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ShareTaskWithGuest.json new file mode 100644 index 00000000..70e03800 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ShareTaskWithGuest.json @@ -0,0 +1,270 @@ +{ + "name": "ShareTaskWithGuest", + "fully_qualified_name": "ClickupApi.ShareTaskWithGuest@0.1.0", + "description": "Share a task with a guest in the ClickUp Workspace.\n\nThis tool shares a specified task with a guest, available only on ClickUp's Enterprise Plan.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_id", + "required": true, + "description": "The unique identifier for the task to share with the guest.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "guest_id", + "required": true, + "description": "The unique identifier for the guest to share the task with.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "guest_id" + }, + { + "name": "guest_permission_level", + "required": true, + "description": "Defines the level of access for the guest. Options: 'read', 'comment', 'edit', 'create'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "inferrable": true, + "http_endpoint_parameter_name": "permission_level" + }, + { + "name": "workspace_id_when_custom_task_ids_enabled", + "required": false, + "description": "Provide the Workspace ID when referencing tasks by custom task IDs. Required if `custom_task_ids` is `true`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "include_shared_details", + "required": false, + "description": "Set to `true` to include details of items shared with the guest. Defaults to `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_shared" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'AddGuestToTask'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/guest/{guest_id}", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "include_shared", + "tool_parameter_name": "include_shared_details", + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_when_custom_task_ids_enabled", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "guest_id", + "tool_parameter_name": "guest_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "permission_level", + "tool_parameter_name": "guest_permission_level", + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Can be `read` (view only), `comment`, `edit`, or `create` (full)." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"AddGuestToTaskrequest\",\n \"required\": [\n \"permission_level\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"permission_level\": {\n \"description\": \"Can be `read` (view only), `comment`, `edit`, or `create` (full).\",\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"permission_level\": \"read\"\n }\n ]\n },\n \"example\": {\n \"permission_level\": \"read\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/StartTimerClickup.json b/toolkits/clickup_api/clickup_api/wrapper_tools/StartTimerClickup.json new file mode 100644 index 00000000..c62e93a4 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/StartTimerClickup.json @@ -0,0 +1,288 @@ +{ + "name": "StartTimerClickup", + "fully_qualified_name": "ClickupApi.StartTimerClickup@0.1.0", + "description": "Start a timer for the authenticated ClickUp user.\n\nUse this tool to initiate a timer for the authenticated user in ClickUp. It is ideal for tracking time on specific tasks or projects.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_identifier", + "required": true, + "description": "The Workspace ID required when custom task IDs are used.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_Id" + }, + { + "name": "timer_request_body", + "required": true, + "description": "JSON object detailing the timer entry. Includes fields like `tid`, `description`, `tags`, and `billable`.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "description": "Users on the Business Plan and above can include a time tracking label." + }, + "tid": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "billable": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "For Workspaces on the Free Forever or Unlimited Plan, either the `timer_id` parameter or the `\"tid\"` field in the body of the request are required fields." + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "workspace_id", + "required": false, + "description": "Provide the Workspace ID when `custom_task_ids` is `true`. Required for task referencing.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'StartatimeEntry'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_Id}/time_entries/start", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_Id", + "tool_parameter_name": "workspace_identifier", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "timer_request_body", + "description": "For Workspaces on the Free Forever or Unlimited Plan, either the `timer_id` parameter or the `\"tid\"` field in the body of the request are required fields.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "description": "Users on the Business Plan and above can include a time tracking label." + }, + "tid": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "billable": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "For Workspaces on the Free Forever or Unlimited Plan, either the `timer_id` parameter or the `\"tid\"` field in the body of the request are required fields." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"For Workspaces on the Free Forever or Unlimited Plan, either the `timer_id` parameter or the `\\\"tid\\\"` field in the body of the request are required fields.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"StartatimeEntryrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\"\n },\n \"tags\": {\n \"description\": \"Users on the Business Plan and above can include a time tracking label.\",\n \"type\": \"array\",\n \"items\": {\n \"title\": \"Tags10\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"name of tag\"\n }\n ]\n }\n },\n \"tid\": {\n \"type\": \"string\"\n },\n \"billable\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"description\": \"from api\",\n \"tags\": [\n {\n \"name\": \"tag1\"\n }\n ],\n \"tid\": \"task_id\",\n \"billable\": false\n }\n ]\n },\n \"example\": {\n \"description\": \"from api\",\n \"tags\": [\n {\n \"name\": \"tag1\"\n }\n ],\n \"tid\": \"task_id\",\n \"billable\": false\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/StopTimerEntry.json b/toolkits/clickup_api/clickup_api/wrapper_tools/StopTimerEntry.json new file mode 100644 index 00000000..67104673 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/StopTimerEntry.json @@ -0,0 +1,138 @@ +{ + "name": "StopTimerEntry", + "fully_qualified_name": "ClickupApi.StopTimerEntry@0.1.0", + "description": "Stops a running timer for the authenticated user.\n\nUse this tool to stop a currently running timer for the authenticated user on ClickUp. This action is initiated for a specific team, requiring the team ID.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace where the timer is running. Required to stop the timer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "content_type", + "required": true, + "description": "Specifies the media type of the request. Usually 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'StopatimeEntry'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/time_entries/stop", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/TaskStatusDuration.json b/toolkits/clickup_api/clickup_api/wrapper_tools/TaskStatusDuration.json new file mode 100644 index 00000000..9195d6ad --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/TaskStatusDuration.json @@ -0,0 +1,204 @@ +{ + "name": "TaskStatusDuration", + "fully_qualified_name": "ClickupApi.TaskStatusDuration@0.1.0", + "description": "Get the duration a task spends in each status.\n\nUse this tool to find out how long a task has been in each status. Ensure that the 'Total time in Status' ClickApp is enabled by the Workspace owner or admin before using this tool.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_identifier", + "required": true, + "description": "The unique identifier for the task you want to query. Use this to specify which task's status duration you are interested in.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "content_type", + "required": true, + "description": "Specify the content type for the API request, typically 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + }, + { + "name": "workspace_id", + "required": false, + "description": "The Workspace ID must be provided when referencing a task by its custom task ID and `custom_task_ids` is set to `true`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetTask'sTimeinStatus'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/time_in_status", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateChecklistItem.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateChecklistItem.json new file mode 100644 index 00000000..06ba777d --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateChecklistItem.json @@ -0,0 +1,270 @@ +{ + "name": "UpdateChecklistItem", + "fully_qualified_name": "ClickupApi.UpdateChecklistItem@0.1.0", + "description": "Modify or update a specific task checklist item.\n\nThis tool updates an individual line item in a task checklist. It can rename the item, set the assignee, mark it as resolved, or nest it under another item.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "checklist_unique_identifier", + "required": true, + "description": "The UUID of the checklist to update. Example: b8a8-48d8-a0c6-b4200788a683.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "checklist_id" + }, + { + "name": "checklist_item_uuid", + "required": true, + "description": "The UUID for the specific checklist item to be updated.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "checklist_item_id" + }, + { + "name": "checklist_item_name", + "required": false, + "description": "The new name for the checklist item. Provide a string to rename the item.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "assign_item_to_user", + "required": false, + "description": "The user ID to which the checklist item will be assigned. This should be a string representing a valid user identifier in ClickUp.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignee" + }, + { + "name": "parent_checklist_item_id", + "required": false, + "description": "Include another item's `checklist_item_id` to nest this item under it.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To nest a checklist item under another checklist item, include the other item's `checklist_item_id`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "parent" + }, + { + "name": "mark_as_resolved", + "required": false, + "description": "Boolean to mark the checklist item as resolved (true) or unresolved (false).", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "resolved" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'EditChecklistItem'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "checklist_id", + "tool_parameter_name": "checklist_unique_identifier", + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "b8a8-48d8-a0c6-b4200788a683 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "checklist_item_id", + "tool_parameter_name": "checklist_item_uuid", + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "checklist_item_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "assignee", + "tool_parameter_name": "assign_item_to_user", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "resolved", + "tool_parameter_name": "mark_as_resolved", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "parent", + "tool_parameter_name": "parent_checklist_item_id", + "description": "To nest a checklist item under another checklist item, include the other item's `checklist_item_id`.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To nest a checklist item under another checklist item, include the other item's `checklist_item_id`." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditChecklistItemrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"assignee\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"resolved\": {\n \"type\": \"boolean\"\n },\n \"parent\": {\n \"description\": \"To nest a checklist item under another checklist item, include the other item's `checklist_item_id`.\",\n \"type\": [\n \"string\",\n \"null\"\n ]\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Checklist Item\",\n \"assignee\": null,\n \"resolved\": true,\n \"parent\": null\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Checklist Item\",\n \"assignee\": null,\n \"resolved\": true,\n \"parent\": null\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupList.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupList.json new file mode 100644 index 00000000..8d786559 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupList.json @@ -0,0 +1,402 @@ +{ + "name": "UpdateClickupList", + "fully_qualified_name": "ClickupApi.UpdateClickupList@0.1.0", + "description": "Update the details of a ClickUp list.\n\nUse this tool to rename a ClickUp list, update its description, set a due date or time, change the priority, assign someone, or modify the list color.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "list_identifier", + "required": true, + "description": "The unique identifier of the ClickUp list to update. This is a required string field.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "list_name", + "required": true, + "description": "The new name for the ClickUp list. This should be a string value.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "list_description_content", + "required": false, + "description": "The plain text description to update for the ClickUp list. Use this instead of markdown for simple text updates.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "content" + }, + { + "name": "formatted_list_description", + "required": false, + "description": "Formatted description of the list using Markdown syntax instead of plain text.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "inferrable": true, + "http_endpoint_parameter_name": "markdown_content" + }, + { + "name": "list_due_date", + "required": false, + "description": "Set the list's due date as a Unix timestamp in milliseconds, representing the time the list is due.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date" + }, + { + "name": "list_priority", + "required": false, + "description": "Set the list's priority as an integer. Usually, 1 is high, 2 is medium, and 3 is low priority.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "priority" + }, + { + "name": "list_assignee_id", + "required": false, + "description": "The ID of the user to assign to the list. Provide a valid user ID string.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignee" + }, + { + "name": "list_color", + "required": false, + "description": "Specify the color of the list. This refers to the List color rather than task statuses.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "inferrable": true, + "http_endpoint_parameter_name": "status" + }, + { + "name": "include_due_date_time", + "required": false, + "description": "Set to true to include a specific time with the due date.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date_time" + }, + { + "name": "remove_list_color", + "required": false, + "description": "Set to `true` to remove the List color; default is `false`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "By default, this is `false.` To remove the List color use `unset_status: true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "unset_status" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'UpdateList'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "list_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "list_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "content", + "tool_parameter_name": "list_description_content", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "markdown_content", + "tool_parameter_name": "formatted_list_description", + "description": "Use `markdown_content` instead of `content` to format your List description.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Use `markdown_content` instead of `content` to format your List description." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date", + "tool_parameter_name": "list_due_date", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date_time", + "tool_parameter_name": "include_due_date_time", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "priority", + "tool_parameter_name": "list_priority", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "assignee", + "tool_parameter_name": "list_assignee_id", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "status", + "tool_parameter_name": "list_color", + "description": "**Status** refers to the List color rather than the task Statuses available in the List.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "**Status** refers to the List color rather than the task Statuses available in the List." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "unset_status", + "tool_parameter_name": "remove_list_color", + "description": "By default, this is `false.` To remove the List color use `unset_status: true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "By default, this is `false.` To remove the List color use `unset_status: true`." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateListrequest\",\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"content\": {\n \"type\": \"string\"\n },\n \"markdown_content\": {\n \"type\": \"string\",\n \"description\": \"Use `markdown_content` instead of `content` to format your List description.\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"due_date_time\": {\n \"type\": \"boolean\"\n },\n \"priority\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"assignee\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"description\": \"**Status** refers to the List color rather than the task Statuses available in the List.\",\n \"type\": \"string\"\n },\n \"unset_status\": {\n \"description\": \"By default, this is `false.` To remove the List color use `unset_status: true`.\",\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated List Name\",\n \"content\": \"Updated List Content\",\n \"markdown_content\": \"# This is markdown\\n ***bold and italicized text***\",\n \"due_date\": 1567780450202,\n \"due_date_time\": true,\n \"priority\": 2,\n \"assignee\": \"none\",\n \"status\": \"red\",\n \"unset_status\": true\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated List Name\",\n \"content\": \"Updated List Content\",\n \"markdown_content\": \"# This is markdown\\n ***bold and italicized text***\",\n \"due_date\": 1567780450202,\n \"due_date_time\": true,\n \"priority\": 2,\n \"assignee\": \"none\",\n \"status\": \"red\",\n \"unset_status\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupSpace.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupSpace.json new file mode 100644 index 00000000..b8891c31 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupSpace.json @@ -0,0 +1,592 @@ +{ + "name": "UpdateClickupSpace", + "fully_qualified_name": "ClickupApi.UpdateClickupSpace@0.1.0", + "description": "Update space attributes in ClickUp.\n\nUse this tool to rename a ClickUp space, change its color, and enable or disable ClickApps for it. Call this when you need to modify the settings of an existing space.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_identifier", + "required": true, + "description": "The unique identifier for the ClickUp space to be updated.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "space_update_details", + "required": true, + "description": "JSON object containing the new settings for the space. Includes name, color, privacy settings, admin management, multiple assignees, and feature settings.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "color": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "private": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "admin_can_manage": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "***Note:** Allowing or restricting admins from managing private Spaces using `\"admin_can_manage\"` is an [Enterprise Plan](https://clickup.com/pricing) feature.*" + }, + "multiple_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "features": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "due_dates": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "remap_due_dates": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "remap_closed_due_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "time_tracking": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "time_estimates": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "checklists": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "custom_fields": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "remap_dependencies": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "dependency_warning": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "portfolios": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'UpdateSpace'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "space_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "space_update_details", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "color": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "private": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "admin_can_manage": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "***Note:** Allowing or restricting admins from managing private Spaces using `\"admin_can_manage\"` is an [Enterprise Plan](https://clickup.com/pricing) feature.*" + }, + "multiple_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "features": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "due_dates": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "remap_due_dates": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "remap_closed_due_date": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "time_tracking": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "time_estimates": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "checklists": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "custom_fields": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "remap_dependencies": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "dependency_warning": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "portfolios": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "enabled": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateSpacerequest\",\n \"required\": [\n \"name\",\n \"color\",\n \"private\",\n \"admin_can_manage\",\n \"multiple_assignees\",\n \"features\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"color\": {\n \"type\": \"string\"\n },\n \"private\": {\n \"type\": \"boolean\"\n },\n \"admin_can_manage\": {\n \"description\": \"***Note:** Allowing or restricting admins from managing private Spaces using `\\\"admin_can_manage\\\"` is an [Enterprise Plan](https://clickup.com/pricing) feature.*\",\n \"type\": \"boolean\"\n },\n \"multiple_assignees\": {\n \"type\": \"boolean\"\n },\n \"features\": {\n \"title\": \"Features\",\n \"required\": [\n \"due_dates\",\n \"time_tracking\",\n \"tags\",\n \"time_estimates\",\n \"checklists\",\n \"custom_fields\",\n \"remap_dependencies\",\n \"dependency_warning\",\n \"portfolios\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"due_dates\": {\n \"title\": \"DueDates\",\n \"required\": [\n \"enabled\",\n \"start_date\",\n \"remap_due_dates\",\n \"remap_closed_due_date\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n },\n \"start_date\": {\n \"type\": \"boolean\"\n },\n \"remap_due_dates\": {\n \"type\": \"boolean\"\n },\n \"remap_closed_due_date\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true,\n \"start_date\": false,\n \"remap_due_dates\": true,\n \"remap_closed_due_date\": false\n }\n ]\n },\n \"time_tracking\": {\n \"title\": \"TimeTracking\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": false\n }\n ]\n },\n \"tags\": {\n \"title\": \"Tags\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"time_estimates\": {\n \"title\": \"TimeEstimates\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"checklists\": {\n \"title\": \"Checklists\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"custom_fields\": {\n \"title\": \"CustomFields\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"remap_dependencies\": {\n \"title\": \"RemapDependencies\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"dependency_warning\": {\n \"title\": \"DependencyWarning\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n },\n \"portfolios\": {\n \"title\": \"Portfolios\",\n \"required\": [\n \"enabled\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"enabled\": true\n }\n ]\n }\n },\n \"examples\": [\n {\n \"due_dates\": {\n \"enabled\": true,\n \"start_date\": false,\n \"remap_due_dates\": true,\n \"remap_closed_due_date\": false\n },\n \"time_tracking\": {\n \"enabled\": false\n },\n \"tags\": {\n \"enabled\": true\n },\n \"time_estimates\": {\n \"enabled\": true\n },\n \"checklists\": {\n \"enabled\": true\n },\n \"custom_fields\": {\n \"enabled\": true\n },\n \"remap_dependencies\": {\n \"enabled\": true\n },\n \"dependency_warning\": {\n \"enabled\": true\n },\n \"portfolios\": {\n \"enabled\": true\n }\n }\n ]\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Space Name\",\n \"color\": \"#7B68EE\",\n \"private\": false,\n \"admin_can_manage\": false,\n \"multiple_assignees\": false,\n \"features\": {\n \"due_dates\": {\n \"enabled\": false,\n \"start_date\": false,\n \"remap_due_dates\": false,\n \"remap_closed_due_date\": false\n },\n \"time_tracking\": {\n \"enabled\": false\n },\n \"tags\": {\n \"enabled\": false\n },\n \"time_estimates\": {\n \"enabled\": false\n },\n \"checklists\": {\n \"enabled\": true\n },\n \"custom_fields\": {\n \"enabled\": true\n },\n \"remap_dependencies\": {\n \"enabled\": false\n },\n \"dependency_warning\": {\n \"enabled\": false\n },\n \"portfolios\": {\n \"enabled\": false\n }\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Space Name\",\n \"color\": \"#7B68EE\",\n \"private\": false,\n \"admin_can_manage\": false,\n \"multiple_assignees\": false,\n \"features\": {\n \"due_dates\": {\n \"enabled\": false,\n \"start_date\": false,\n \"remap_due_dates\": false,\n \"remap_closed_due_date\": false\n },\n \"time_tracking\": {\n \"enabled\": false\n },\n \"tags\": {\n \"enabled\": false\n },\n \"time_estimates\": {\n \"enabled\": false\n },\n \"checklists\": {\n \"enabled\": true\n },\n \"custom_fields\": {\n \"enabled\": true\n },\n \"remap_dependencies\": {\n \"enabled\": false\n },\n \"dependency_warning\": {\n \"enabled\": false\n },\n \"portfolios\": {\n \"enabled\": false\n }\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupWebhookEvents.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupWebhookEvents.json new file mode 100644 index 00000000..9cb2a4e3 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateClickupWebhookEvents.json @@ -0,0 +1,204 @@ +{ + "name": "UpdateClickupWebhookEvents", + "fully_qualified_name": "ClickupApi.UpdateClickupWebhookEvents@0.1.0", + "description": "Update a ClickUp webhook to modify monitored events.\n\nUse this tool to update the events a ClickUp webhook monitors, allowing for changes to event tracking as needed.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "webhook_identifier", + "required": true, + "description": "The unique identifier for the webhook to be updated, formatted as a UUID.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e506-4a29-9d42-26e504e3435e (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "webhook_id" + }, + { + "name": "webhook_endpoint_url", + "required": true, + "description": "The URL where the webhook should send POST requests for the events. Must be a valid and accessible URL.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "endpoint" + }, + { + "name": "monitored_events", + "required": true, + "description": "A comma-separated list of events for the webhook to monitor. Use valid event names as per ClickUp webhook documentation.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "events" + }, + { + "name": "webhook_status", + "required": true, + "description": "Specify the new status of the webhook. Use 'active' to enable or 'inactive' to disable it.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "status" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'UpdateWebhook'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/webhook/{webhook_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "webhook_id", + "tool_parameter_name": "webhook_identifier", + "description": "e506-4a29-9d42-26e504e3435e (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "e506-4a29-9d42-26e504e3435e (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "endpoint", + "tool_parameter_name": "webhook_endpoint_url", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "events", + "tool_parameter_name": "monitored_events", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "status", + "tool_parameter_name": "webhook_status", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"To subscribe to specific events, pass an array of `events` that you want to subscribe to, or use the wildcard character `\\\"*\\\"` to subscribe to everything.\\\\\\n \\\\\\nIf you don't specify any events, all events will be sent to the webhook.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateWebhookrequest\",\n \"required\": [\n \"endpoint\",\n \"events\",\n \"status\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"endpoint\": {\n \"type\": \"string\"\n },\n \"events\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"endpoint\": \"https://yourdomain.com/webhook\",\n \"events\": \"*\",\n \"status\": \"active\"\n }\n ]\n },\n \"example\": {\n \"endpoint\": \"https://yourdomain.com/webhook\",\n \"events\": \"*\",\n \"status\": \"active\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateGoalDetails.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateGoalDetails.json new file mode 100644 index 00000000..7846cec7 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateGoalDetails.json @@ -0,0 +1,303 @@ +{ + "name": "UpdateGoalDetails", + "fully_qualified_name": "ClickupApi.UpdateGoalDetails@0.1.0", + "description": "Update goal details such as name, due date, and owners.\n\nUse this tool to rename a goal, set its due date, update its description, manage owners, or change its color in ClickUp.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "goal_id", + "required": true, + "description": "The unique identifier for the goal to be updated. This is a UUID.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "goal_id" + }, + { + "name": "goal_name", + "required": true, + "description": "The new name for the goal. This will replace the current goal name.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "goal_due_date", + "required": true, + "description": "An integer representing the new due date for the goal, usually in Unix timestamp format.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "due_date" + }, + { + "name": "goal_description", + "required": true, + "description": "The new description for the goal. This should provide an overview or details of the goal's purpose.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "description" + }, + { + "name": "remove_owners_user_ids", + "required": true, + "description": "Array of user IDs to be removed as owners of the goal.", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of user IDs." + }, + "inferrable": true, + "http_endpoint_parameter_name": "rem_owners" + }, + { + "name": "new_owners_to_add", + "required": true, + "description": "List of user IDs to add as new owners for the goal.", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of user IDs." + }, + "inferrable": true, + "http_endpoint_parameter_name": "add_owners" + }, + { + "name": "goal_color", + "required": true, + "description": "Set the color of the goal. Accepts a string representing the color, such as a hex code.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "color" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'UpdateGoal'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/goal/{goal_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "goal_id", + "tool_parameter_name": "goal_id", + "description": "900e-462d-a849-4a216b06d930 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "900e-462d-a849-4a216b06d930 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "goal_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "due_date", + "tool_parameter_name": "goal_due_date", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "description", + "tool_parameter_name": "goal_description", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "rem_owners", + "tool_parameter_name": "remove_owners_user_ids", + "description": "Array of user IDs.", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of user IDs." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "add_owners", + "tool_parameter_name": "new_owners_to_add", + "description": "Array of user IDs.", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Array of user IDs." + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "color", + "tool_parameter_name": "goal_color", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateGoalrequest\",\n \"required\": [\n \"name\",\n \"due_date\",\n \"description\",\n \"rem_owners\",\n \"add_owners\",\n \"color\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"rem_owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"Array of user IDs.\"\n },\n \"add_owners\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"Array of user IDs.\"\n },\n \"color\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Goal Name\",\n \"due_date\": 1568036964079,\n \"description\": \"Updated Goal Description\",\n \"rem_owners\": [\n 183\n ],\n \"add_owners\": [\n 184\n ],\n \"color\": \"#32a852\"\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Goal Name\",\n \"due_date\": 1568036964079,\n \"description\": \"Updated Goal Description\",\n \"rem_owners\": [\n 183\n ],\n \"add_owners\": [\n 184\n ],\n \"color\": \"#32a852\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateKeyResultTarget.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateKeyResultTarget.json new file mode 100644 index 00000000..41a3d232 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateKeyResultTarget.json @@ -0,0 +1,171 @@ +{ + "name": "UpdateKeyResultTarget", + "fully_qualified_name": "ClickupApi.UpdateKeyResultTarget@0.1.0", + "description": "Update the target of a specific key result.\n\nUse this tool to update the target value of a specified key result. It should be called when there's a need to modify the target associated with a key result in ClickUp.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "key_result_identifier", + "required": true, + "description": "Unique identifier for the key result to be updated, provided as a UUID.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "8480-49bc-8c57-e569747efe93 (uuid)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "key_result_id" + }, + { + "name": "current_steps_value", + "required": true, + "description": "The current number of steps completed for the key result target. Provide an integer value.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "steps_current" + }, + { + "name": "note_update_description", + "required": true, + "description": "Text for the note associated with the key result. Use to add or update content related to the key result.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "note" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'EditKeyResult'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/key_result/{key_result_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "key_result_id", + "tool_parameter_name": "key_result_identifier", + "description": "8480-49bc-8c57-e569747efe93 (uuid)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "8480-49bc-8c57-e569747efe93 (uuid)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "steps_current", + "tool_parameter_name": "current_steps_value", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "note", + "tool_parameter_name": "note_update_description", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"All properties available in the Create Key Result endpoint may also be used along with the additional properties below.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditKeyResultrequest\",\n \"required\": [\n \"steps_current\",\n \"note\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"steps_current\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"note\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"steps_current\": 5,\n \"note\": \"Target achieved\"\n }\n ]\n },\n \"example\": {\n \"steps_current\": 5,\n \"note\": \"Target achieved\"\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskComment.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskComment.json new file mode 100644 index 00000000..1fe2535a --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskComment.json @@ -0,0 +1,237 @@ +{ + "name": "UpdateTaskComment", + "fully_qualified_name": "ClickupApi.UpdateTaskComment@0.1.0", + "description": "Update a task comment in ClickUp.\n\nUse this tool to replace a task comment's content, assign it, or mark it as resolved in ClickUp.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "comment_identifier", + "required": true, + "description": "The unique identifier of the comment to update. It must be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "comment_id" + }, + { + "name": "new_comment_content", + "required": true, + "description": "The new content for the task comment. This will replace the existing comment text.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "comment_text" + }, + { + "name": "assignee_user_id", + "required": true, + "description": "The ID of the user to assign the comment to. This should be a numeric user ID in ClickUp.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "assignee" + }, + { + "name": "mark_comment_as_resolved", + "required": true, + "description": "Set to true to mark the comment as resolved; false to leave it unresolved. Accepts a boolean value.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "resolved" + }, + { + "name": "assign_to_group", + "required": false, + "description": "Assign the comment to a group by providing the group's ID.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "group_assignee" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'UpdateComment'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/comment/{comment_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "comment_id", + "tool_parameter_name": "comment_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "comment_text", + "tool_parameter_name": "new_comment_content", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "assignee", + "tool_parameter_name": "assignee_user_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "group_assignee", + "tool_parameter_name": "assign_to_group", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "resolved", + "tool_parameter_name": "mark_comment_as_resolved", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateCommentrequest\",\n \"required\": [\n \"comment_text\",\n \"assignee\",\n \"resolved\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"comment_text\": {\n \"type\": \"string\"\n },\n \"assignee\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"group_assignee\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\",\n \"description\": \"\"\n },\n \"resolved\": {\n \"description\": \"\",\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"comment_text\": \"Updated comment content\",\n \"assignee\": 183,\n \"resolved\": true\n }\n ]\n },\n \"example\": {\n \"comment_text\": \"Updated comment content\",\n \"assignee\": 183,\n \"group_assignee\": \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\",\n \"resolved\": true\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskCustomField.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskCustomField.json new file mode 100644 index 00000000..a11550d8 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskCustomField.json @@ -0,0 +1,237 @@ +{ + "name": "UpdateTaskCustomField", + "fully_qualified_name": "ClickupApi.UpdateTaskCustomField@0.1.0", + "description": "Update a custom field value for a specific task in ClickUp.\n\nUse this tool to add data to a custom field on a task. Requires the `task_id` of the task and the `field_id` of the custom field. Retrieve `field_id` using the 'Get Accessible Custom Fields' or 'Get Task' endpoints.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_id", + "required": true, + "description": "The ID of the task to be updated with new custom field data.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the task ID of the task you want to update." + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "custom_field_uuid", + "required": true, + "description": "The UUID of the custom field to update for a specific task.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the universal unique identifier (UUID) of the Custom Field you want to set." + }, + "inferrable": true, + "http_endpoint_parameter_name": "field_id" + }, + { + "name": "custom_field_value_data", + "required": true, + "description": "A JSON object containing the data to set for the custom field on the task.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "workspace_id", + "required": false, + "description": "Provide the Workspace ID when referencing a task by its Custom Task ID (`custom_task_ids` must be true).", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_id_reference", + "required": false, + "description": "Set to `true` to reference a task using its Custom Task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its Custom Task ID, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'SetCustomFieldValue'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}/field/{field_id}", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_id_reference", + "description": "If you want to reference a task by its Custom Task ID, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its Custom Task ID, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_id", + "description": "Enter the task ID of the task you want to update.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the task ID of the task you want to update." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "field_id", + "tool_parameter_name": "custom_field_uuid", + "description": "Enter the universal unique identifier (UUID) of the Custom Field you want to set.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the universal unique identifier (UUID) of the Custom Field you want to set." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "custom_field_value_data", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"SetCustomFieldValuerequest\",\n \"anyOf\": [\n {\n \"type\": \"object\",\n \"title\": \"URL Custom Field\",\n \"description\": \"The `value` must be a string with a valid URL.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"example\": \"https://clickup.com/api\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Dropdown Custom Field\",\n \"description\": \"Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"example\": \"uuid1234\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Email Custom Field\",\n \"description\": \"The `value` must be a string with a valid email address.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"example\": \"user@company.com\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Phone Custom Field\",\n \"description\": \"The `value` must be a string with a valid country code.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"example\": \"+1 123 456 7890\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Date Custom Field\",\n \"description\": \"The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.\",\n \"properties\": {\n \"value\": {\n \"type\": \"integer\",\n \"format\": \"int32\",\n \"example\": 1667367645000\n },\n \"value_options\": {\n \"type\": \"object\",\n \"required\": [\n \"time\"\n ],\n \"properties\": {\n \"time\": {\n \"type\": \"boolean\",\n \"example\": true\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Short or Long Text Custom Field\",\n \"description\": \"Enter a string of text.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"string\",\n \"example\": \"This is short or long text in a Custom Field.\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Number Custom Field\",\n \"description\": \"Enter a number.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"number\",\n \"example\": -28\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Money Custom Field\",\n \"description\": \"You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"number\",\n \"example\": 8000\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Task Relationship Custom Field\",\n \"description\": \"Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"People Custom Field\",\n \"description\": \"Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"number\"\n }\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Emoji (Rating) Custom Field\",\n \"description\": \"Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"integer\",\n \"format\": \"int32\",\n \"example\": 4\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Manual Progress Custom Field\",\n \"description\": \"Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"object\",\n \"required\": [\n \"current\"\n ],\n \"properties\": {\n \"current\": {\n \"type\": \"number\",\n \"example\": 20\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Label Custom Field\",\n \"description\": \"Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"example\": [\n \"uuid1234\",\n \"uuid9876\"\n ]\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Location Custom Field\",\n \"description\": \"Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"object\",\n \"properties\": {\n \"location\": {\n \"type\": \"object\",\n \"properties\": {\n \"lat\": {\n \"type\": \"number\"\n },\n \"lng\": {\n \"type\": \"number\"\n }\n }\n },\n \"formatted_address\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n {\n \"type\": \"object\",\n \"title\": \"Button Custom Field\",\n \"description\": \"Set a button Custom Field to `true` to \\\"click\\\" it. This will trigger the button's action as if it was clicked in the UI.\",\n \"required\": [\n \"value\"\n ],\n \"properties\": {\n \"value\": {\n \"type\": \"boolean\",\n \"example\": true\n }\n }\n }\n ]\n },\n \"examples\": {\n \"URL Custom Field\": {\n \"value\": {\n \"value\": \"https://clickup.com/api\"\n }\n },\n \"Dropdown Custom Field\": {\n \"value\": {\n \"value\": \"uuid1234\"\n }\n },\n \"Email Custom Field\": {\n \"value\": {\n \"value\": \"user@company.com\"\n }\n },\n \"Phone Custom Field\": {\n \"value\": {\n \"value\": \"+1 201 555 0123\"\n }\n },\n \"Date Custom Field\": {\n \"value\": {\n \"value\": 1667367645000,\n \"value_options\": {\n \"time\": true\n }\n }\n },\n \"Short or Long Text Custom Field\": {\n \"value\": {\n \"value\": \"This is short or long text in a Custom Field.\"\n }\n },\n \"Number Custom Field\": {\n \"value\": {\n \"value\": -28\n }\n },\n \"Money Custom Field\": {\n \"value\": {\n \"value\": 8000\n }\n },\n \"Task Relationship Custom Field\": {\n \"value\": {\n \"value\": {\n \"add\": [\n \"abcd1234\",\n \"efghi5678\"\n ],\n \"rem\": [\n \"jklm9876\",\n \"yuiop5678\"\n ]\n }\n }\n },\n \"People Custom Field\": {\n \"value\": {\n \"value\": {\n \"add\": [\n 123,\n 456\n ],\n \"rem\": [\n 987,\n 765\n ]\n }\n }\n },\n \"Emoji (Rating) Custom Field\": {\n \"value\": {\n \"value\": 4\n }\n },\n \"Manual Progress Custom Field\": {\n \"value\": {\n \"value\": {\n \"current\": 20\n }\n }\n },\n \"Label Custom Field\": {\n \"value\": {\n \"value\": [\n \"uuid1234\",\n \"uuid9876\"\n ]\n }\n },\n \"Location Custom Field\": {\n \"value\": {\n \"value\": {\n \"location\": {\n \"lat\": -28.016667,\n \"lng\": 153.4\n },\n \"formatted_address\": \"Gold Coast QLD, Australia\"\n }\n }\n },\n \"Button Custom Field\": {\n \"value\": {\n \"value\": true\n }\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskInClickup.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskInClickup.json new file mode 100644 index 00000000..85bcc279 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskInClickup.json @@ -0,0 +1,580 @@ +{ + "name": "UpdateTaskInClickup", + "fully_qualified_name": "ClickupApi.UpdateTaskInClickup@0.1.0", + "description": "Update task details in ClickUp.\n\nUse this tool to update specific fields of a task in ClickUp by providing the task ID and desired changes.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_identifier", + "required": true, + "description": "The ID of the task to be updated. Provide either the standard task ID or a custom task ID if 'custom_task_ids' is true.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "task_update_details", + "required": true, + "description": "JSON object containing the fields to update on the task. Includes fields like name, description, priority, due dates, assignees, and more.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "custom_item_id": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The custom task type ID for this task. A value of `null` (default) sets the task type to type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + }, + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To clear the task description, include `Description` with `\" \"`." + }, + "markdown_content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`." + }, + "status": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "priority": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "parent": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "You can move a subtask to another parent task by including `\"parent\"` with a valid `task id`.\\\n \\\nYou cannot convert a subtask to a task by setting `\"parent\"` to `null`." + }, + "time_estimate": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "points": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Update the task's Sprint Points." + }, + "assignees": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "add": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "rem": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + } + }, + "inner_properties": null, + "description": null + }, + "group_assignees": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "add": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "rem": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + } + }, + "inner_properties": null, + "description": null + }, + "watchers": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "add": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "rem": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + } + }, + "inner_properties": null, + "description": null + }, + "archived": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "***Note:** To update Custom Fields on a task, you must use the Set Custom Field endpoint.*" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "workspace_id_for_custom_task", + "required": false, + "description": "Provide the Workspace ID when referencing a task by its custom task ID (requires `custom_task_ids` set to true).", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'UpdateTask'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by its custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_for_custom_task", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "task_update_details", + "description": "***Note:** To update Custom Fields on a task, you must use the Set Custom Field endpoint.*", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "custom_item_id": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The custom task type ID for this task. A value of `null` (default) sets the task type to type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)." + }, + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To clear the task description, include `Description` with `\" \"`." + }, + "markdown_content": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`." + }, + "status": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "priority": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "due_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "parent": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "You can move a subtask to another parent task by including `\"parent\"` with a valid `task id`.\\\n \\\nYou cannot convert a subtask to a task by setting `\"parent\"` to `null`." + }, + "time_estimate": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start_date_time": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "points": { + "val_type": "number", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Update the task's Sprint Points." + }, + "assignees": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "add": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "rem": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + } + }, + "inner_properties": null, + "description": null + }, + "group_assignees": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "add": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "rem": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + } + }, + "inner_properties": null, + "description": null + }, + "watchers": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "add": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "rem": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + } + }, + "inner_properties": null, + "description": null + }, + "archived": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "***Note:** To update Custom Fields on a task, you must use the Set Custom Field endpoint.*" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"***Note:** To update Custom Fields on a task, you must use the Set Custom Field endpoint.*\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateTaskrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"custom_item_id\": {\n \"type\": [\n \"number\",\n \"null\"\n ],\n \"description\": \"The custom task type ID for this task. A value of `null` (default) sets the task type to type \\\"Task\\\".\\\\\\n \\\\\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems).\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"description\": \"To clear the task description, include `Description` with `\\\" \\\"`.\",\n \"type\": \"string\"\n },\n \"markdown_content\": {\n \"type\": \"string\",\n \"description\": \"Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`.\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"priority\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"due_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"due_date_time\": {\n \"type\": \"boolean\"\n },\n \"parent\": {\n \"description\": \"You can move a subtask to another parent task by including `\\\"parent\\\"` with a valid `task id`.\\\\\\n \\\\\\nYou cannot convert a subtask to a task by setting `\\\"parent\\\"` to `null`.\",\n \"type\": \"string\"\n },\n \"time_estimate\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"start_date\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\"\n },\n \"start_date_time\": {\n \"type\": \"boolean\"\n },\n \"points\": {\n \"type\": \"number\",\n \"description\": \"Update the task's Sprint Points.\"\n },\n \"assignees\": {\n \"title\": \"Assignees\",\n \"required\": [\n \"add\",\n \"rem\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"add\": [\n 182\n ],\n \"rem\": [\n 183\n ]\n }\n ]\n },\n \"group_assignees\": {\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n }\n }\n },\n \"watchers\": {\n \"title\": \"Watchers\",\n \"required\": [\n \"add\",\n \"rem\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"add\": [\n 182,\n 121\n ],\n \"rem\": [\n 183,\n 122\n ]\n }\n ]\n },\n \"archived\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Task Name\",\n \"description\": \"Updated Task Content\",\n \"status\": \"in progress\",\n \"priority\": 1,\n \"due_date\": 1508369194377,\n \"due_date_time\": false,\n \"parent\": \"abc1234\",\n \"time_estimate\": 8640000,\n \"start_date\": 1567780450202,\n \"start_date_time\": false,\n \"points\": 3,\n \"assignees\": {\n \"add\": [\n 182\n ],\n \"rem\": [\n 183\n ]\n },\n \"group_assignees\": {\n \"add\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\"\n ],\n \"rem\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f13\"\n ]\n },\n \"watchers\": {\n \"add\": [\n 182\n ],\n \"rem\": [\n 183\n ]\n },\n \"archived\": false\n }\n ]\n },\n \"example\": {\n \"name\": \"Updated Task Name\",\n \"description\": \"Updated Task Content\",\n \"status\": \"in progress\",\n \"priority\": 3,\n \"due_date\": 1508369194377,\n \"due_date_time\": false,\n \"parent\": \"abc1234\",\n \"time_estimate\": 8640000,\n \"start_date\": 1567780450202,\n \"start_date_time\": false,\n \"points\": 3,\n \"assignees\": {\n \"add\": [\n 182\n ],\n \"rem\": [\n 183\n ]\n },\n \"group_assignees\": {\n \"add\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f14\"\n ],\n \"rem\": [\n \"dd01f92f-48ca-446d-88a1-0beb0e8f5f13\"\n ]\n },\n \"archived\": false\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskTag.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskTag.json new file mode 100644 index 00000000..a3c641e0 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTaskTag.json @@ -0,0 +1,237 @@ +{ + "name": "UpdateTaskTag", + "fully_qualified_name": "ClickupApi.UpdateTaskTag@0.1.0", + "description": "Update a task tag in a ClickUp space.\n\nUse this tool to update the details of a task tag within a specified ClickUp space. It is helpful for managing and organizing tasks by modifying existing tags.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "space_id", + "required": true, + "description": "The unique identifier of the ClickUp space where the tag will be updated. This is required to specify which space's tag needs modification.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "space_id" + }, + { + "name": "current_tag_name", + "required": true, + "description": "The current name of the tag to be updated in the ClickUp space.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag_name" + }, + { + "name": "new_tag_name", + "required": true, + "description": "The new name for the task tag to be updated in the ClickUp space. It must be a string representing the desired tag name after the update.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag.name" + }, + { + "name": "tag_foreground_color", + "required": true, + "description": "The foreground (text) color of the tag in a valid color format (e.g., HEX).", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag.fg_color" + }, + { + "name": "background_color_of_tag", + "required": true, + "description": "The background color for the task tag. It should be a valid hex color code (e.g., #FFFFFF).", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "tag.bg_color" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'EditSpaceTag'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/space/{space_id}/tag/{tag_name}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "space_id", + "tool_parameter_name": "space_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag_name", + "tool_parameter_name": "current_tag_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag.name", + "tool_parameter_name": "new_tag_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag.fg_color", + "tool_parameter_name": "tag_foreground_color", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "tag.bg_color", + "tool_parameter_name": "background_color_of_tag", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditSpaceTagrequest\",\n \"required\": [\n \"tag\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"tag\": {\n \"title\": \"Tag1\",\n \"required\": [\n \"name\",\n \"fg_color\",\n \"bg_color\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"fg_color\": {\n \"type\": \"string\"\n },\n \"bg_color\": {\n \"type\": \"string\"\n }\n },\n \"examples\": [\n {\n \"name\": \"Updated Tag\",\n \"fg_color\": \"#ffffff\",\n \"bg_color\": \"#ffffff\"\n }\n ]\n }\n },\n \"examples\": [\n {\n \"tag\": {\n \"name\": \"Updated Tag\",\n \"fg_color\": \"#ffffff\",\n \"bg_color\": \"#ffffff\"\n }\n }\n ]\n },\n \"example\": {\n \"tag\": {\n \"name\": \"Tag name\",\n \"tag_fg\": \"#000000\",\n \"tag_bg\": \"#000000\"\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTimeEntry.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTimeEntry.json new file mode 100644 index 00000000..f116d434 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateTimeEntry.json @@ -0,0 +1,367 @@ +{ + "name": "UpdateTimeEntry", + "fully_qualified_name": "ClickupApi.UpdateTimeEntry@0.1.0", + "description": "Update the details of a time entry.\n\nThis tool updates specific details of a time entry in ClickUp. Use it when you need to modify data such as the duration, description, or other attributes of an existing time entry.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The Workspace ID is required when referencing a task by its custom task ID. Provide it if `custom_task_ids` is set to `true`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "team_identifier", + "required": true, + "description": "The ID of the workspace (team) where the time entry is located. This is an integer value.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "timer_id", + "required": true, + "description": "The unique identifier of the time entry to be updated.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "timer_id" + }, + { + "name": "time_entry_details", + "required": true, + "description": "Details for updating the time entry, including description, tags, start, end times, and other attributes.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "Users on the Business Plan and above can include a time tracking label." + }, + "tag_action": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When providing `start`, you must also provide `end`." + }, + "end": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When providing `end`, you must also provide `start`." + }, + "tid": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "billable": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "duration": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "Accessible tag actions are `[\"replace\", \"add\", \"remove\"]`" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference tasks by custom task IDs instead of standard IDs.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'UpdateatimeEntry'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/time_entries/{timer_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by it's custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by it's custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "team_identifier", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "team_identifier", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "timer_id", + "tool_parameter_name": "timer_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "time_entry_details", + "description": "Accessible tag actions are `[\"replace\", \"add\", \"remove\"]`", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "description": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "tags": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "Users on the Business Plan and above can include a time tracking label." + }, + "tag_action": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "start": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When providing `start`, you must also provide `end`." + }, + "end": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When providing `end`, you must also provide `start`." + }, + "tid": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "billable": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "duration": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "Accessible tag actions are `[\"replace\", \"add\", \"remove\"]`" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"Accessible tag actions are `[\\\"replace\\\", \\\"add\\\", \\\"remove\\\"]`\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateatimeEntryrequest\",\n \"required\": [\n \"tags\",\n \"tid\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\"\n },\n \"tags\": {\n \"description\": \"Users on the Business Plan and above can include a time tracking label.\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Schema reference broken: #/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items\",\n \"additionalProperties\": true,\n \"x-moar-broken-reference\": \"#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items\"\n }\n },\n \"tag_action\": {\n \"type\": \"string\"\n },\n \"start\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\",\n \"description\": \"When providing `start`, you must also provide `end`.\"\n },\n \"end\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int64\",\n \"description\": \"When providing `end`, you must also provide `start`.\"\n },\n \"tid\": {\n \"type\": \"string\"\n },\n \"billable\": {\n \"type\": \"boolean\"\n },\n \"duration\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"description\": \"\",\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ],\n \"tag_action\": \"add\",\n \"start\": 1595289395842,\n \"end\": 1595289495842,\n \"tid\": \"task_id\",\n \"billable\": true,\n \"duration\": 100000\n }\n ]\n },\n \"example\": {\n \"description\": \"\",\n \"tags\": [\n {\n \"name\": \"name of tag\",\n \"tag_bg\": \"#BF55EC\",\n \"tag_fg\": \"#FFFFFF\"\n }\n ],\n \"tag_action\": \"add\",\n \"start\": 1595289395842,\n \"end\": 1595289495842,\n \"tid\": \"task_id\",\n \"billable\": true,\n \"duration\": 100000\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateUserGroup.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateUserGroup.json new file mode 100644 index 00000000..8ec93d13 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateUserGroup.json @@ -0,0 +1,237 @@ +{ + "name": "UpdateUserGroup", + "fully_qualified_name": "ClickupApi.UpdateUserGroup@0.1.0", + "description": "Update and manage user groups within a ClickUp Workspace.\n\nUse this tool to update user groups in your ClickUp Workspace. Useful for managing team membership, permissions, or configurations. Note that adding a guest with view-only permissions will incur additional charges as they convert to paid guests.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "user_group_id", + "required": true, + "description": "The unique identifier of the User Group within the Workspace. This ID is required to specify which group to update.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "User Group ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "group_id" + }, + { + "name": "user_group_name", + "required": false, + "description": "The new name for the User Group within the ClickUp Workspace. This should be a string representing the desired name.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "name" + }, + { + "name": "handle_identifier", + "required": false, + "description": "A unique identifier or handle for the User Group. This is used to reference the group within ClickUp.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "handle" + }, + { + "name": "add_member_ids", + "required": false, + "description": "An array of user IDs to add to the User Group. Each ID should be an integer.", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "members.add" + }, + { + "name": "remove_members_ids", + "required": false, + "description": "An array of integer IDs representing the users to be removed from the User Group.", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "members.rem" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'UpdateTeam'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/group/{group_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "group_id", + "tool_parameter_name": "user_group_id", + "description": "User Group ID", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "User Group ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "name", + "tool_parameter_name": "user_group_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "handle", + "tool_parameter_name": "handle_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "members.add", + "tool_parameter_name": "add_member_ids", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "members.rem", + "tool_parameter_name": "remove_members_ids", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "integer", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"The group handle can be updated, which is used to @mention a User Group within the Workspace.\\\\\\n \\\\\\nModify Group members by using the \\\"add\\\" and \\\"rem\\\" parameters with an array of user IDs to include or exclude members.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateTeamrequest\",\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"handle\": {\n \"type\": \"string\"\n },\n \"members\": {\n \"title\": \"Members2\",\n \"required\": [\n \"add\",\n \"rem\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"add\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n },\n \"rem\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"description\": \"\"\n }\n },\n \"examples\": [\n {\n \"add\": [\n 123456,\n 987654\n ],\n \"rem\": [\n 159753\n ]\n }\n ]\n }\n },\n \"examples\": [\n {\n \"name\": \"New User Group Name\",\n \"handle\": \"newusergroupname\",\n \"members\": {\n \"add\": [\n 123456,\n 987654\n ],\n \"rem\": [\n 159753\n ]\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New User Group Name\",\n \"handle\": \"newusergroupname\",\n \"members\": {\n \"add\": [\n 123456,\n 987654\n ],\n \"rem\": [\n 159753\n ]\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateUserWorkspaceDetails.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateUserWorkspaceDetails.json new file mode 100644 index 00000000..7bd2b4b2 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateUserWorkspaceDetails.json @@ -0,0 +1,237 @@ +{ + "name": "UpdateUserWorkspaceDetails", + "fully_qualified_name": "ClickupApi.UpdateUserWorkspaceDetails@0.1.0", + "description": "Update a user's name and role in a ClickUp workspace.\n\nThis tool updates a user's name and role within a specific ClickUp workspace. It's only available to Workspaces on the Enterprise Plan. Use it to change user details in a team.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the ClickUp workspace where the user's details will be updated.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "user_identifier", + "required": true, + "description": "The unique identifier for the user within the workspace. This value is required to specify which user's details need updating.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "user_id" + }, + { + "name": "user_name", + "required": true, + "description": "The new full name of the user to be updated in the ClickUp workspace.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "username" + }, + { + "name": "custom_role_id", + "required": true, + "description": "An integer representing the custom role ID to assign to the user in the workspace. This is required for users with specific roles.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_role_id" + }, + { + "name": "assign_admin_role", + "required": true, + "description": "Set to true to assign the user as an admin in the workspace, otherwise false.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "admin" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'EditUserOnWorkspace'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/user/{user_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "user_id", + "tool_parameter_name": "user_identifier", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "username", + "tool_parameter_name": "user_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "admin", + "tool_parameter_name": "assign_admin_role", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_role_id", + "tool_parameter_name": "custom_role_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"EditUserOnWorkspacerequest\",\n \"required\": [\n \"username\",\n \"admin\",\n \"custom_role_id\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"username\": {\n \"type\": \"string\"\n },\n \"admin\": {\n \"type\": \"boolean\"\n },\n \"custom_role_id\": {\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"username\": \"User Name\",\n \"admin\": false,\n \"custom_role_id\": 998877\n }\n ]\n },\n \"example\": {\n \"username\": \"User Name\",\n \"admin\": false,\n \"custom_role_id\": 998877\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateViewSettings.json b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateViewSettings.json new file mode 100644 index 00000000..d49b66fc --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/UpdateViewSettings.json @@ -0,0 +1,764 @@ +{ + "name": "UpdateViewSettings", + "fully_qualified_name": "ClickupApi.UpdateViewSettings@0.1.0", + "description": "Update the settings and configuration of a view.\n\nRename, regroup, sort, filter, and modify columns and settings of a view when needing to adjust its configuration.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "view_identifier", + "required": true, + "description": "The unique identifier for the view to be updated.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "view_id" + }, + { + "name": "view_configuration_details", + "required": true, + "description": "JSON object detailing the view's name, type, location, grouping, sorting, filters, columns, team sidebar, and other settings.", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "parent": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "id": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The id of the Workspace, Space, Folder, or List where the view is located." + }, + "type": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The level of the Hierarchy where the view is created. \\\n \\\nOptions include: \\\n \\\nWorkspace (Everything Level): `7` \\\n \\\nSpace: `4` \\\n \\\nFolder: `5` \\\n \\\nList: `6`" + } + }, + "inner_properties": null, + "description": "The parent parameter specifies where the view is located in the ClickUp Hierarchy. Both `id` and `type` are required. \\\n \\\nThe `id` is the id of the Workspace, Space, Folder, or List where the view is located. \\\n \\\nThe `type` value indciates the level of the Hierarchy where the view is located." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "field": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`." + }, + "dir": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view." + }, + "collapsed": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "ignore": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "field": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "dir": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "collapsed": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "fields": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views)." + } + }, + "inner_properties": null, + "description": null + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "op": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The available operator (`op``) values are `AND`` and `OR``." + }, + "fields": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "View the list of [fields available](doc:filter-views) to filter by." + }, + "search": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_closed": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "fields": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`" + } + }, + "inner_properties": null, + "description": "Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy." + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "assignees": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "assigned_comments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "unassigned_tasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "show_task_locations": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_subtasks": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed." + }, + "show_subtask_parent_names": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_closed_subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_images": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "collapse_empty_columns": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "me_comments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "me_subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "me_checklists": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'UpdateView'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/view/{view_id}", + "http_method": "PUT", + "headers": {}, + "parameters": [ + { + "name": "view_id", + "tool_parameter_name": "view_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "view_configuration_details", + "description": "", + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "name": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "type": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "parent": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "id": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The id of the Workspace, Space, Folder, or List where the view is located." + }, + "type": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The level of the Hierarchy where the view is created. \\\n \\\nOptions include: \\\n \\\nWorkspace (Everything Level): `7` \\\n \\\nSpace: `4` \\\n \\\nFolder: `5` \\\n \\\nList: `6`" + } + }, + "inner_properties": null, + "description": "The parent parameter specifies where the view is located in the ClickUp Hierarchy. Both `id` and `type` are required. \\\n \\\nThe `id` is the id of the Workspace, Space, Folder, or List where the view is located. \\\n \\\nThe `type` value indciates the level of the Hierarchy where the view is located." + }, + "grouping": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "field": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`." + }, + "dir": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view." + }, + "collapsed": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "ignore": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "divide": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "field": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "dir": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "collapsed": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "sorting": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "fields": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views)." + } + }, + "inner_properties": null, + "description": null + }, + "filters": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "op": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The available operator (`op``) values are `AND`` and `OR``." + }, + "fields": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "View the list of [fields available](doc:filter-views) to filter by." + }, + "search": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_closed": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "columns": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "fields": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`" + } + }, + "inner_properties": null, + "description": "Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy." + }, + "team_sidebar": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "assignees": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "assigned_comments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "unassigned_tasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + }, + "settings": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": { + "show_task_locations": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_subtasks": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed." + }, + "show_subtask_parent_names": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_closed_subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_assignees": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "show_images": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "collapse_empty_columns": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "me_comments": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "me_subtasks": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + }, + "me_checklists": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": null + } + }, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": "{\n \"description\": \"\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"title\": \"UpdateViewrequest\",\n \"required\": [\n \"name\",\n \"type\",\n \"parent\",\n \"grouping\",\n \"divide\",\n \"sorting\",\n \"filters\",\n \"columns\",\n \"team_sidebar\",\n \"settings\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"parent\": {\n \"title\": \"Parent\",\n \"description\": \"The parent parameter specifies where the view is located in the ClickUp Hierarchy. Both `id` and `type` are required. \\\\\\n \\\\\\nThe `id` is the id of the Workspace, Space, Folder, or List where the view is located. \\\\\\n \\\\\\nThe `type` value indciates the level of the Hierarchy where the view is located.\",\n \"required\": [\n \"id\",\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"The id of the Workspace, Space, Folder, or List where the view is located.\"\n },\n \"type\": {\n \"type\": \"integer\",\n \"description\": \"The level of the Hierarchy where the view is created. \\\\\\n \\\\\\nOptions include: \\\\\\n \\\\\\nWorkspace (Everything Level): `7` \\\\\\n \\\\\\nSpace: `4` \\\\\\n \\\\\\nFolder: `5` \\\\\\n \\\\\\nList: `6`\",\n \"contentEncoding\": \"int32\"\n }\n },\n \"examples\": [\n {\n \"id\": \"512\",\n \"type\": 7\n }\n ]\n },\n \"grouping\": {\n \"title\": \"Grouping\",\n \"required\": [\n \"field\",\n \"dir\",\n \"collapsed\",\n \"ignore\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"field\": {\n \"type\": \"string\",\n \"description\": \"Set the field to group by.\\\\\\n \\\\\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`.\"\n },\n \"dir\": {\n \"description\": \"Set a group sort order using `1` or `-1`.\\\\\\n \\\\\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\\\\n \\\\\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"collapsed\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"\"\n },\n \"ignore\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n }\n ]\n },\n \"divide\": {\n \"title\": \"Divide\",\n \"required\": [\n \"collapsed\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"field\": {\n \"type\": [\n \"null\"\n ]\n },\n \"dir\": {\n \"type\": [\n \"null\"\n ]\n },\n \"collapsed\": {\n \"type\": [\n \"boolean\"\n ]\n }\n },\n \"examples\": [\n {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n }\n ]\n },\n \"sorting\": {\n \"title\": \"Sorting\",\n \"required\": [\n \"fields\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"fields\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"Include an array of fields to sort by.\\\\\\n \\\\\\n You can sort by the same fields available when [filtering a view](doc:filter-views).\"\n }\n },\n \"examples\": [\n {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n }\n ]\n },\n \"filters\": {\n \"title\": \"Filters\",\n \"required\": [\n \"op\",\n \"fields\",\n \"search\",\n \"show_closed\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"op\": {\n \"type\": \"string\",\n \"description\": \"The available operator (`op``) values are `AND`` and `OR``.\"\n },\n \"fields\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"View the list of [fields available](doc:filter-views) to filter by.\"\n },\n \"search\": {\n \"type\": \"string\"\n },\n \"show_closed\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n }\n ]\n },\n \"columns\": {\n \"title\": \"Columns\",\n \"description\": \"Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy.\",\n \"required\": [\n \"fields\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"fields\": {\n \"description\": \"Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"examples\": [\n {\n \"fields\": []\n }\n ]\n },\n \"team_sidebar\": {\n \"title\": \"TeamSidebar\",\n \"required\": [\n \"assignees\",\n \"assigned_comments\",\n \"unassigned_tasks\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"assignees\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"\"\n },\n \"assigned_comments\": {\n \"type\": \"boolean\"\n },\n \"unassigned_tasks\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n }\n ]\n },\n \"settings\": {\n \"title\": \"Settings\",\n \"required\": [\n \"show_task_locations\",\n \"show_subtasks\",\n \"show_subtask_parent_names\",\n \"show_closed_subtasks\",\n \"show_assignees\",\n \"show_images\",\n \"collapse_empty_columns\",\n \"me_comments\",\n \"me_subtasks\",\n \"me_checklists\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"show_task_locations\": {\n \"type\": \"boolean\"\n },\n \"show_subtasks\": {\n \"description\": \"Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.\",\n \"type\": \"integer\",\n \"contentEncoding\": \"int32\"\n },\n \"show_subtask_parent_names\": {\n \"type\": \"boolean\"\n },\n \"show_closed_subtasks\": {\n \"type\": \"boolean\"\n },\n \"show_assignees\": {\n \"type\": \"boolean\"\n },\n \"show_images\": {\n \"type\": \"boolean\"\n },\n \"collapse_empty_columns\": {\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"me_comments\": {\n \"type\": \"boolean\"\n },\n \"me_subtasks\": {\n \"type\": \"boolean\"\n },\n \"me_checklists\": {\n \"type\": \"boolean\"\n }\n },\n \"examples\": [\n {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n ]\n }\n },\n \"examples\": [\n {\n \"name\": \"New View Name\",\n \"type\": \"list\",\n \"parent\": {\n \"id\": \"512\",\n \"type\": 7\n },\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": []\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": []\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n ]\n },\n \"example\": {\n \"name\": \"New View Name\",\n \"type\": \"list\",\n \"parent\": {\n \"id\": \"512\",\n \"type\": 7\n },\n \"grouping\": {\n \"field\": \"status\",\n \"dir\": 1,\n \"collapsed\": [],\n \"ignore\": false\n },\n \"divide\": {\n \"field\": null,\n \"dir\": null,\n \"collapsed\": []\n },\n \"sorting\": {\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"dir\": -1,\n \"idx\": 0\n }\n ]\n },\n \"filters\": {\n \"op\": \"AND\",\n \"fields\": [\n {\n \"field\": \"cf_624a423a-c1d1-4467-99e2-63e225658cb2\",\n \"op\": \"EQ\",\n \"determinor\": null,\n \"idx\": 0,\n \"values\": \"123\"\n }\n ],\n \"search\": \"\",\n \"show_closed\": false\n },\n \"columns\": {\n \"fields\": [\n {\n \"field\": \"assignee\",\n \"idx\": 0,\n \"width\": 160,\n \"hidden\": true,\n \"name\": null,\n \"display\": null\n }\n ]\n },\n \"team_sidebar\": {\n \"assignees\": [],\n \"assigned_comments\": false,\n \"unassigned_tasks\": false\n },\n \"settings\": {\n \"show_task_locations\": false,\n \"show_subtasks\": 3,\n \"show_subtask_parent_names\": false,\n \"show_closed_subtasks\": false,\n \"show_assignees\": true,\n \"show_images\": true,\n \"collapse_empty_columns\": null,\n \"me_comments\": true,\n \"me_subtasks\": true,\n \"me_checklists\": true\n }\n }\n }\n },\n \"required\": true\n}", + "use_request_body_schema_mode": true, + "validate_request_body_schema": true + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewChatComments.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewChatComments.json new file mode 100644 index 00000000..65b3f8c8 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewChatComments.json @@ -0,0 +1,171 @@ +{ + "name": "ViewChatComments", + "fully_qualified_name": "ClickupApi.ViewChatComments@0.1.0", + "description": "Retrieve the most recent comments from a Chat view.\n\nThis tool fetches comments from a Chat view in ClickUp. It returns the 25 most recent comments if no parameters are provided. To access older comments, use `start` and `start_id` parameters.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "chat_view_id", + "required": true, + "description": "The unique identifier for the Chat view to retrieve comments from. It should be a string, typically '105'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "view_id" + }, + { + "name": "comment_start_date_unix_ms", + "required": false, + "description": "The start date of a Chat view comment in Unix time (milliseconds) to fetch older comments.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the `date` of a Chat view comment using Unix time in milliseconds." + }, + "inferrable": true, + "http_endpoint_parameter_name": "start" + }, + { + "name": "start_comment_id", + "required": false, + "description": "The comment ID to start retrieving older comments from in the Chat view. Use this to fetch comments beyond the most recent 25.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the Comment `id` of a Chat view comment." + }, + "inferrable": true, + "http_endpoint_parameter_name": "start_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetChatViewComments'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/view/{view_id}/comment", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "start", + "tool_parameter_name": "comment_start_date_unix_ms", + "description": "Enter the `date` of a Chat view comment using Unix time in milliseconds.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the `date` of a Chat view comment using Unix time in milliseconds." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "start_id", + "tool_parameter_name": "start_comment_id", + "description": "Enter the Comment `id` of a Chat view comment.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Enter the Comment `id` of a Chat view comment." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "view_id", + "tool_parameter_name": "chat_view_id", + "description": "105 (string)", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "105 (string)" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewFolderLists.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewFolderLists.json new file mode 100644 index 00000000..2356d641 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewFolderLists.json @@ -0,0 +1,105 @@ +{ + "name": "ViewFolderLists", + "fully_qualified_name": "ClickupApi.ViewFolderLists@0.1.0", + "description": "Retrieve lists contained in a specified folder.\n\nCall this tool to access all the lists that are organized under a specific folder in ClickUp by providing the folder ID.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "folder_id", + "required": true, + "description": "The unique identifier for the folder whose lists you want to retrieve. This must be an integer.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetFolder'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/folder/{folder_id}", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "folder_id", + "tool_parameter_name": "folder_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewListCustomFields.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewListCustomFields.json new file mode 100644 index 00000000..f408c06f --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewListCustomFields.json @@ -0,0 +1,138 @@ +{ + "name": "ViewListCustomFields", + "fully_qualified_name": "ClickupApi.ViewListCustomFields@0.1.0", + "description": "Retrieve accessible custom fields for a specific list.\n\nUse this tool to view the custom fields you have access to in a specific list. This is useful for understanding which custom fields are available for use or modification in your lists.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "list_id", + "required": true, + "description": "The unique identifier of the list to retrieve accessible custom fields for.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + }, + { + "name": "content_type", + "required": true, + "description": "The MIME type of the request body, typically set to 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetAccessibleCustomFields'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}/field", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "list_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewListDetails.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewListDetails.json new file mode 100644 index 00000000..48ff14f2 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewListDetails.json @@ -0,0 +1,105 @@ +{ + "name": "ViewListDetails", + "fully_qualified_name": "ClickupApi.ViewListDetails@0.1.0", + "description": "Retrieve details of a specific list in ClickUp.\n\nUse this tool to get detailed information about a specific list in ClickUp by providing the list ID. It helps in obtaining metadata and current status of the list.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "list_id", + "required": true, + "description": "The unique ID of the list to view details. Right-click the list in your ClickUp sidebar, select 'Copy link', and paste the URL's last string.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The List ID. To find the List ID, right-click the List in your Sidebar, select Copy link, and paste the link in your URL. The last string in the URL is your List ID." + }, + "inferrable": true, + "http_endpoint_parameter_name": "list_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetList'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/list/{list_id}", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "list_id", + "tool_parameter_name": "list_id", + "description": "The List ID. To find the List ID, right-click the List in your Sidebar, select Copy link, and paste the link in your URL. The last string in the URL is your List ID.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The List ID. To find the List ID, right-click the List in your Sidebar, select Copy link, and paste the link in your URL. The last string in the URL is your List ID." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewListsInFolder.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewListsInFolder.json new file mode 100644 index 00000000..d78bd7d5 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewListsInFolder.json @@ -0,0 +1,138 @@ +{ + "name": "ViewListsInFolder", + "fully_qualified_name": "ClickupApi.ViewListsInFolder@0.1.0", + "description": "Retrieve lists from a specific folder.\n\nUse this tool to view all the lists contained within a specified folder by providing the folder ID. It should be called when you need to access or manage lists within a folder within ClickUp.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "folder_id", + "required": true, + "description": "The unique identifier for the folder whose lists are to be retrieved. This is required to specify which folder's lists to view.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "folder_id" + }, + { + "name": "include_archived_lists", + "required": false, + "description": "Specify whether to include archived lists. Set to true to include and false to exclude.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "archived" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetLists'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/folder/{folder_id}/list", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "archived", + "tool_parameter_name": "include_archived_lists", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "folder_id", + "tool_parameter_name": "folder_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewSharedHierarchy.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewSharedHierarchy.json new file mode 100644 index 00000000..8cec3053 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewSharedHierarchy.json @@ -0,0 +1,105 @@ +{ + "name": "ViewSharedHierarchy", + "fully_qualified_name": "ClickupApi.ViewSharedHierarchy@0.1.0", + "description": "View shared tasks, lists, and folders.\n\nUse this tool to view tasks, lists, and folders shared with the authenticated user in a specified team.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The Workspace ID to view shared tasks, lists, and folders.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'SharedHierarchy'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/shared", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskDetails.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskDetails.json new file mode 100644 index 00000000..f746f591 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskDetails.json @@ -0,0 +1,270 @@ +{ + "name": "ViewTaskDetails", + "fully_qualified_name": "ClickupApi.ViewTaskDetails@0.1.0", + "description": "Retrieve detailed information about a specific task.\n\nUse this tool to get detailed information on a task you have access to in ClickUp, including any attachments associated with the task.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "task_identifier", + "required": true, + "description": "The unique identifier for the task you want to retrieve details for in ClickUp.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "task_id" + }, + { + "name": "workspace_id_for_custom_task", + "required": false, + "description": "Provide the Workspace ID when referencing a task by its custom task ID. Required if `custom_task_ids` is true.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "filter_custom_fields", + "required": false, + "description": "Include tasks with specific values in one or more custom fields using the specified JSON format. Custom Relationships are supported.", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:filtertasks)" + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_fields" + }, + { + "name": "use_custom_task_ids", + "required": false, + "description": "Set to true to reference a task by its custom task ID.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its custom task id, this value must be `true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "custom_task_ids" + }, + { + "name": "include_subtasks", + "required": false, + "description": "Include subtasks in the task details if set to true. Defaults to false.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include subtasks, default false" + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_subtasks" + }, + { + "name": "include_markdown_description", + "required": false, + "description": "Set to true to return task descriptions in Markdown format.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_markdown_description" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetTask'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/task/{task_id}", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "custom_task_ids", + "tool_parameter_name": "use_custom_task_ids", + "description": "If you want to reference a task by its custom task id, this value must be `true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "If you want to reference a task by its custom task id, this value must be `true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id_for_custom_task", + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_subtasks", + "tool_parameter_name": "include_subtasks", + "description": "Include subtasks, default false", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include subtasks, default false" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_markdown_description", + "tool_parameter_name": "include_markdown_description", + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "custom_fields", + "tool_parameter_name": "filter_custom_fields", + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:filtertasks)", + "value_schema": { + "val_type": "array", + "inner_val_type": "string", + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"<\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:filtertasks)" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "task_id", + "tool_parameter_name": "task_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskOrPageInfo.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskOrPageInfo.json new file mode 100644 index 00000000..c53fabb6 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskOrPageInfo.json @@ -0,0 +1,105 @@ +{ + "name": "ViewTaskOrPageInfo", + "fully_qualified_name": "ClickupApi.ViewTaskOrPageInfo@0.1.0", + "description": "Retrieve details of a specific task or page view.\n\nUse this tool to get detailed information about a specific task or page view in ClickUp using the view ID.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "view_identifier", + "required": true, + "description": "A unique identifier for the specific task or page view in ClickUp to be retrieved. This is required to obtain the relevant information.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "view_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetView'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/view/{view_id}", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "view_id", + "tool_parameter_name": "view_identifier", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskTemplates.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskTemplates.json new file mode 100644 index 00000000..7cc55889 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTaskTemplates.json @@ -0,0 +1,171 @@ +{ + "name": "ViewTaskTemplates", + "fully_qualified_name": "ClickupApi.ViewTaskTemplates@0.1.0", + "description": "View available task templates in a workspace.\n\nRetrieve a list of task templates available for a specified workspace in ClickUp. Use this tool to explore task templates and plan tasks efficiently.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "page_number", + "required": true, + "description": "The page number of results to retrieve. Used for pagination.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "page" + }, + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace for which to retrieve task templates. This is used to specify the target workspace in ClickUp.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "content_type_header", + "required": true, + "description": "Sets the 'Content-Type' for the API request, typically 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetTaskTemplates'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/taskTemplate", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "page", + "tool_parameter_name": "page_number", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "query", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewThreadedComments.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewThreadedComments.json new file mode 100644 index 00000000..190c59fa --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewThreadedComments.json @@ -0,0 +1,105 @@ +{ + "name": "ViewThreadedComments", + "fully_qualified_name": "ClickupApi.ViewThreadedComments@0.1.0", + "description": "Retrieve threaded replies to a comment.\n\nThis tool allows for the retrieval of threaded comments in a ClickUp task, excluding the parent comment. Use this tool to view discussions or replies linked to a specific comment by providing the comment ID.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "thread_comment_id", + "required": true, + "description": "The ID of the comment for which threaded replies are to be retrieved. This ID should be an integer and corresponds to the comment in a ClickUp task whose replies you want to view.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "comment_id" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetThreadedComments'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/comment/{comment_id}/reply", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "comment_id", + "tool_parameter_name": "thread_comment_id", + "description": "", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTimeEntry.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTimeEntry.json new file mode 100644 index 00000000..34e13bf7 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTimeEntry.json @@ -0,0 +1,303 @@ +{ + "name": "ViewTimeEntry", + "fully_qualified_name": "ClickupApi.ViewTimeEntry@0.1.0", + "description": "Retrieve details of a specific time entry.\n\nUse this tool to view information about a single time entry, including its duration. If the duration is negative, it indicates an active timer for the user.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace (team) to which the time entry belongs.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "time_entry_id", + "required": true, + "description": "The ID of a specific time entry, which can be found using the Get Time Entries Within a Date Range endpoint.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint." + }, + "inferrable": true, + "http_endpoint_parameter_name": "timer_id" + }, + { + "name": "content_type", + "required": true, + "description": "Specifies the format of the content being sent or received, such as 'application/json'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + }, + { + "name": "include_task_tags", + "required": false, + "description": "Set to true to include task tags in the response.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include task tags in the response for time entries associated with tasks." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_task_tags" + }, + { + "name": "include_location_names", + "required": false, + "description": "Include names of the List, Folder, and Space in the response along with their respective IDs.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_location_names" + }, + { + "name": "include_approval_history", + "required": false, + "description": "Include the approval history of the time entry in the response. Set to true to include.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the history of the approval for the time entry." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_approval_history" + }, + { + "name": "include_approval_details", + "required": false, + "description": "Include the details of the approval for the time entry when true.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the details of the approval for the time entry." + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_approval_details" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Getsingulartimeentry'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/time_entries/{timer_id}", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "include_task_tags", + "tool_parameter_name": "include_task_tags", + "description": "Include task tags in the response for time entries associated with tasks.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include task tags in the response for time entries associated with tasks." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_location_names", + "tool_parameter_name": "include_location_names", + "description": "Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_approval_history", + "tool_parameter_name": "include_approval_history", + "description": "Include the history of the approval for the time entry.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the history of the approval for the time entry." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "include_approval_details", + "tool_parameter_name": "include_approval_details", + "description": "Include the details of the approval for the time entry.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Include the details of the approval for the time entry." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "timer_id", + "tool_parameter_name": "time_entry_id", + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTimeEntryChanges.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTimeEntryChanges.json new file mode 100644 index 00000000..db329016 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewTimeEntryChanges.json @@ -0,0 +1,171 @@ +{ + "name": "ViewTimeEntryChanges", + "fully_qualified_name": "ClickupApi.ViewTimeEntryChanges@0.1.0", + "description": "View a list of changes made to a time entry.\n\nUse this tool to access the history of modifications for a specific time entry within a team in ClickUp. It provides insights into various changes made on the entry, such as updates or edits.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the workspace (team) where the time entry resides.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "time_entry_id", + "required": true, + "description": "The ID of a time entry. This ID can be obtained using the Get Time Entries Within a Date Range endpoint.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint." + }, + "inferrable": true, + "http_endpoint_parameter_name": "timer_id" + }, + { + "name": "content_type_header", + "required": true, + "description": "The media type for the request, typically 'application/json'. Required for HTTP headers.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'Gettimeentryhistory'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/time_entries/{timer_id}/history", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "timer_id", + "tool_parameter_name": "time_entry_id", + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewWorkspaceCustomFields.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewWorkspaceCustomFields.json new file mode 100644 index 00000000..4ccae2b9 --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewWorkspaceCustomFields.json @@ -0,0 +1,138 @@ +{ + "name": "ViewWorkspaceCustomFields", + "fully_qualified_name": "ClickupApi.ViewWorkspaceCustomFields@0.1.0", + "description": "Retrieve Workspace-level Custom Fields in ClickUp.\n\nUse this tool to view custom fields accessible at the workspace level in ClickUp. It doesn't include fields from Space, Folder, or List levels.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The ID of the Workspace to retrieve custom fields for. This identifies which Workspace's fields you want to view.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "content_type_header", + "required": true, + "description": "The MIME type of the content. Typically set to 'application/json' for JSON data.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "Content-Type" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'getTeamAvailableFields'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/field", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "Content-Type", + "tool_parameter_name": "content_type_header", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "header", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/clickup_api/wrapper_tools/ViewWorkspaceGoals.json b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewWorkspaceGoals.json new file mode 100644 index 00000000..a176ac1f --- /dev/null +++ b/toolkits/clickup_api/clickup_api/wrapper_tools/ViewWorkspaceGoals.json @@ -0,0 +1,138 @@ +{ + "name": "ViewWorkspaceGoals", + "fully_qualified_name": "ClickupApi.ViewWorkspaceGoals@0.1.0", + "description": "View the Goals available in a Workspace.\n\nThis tool retrieves the goals available in a specific workspace on ClickUp. It should be used when you need to access or display information about the goals associated with a given workspace.", + "toolkit": { + "name": "ClickupApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "workspace_id", + "required": true, + "description": "The unique identifier for the workspace to view its goals.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "inferrable": true, + "http_endpoint_parameter_name": "team_id" + }, + { + "name": "include_completed_goals", + "required": false, + "description": "Indicate whether to include completed goals in the results. Set to true to include completed goals, or false to exclude them.", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "include_completed" + } + ] + }, + "output": { + "description": "Response from the API endpoint 'GetGoals'.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": { + "provider_id": "arcade-clickup", + "provider_type": "oauth2", + "id": null, + "oauth2": null + }, + "secrets": null, + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the clickup API." + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://api.clickup.com/api/v2/team/{team_id}/goal", + "http_method": "GET", + "headers": {}, + "parameters": [ + { + "name": "include_completed", + "tool_parameter_name": "include_completed_goals", + "description": "", + "value_schema": { + "val_type": "boolean", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "team_id", + "tool_parameter_name": "workspace_id", + "description": "Workspace ID", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Workspace ID" + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "auth_token", + "parameter_name": "Authorization", + "accepted_as": "header", + "formatted_value": "Bearer {authorization}", + "description": "The OAuth token to use for authentication.", + "is_auth_token": true + } + ], + "request_body_spec": null, + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/toolkits/clickup_api/pyproject.toml b/toolkits/clickup_api/pyproject.toml new file mode 100644 index 00000000..3c6b24a5 --- /dev/null +++ b/toolkits/clickup_api/pyproject.toml @@ -0,0 +1,60 @@ +[build-system] +requires = [ "hatchling",] +build-backend = "hatchling.build" + +[project] +name = "clickup_api" +version = "0.1.0" +description = "Tools that enable LLMs to interact directly with the clickup API." +requires-python = ">=3.10" +dependencies = [ + "arcade-tdk>=3.0.0,<4.0.0", + "httpx[http2]>=0.27.2,<1.0.0", + "jsonschema>=4.0.0,<5.0.0", +] +[[project.authors]] +email = "support@arcade.dev" + +[project.optional-dependencies] +dev = [ + "arcade-mcp[all]>=1.2.0,<2.0.0", + "arcade-serve>=3.0.0,<4.0.0", + "pytest>=8.3.0,<8.4.0", + "pytest-cov>=4.0.0,<4.1.0", + "pytest-mock>=3.11.1,<3.12.0", + "pytest-asyncio>=0.24.0,<0.25.0", + "mypy>=1.5.1,<1.6.0", + "pre-commit>=3.4.0,<3.5.0", + "tox>=4.11.1,<4.12.0", + "ruff>=0.7.4,<0.8.0", +] + + +# Tell Arcade.dev that this package is a toolkit +[project.entry-points.arcade_toolkits] +toolkit_name = "clickup_api" +# Use local path sources for arcade libs when working locally +[tool.uv.sources] +arcade-mcp = { path = "../../", editable = true } +arcade-serve = { path = "../../libs/arcade-serve/", editable = true } +arcade-tdk = { path = "../../libs/arcade-tdk/", editable = true } +[tool.mypy] +files = [ "clickup_api/**/*.py",] +python_version = "3.10" +disallow_untyped_defs = "True" +disallow_any_unimported = "True" +no_implicit_optional = "True" +check_untyped_defs = "True" +warn_return_any = "True" +warn_unused_ignores = "True" +show_error_codes = "True" +ignore_missing_imports = "True" + +[tool.pytest.ini_options] +testpaths = [ "tests",] + +[tool.coverage.report] +skip_empty = true + +[tool.hatch.build.targets.wheel] +packages = [ "clickup_api",] diff --git a/toolkits/clickup_api/tests/__init__.py b/toolkits/clickup_api/tests/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/toolkits/pylon_api/pyproject.toml b/toolkits/pylon_api/pyproject.toml index e224e100..cb26a38a 100644 --- a/toolkits/pylon_api/pyproject.toml +++ b/toolkits/pylon_api/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "pylon_api" -version = "0.1.0" +version = "0.1.1" description = "Tools that enable LLMs to interact directly with the pylon API." requires-python = ">=3.10" dependencies = [