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.
Selectors
A tool step names one standalone tool ID in its tool field. An agent step
lists standalone selectors in its integrations: block. For the field
contracts, see Tool step fields
and Agent integration fields.
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_task
Retrieve a ClickUp task by ID. Set custom_task_id to true for a custom task ID. Dates use Unix milliseconds.
Sensitivity: read.
Sensitive: No.
Required permissions: read
Selector tokens: get_task
Input
| Field | Type | Required | Description |
|---|---|---|---|
task_id | string | Required | ClickUp task ID or custom task ID |
custom_task_id | boolean | Optional | Address the task with its custom task ID |
include_subtasks | boolean | Optional | Include subtasks in the response |
search_tasks
Filter ClickUp tasks by List, status, assignee, tag, or date. This is a filtered list, not full-text search.
Sensitivity: read.
Sensitive: No.
Required permissions: read
Selector tokens: search_tasks
Input
| Field | Type | Required | Description |
|---|---|---|---|
list_ids | array | Optional | |
space_ids | array | Optional | |
folder_ids | array | Optional | |
statuses | array | Optional | |
assignees | array | Optional | |
tags | array | Optional | |
include_closed | boolean | Optional | Include closed tasks |
subtasks | boolean | Optional | Include subtasks |
date_updated_gt | integer | Optional | Unix timestamp in milliseconds |
due_date_lt | integer | Optional | Unix timestamp in milliseconds |
order_by | string | Optional | Task field used for ordering |
page | integer | Optional | Zero-based result page |
get_task_comments
List comments on a ClickUp task. Set custom_task_id to true for a custom task ID.
Sensitivity: read.
Sensitive: No.
Required permissions: read
Selector tokens: get_task_comments
Input
| Field | Type | Required | Description |
|---|---|---|---|
task_id | string | Required | ClickUp task ID or custom task ID |
custom_task_id | boolean | Optional | Address the task with its custom task ID |
start | integer | Optional | Comment pagination start timestamp |
start_id | string | Optional | Comment ID for pagination |
create_task
Create a ClickUp task in a List. Priorities are 1 (urgent) to 4 (low), dates use Unix milliseconds, and notifications are disabled.
Sensitivity: write.
Sensitive: No.
Required permissions: write
Selector tokens: create_task
Input
| Field | Type | Required | Description |
|---|---|---|---|
list_id | string | Required | ClickUp List ID |
name | string | Required | Task name |
markdown_content | string | Optional | Markdown task description |
assignees | array | Optional | |
tags | array | Optional | |
status | string | Optional | Task status |
priority | integer | Optional | Priority from 1 (urgent) to 4 (low) |
due_date | integer | Optional | Unix timestamp in milliseconds |
parent | string | Optional | Parent task ID |
custom_fields | array | Optional | |
notify_all | boolean | Optional | Notifications are disabled |
update_task
Update 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.
Sensitivity: write.
Sensitive: No.
Required permissions: write
Selector tokens: update_task
Input
| Field | Type | Required | Description |
|---|---|---|---|
task_id | string | Required | ClickUp task ID or custom task ID |
custom_task_id | boolean | Optional | Address the task with its custom task ID |
name | string | Optional | Replacement task name |
markdown_content | string | Optional | Replacement Markdown task description |
status | string | Optional | Replacement task status |
priority | integer | Optional | Priority from 1 (urgent) to 4 (low) |
due_date | integer | Optional | Unix timestamp in milliseconds |
assignees | object | Optional | Assignees to add or remove, with add and rem arrays |
add_comment
Add a plain-text comment to a ClickUp task. Markdown is not rendered and notifications are disabled.
Sensitivity: write.
Sensitive: No.
Required permissions: write
Selector tokens: add_comment
Input
| Field | Type | Required | Description |
|---|---|---|---|
task_id | string | Required | ClickUp task ID or custom task ID |
custom_task_id | boolean | Optional | Address the task with its custom task ID |
body | string | Required | Plain-text comment body |