ClickUp tools
Look up the six ClickUp tools, selectors, permissions, and inputs available to tool steps and agent steps.
This reference lists the six shipped ClickUp tools. See the ClickUp overview for authentication and access boundaries.
Permissions
ClickUp tools can access only what the connected account can access.
Shipfox searches only the workspace you selected during setup. A workflow can still update a task in another workspace when it supplies that task's ID and the connected account has access.
Read the task from an event
ClickUp events contain a task ID instead of the complete task. Add this fragment
under an existing job's steps list to fetch the current task:
- key: task
tool: get_task
connection: clickup_acme # Replace with your ClickUp integration connection slug.
with:
task_id: ${{ event.task_id }}The get_task result becomes available as steps.task.outputs.result.
Tool catalog
Tools
get_taskRetrieve a ClickUp task by ID. Set custom_task_id to true for a custom task ID. Dates use Unix milliseconds.
readParameters
task_idstringRequiredClickUp task ID or custom task ID
custom_task_idbooleanAddress the task with its custom task ID
include_subtasksbooleanInclude subtasks in the response
search_tasksFilter ClickUp tasks by List, status, assignee, tag, or date. This is a filtered list, not full-text search.
readParameters
list_idsarray of stringspace_idsarray of stringfolder_idsarray of stringstatusesarray of stringassigneesarray of integertagsarray of stringinclude_closedbooleanInclude closed tasks
subtasksbooleanInclude subtasks
date_updated_gtintegerUnix timestamp in milliseconds
due_date_ltintegerUnix timestamp in milliseconds
order_bystringTask field used for ordering
pageintegerZero-based result page
List comments on a ClickUp task. Set custom_task_id to true for a custom task ID.
readParameters
task_idstringRequiredClickUp task ID or custom task ID
custom_task_idbooleanAddress the task with its custom task ID
startintegerComment pagination start timestamp
start_idstringComment ID for pagination
create_taskCreate a ClickUp task in a List. Priorities are 1 (urgent) to 4 (low), dates use Unix milliseconds, and notifications are disabled.
writeParameters
list_idstringRequiredClickUp List ID
namestringRequiredTask name
markdown_contentstringMarkdown task description
assigneesarray of integertagsarray of stringstatusstringTask status
priorityintegerPriority from 1 (urgent) to 4 (low)
due_dateintegerUnix timestamp in milliseconds
parentstringParent task ID
custom_fieldsarray of objectnotify_allconstant falseNotifications are disabled
update_taskUpdate a ClickUp task. Set custom_task_id to true for a custom task ID. Priorities are 1 (urgent) to 4 (low), and dates use Unix milliseconds.
writeParameters
task_idstringRequiredClickUp task ID or custom task ID
custom_task_idbooleanAddress the task with its custom task ID
namestringReplacement task name
markdown_contentstringReplacement Markdown task description
statusstringReplacement task status
priorityintegerPriority from 1 (urgent) to 4 (low)
due_dateintegerUnix timestamp in milliseconds
assigneesobjectAssignees to add or remove, with add and rem arrays
add_commentAdd a plain-text comment to a ClickUp task. Markdown is not rendered and notifications are disabled.
writeParameters
task_idstringRequiredClickUp task ID or custom task ID
custom_task_idbooleanAddress the task with its custom task ID
bodystringRequiredPlain-text comment body