/clickup-tasks | Type: Application | PCID required: Yes
Tools
clickup_tasks_add_dependency
Add Dependency Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | This is the task which is waiting on or blocking another task. |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
dependency_of | string | No | — | Dependency Of |
depends_on | string | No | — | Depends On |
clickup_tasks_add_tag_to_task
Add Tag To Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
tag_name | string | Yes | — | Tag Name |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
clickup_tasks_add_task_link
Add Task Link Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | The task to initiate the link from. |
links_to | string | Yes | — | The task to link to. |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
clickup_tasks_create_checklist
Create Checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
name | string | Yes | — | The name value |
clickup_tasks_create_checklist_item
Create Checklist Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
checklist_id | string | Yes | — | b8a8-48d8-a0c6-b4200788a683 (uuid) |
assignee | integer | No | — | The assignee value |
name | string | No | — | The name value |
clickup_tasks_create_space_tag
Create Space Tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
space_id | number | Yes | — | Space Id |
tag | object | Yes | — | The tag value |
clickup_tasks_create_task
Create Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | number | Yes | — | List Id |
archived | boolean | No | — | The archived value |
assignees | integer[] | No | — | The assignees value |
check_required_custom_fields | boolean | No | — | When creating a task via API any required Custom Fields are ignored by default (false).\ \ You can enforce required Custom Fields by including check_required_custom_fields: true. |
custom_fields | any[] | No | — | You can include one or more Custom Fields to set them when creating a new task.\ \ Custom Fields that use object and array type values are nullable by sending "value": null. |
custom_item_id | number | No | — | The custom task type ID for this task. A value of null (default) creates a standard task type “Task”.\ \ To get a list of available custom task type IDs for your Workspace, use the Get Custom Task Types endpoint. |
description | string | No | — | The description value |
due_date | integer | No | — | Due Date |
due_date_time | boolean | No | — | Due Date Time |
group_assignees | string[] | No | — | Assign multiple user groups to the task. |
links_to | string | No | — | Include a task ID to create a linked dependency with your new task. |
markdown_content | string | No | — | Markdown formatted description for the task. If both markdown_content and description are provided, markdown_content will be used instead of description. |
name | string | Yes | — | The name value |
notify_all | boolean | No | — | If notify_all is true, the creator of the task will also be notified. Other assignees and watchers are always notified regardless of this setting. |
parent | string | No | — | You can create a subtask by including an existing task ID.\ \ The parent task ID you include can be a subtask, but must be in the same List specified in the path parameter. |
points | number | No | — | Add Sprint Points to the task. |
priority | integer | No | — | The priority value |
start_date | integer | No | — | Start date for filtering |
start_date_time | boolean | No | — | Start Date Time |
status | string | No | — | The status value |
tags | string[] | No | — | The tags value |
time_estimate | integer | No | — | Time Estimate |
clickup_tasks_create_task_attachment
Create Task Attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
custom_task_ids | boolean | No | — | If you want to reference a task by its custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
body | object | Yes | — | The body value |
clickup_tasks_create_task_from_template
Create Task From Template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | number | Yes | — | List Id |
template_id | string | Yes | — | Template Id |
name | string | Yes | — | The name value |
clickup_tasks_delete_checklist
Delete Checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
checklist_id | string | Yes | — | b8a8-48d8-a0c6-b4200788a683 (uuid) |
clickup_tasks_delete_checklist_item
Delete Checklist Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
checklist_id | string | Yes | — | b8a8-48d8-a0c6-b4200788a683 (uuid) |
checklist_item_id | string | Yes | — | e491-47f5-9fd8-d1dc4cedcc6f (uuid) |
clickup_tasks_delete_dependency
Delete Dependency Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
depends_on | string | No | — | Depends On |
dependency_of | string | No | — | Dependency Of |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
clickup_tasks_delete_space_tag
Delete Space Tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
space_id | number | Yes | — | Space Id |
tag_name | string | Yes | — | Tag Name |
clickup_tasks_delete_task
Delete Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
custom_task_ids | boolean | No | — | If you want to reference a task by its custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
clickup_tasks_delete_task_link
Delete Task Link Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
links_to | string | Yes | — | Links To |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
clickup_tasks_edit_checklist
Edit Checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
checklist_id | string | Yes | — | b8a8-48d8-a0c6-b4200788a683 (uuid) |
name | string | No | — | The name value |
position | integer | No | — | Position refers to the order of appearance of checklists on a task.\ \ To set a checklist to appear at the top of the checklists section of a task, use "position": 0. |
clickup_tasks_edit_checklist_item
Edit Checklist Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
checklist_id | string | Yes | — | b8a8-48d8-a0c6-b4200788a683 (uuid) |
checklist_item_id | string | Yes | — | e491-47f5-9fd8-d1dc4cedcc6f (uuid) |
assignee | string | No | — | The assignee value |
name | string | No | — | The name value |
parent | string | No | — | To nest a checklist item under another checklist item, include the other item’s checklist_item_id. |
resolved | boolean | No | — | The resolved value |
clickup_tasks_edit_space_tag
Edit Space Tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
space_id | number | Yes | — | Space Id |
tag_name | string | Yes | — | Tag Name |
tag | object | Yes | — | The tag value |
clickup_tasks_get_accessible_custom_fields
Get List Custom Fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | number | Yes | — | List Id |
clickup_tasks_get_bulk_tasks_timein_status
Get Bulk Tasks’ Time in Status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_ids | string[] | Yes | — | Include this paramater once per task_id. You can include up to 100 task ids per request. For example: task_ids=3cuh&task_ids=g4fs |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
clickup_tasks_get_custom_items
Get Custom Task Types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
clickup_tasks_get_filtered_team_tasks
Get Filtered Team Tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_Id | number | Yes | — | Workspace ID |
page | integer | No | — | Page to fetch (starts at 0). |
order_by | string | No | — | Order by a particular field. By default, tasks are ordered by created.\ \ Options include: id, created, updated, and due_date. |
reverse | boolean | No | — | Tasks are displayed in reverse order. |
subtasks | boolean | No | — | Include or exclude subtasks. By default, subtasks are excluded. |
space_ids[] | string[] | No | — | Filter by Spaces. For example: \ \ ?space_ids[]=1234&space_ids[]=6789 |
project_ids[] | string[] | No | — | Filter by Folders. For example: \ \ ?project_ids[]=1234&project_ids[]=6789 |
list_ids[] | string[] | No | — | Filter by Lists. For example: \ \ ?list_ids[]=1234&list_ids[]=6789 |
statuses[] | string[] | No | — | Filter by statuses. Use %20 to represent a space character. To include closed tasks, use the include_closed parameter. \ \ For example: \ \ ?statuses[]=to%20do&statuses[]=in%20progress |
include_closed | boolean | No | — | Include or excluse closed tasks. By default, they are excluded.\ \ To include closed tasks, use include_closed: true. |
assignees[] | string[] | No | — | Filter by Assignees using people’s ClickUp user id. For example: \ \ ?assignees[]=1234&assignees[]=5678 |
tags[] | string[] | No | — | Filter by tags. User %20 to represent a space character. For example: \ \ ?tags[]=tag1&tags[]=this%20tag |
due_date_gt | integer | No | — | Filter by due date greater than Unix time in milliseconds. |
due_date_lt | integer | No | — | Filter by due date less than Unix time in milliseconds. |
date_created_gt | integer | No | — | Filter by date created greater than Unix time in milliseconds. |
date_created_lt | integer | No | — | Filter by date created less than Unix time in milliseconds. |
date_updated_gt | integer | No | — | Filter by date updated greater than Unix time in milliseconds. |
date_updated_lt | integer | No | — | Filter by date updated less than Unix time in milliseconds. |
date_done_gt | integer | No | — | Filter by date done greater than Unix time in milliseconds. |
date_done_lt | integer | No | — | Filter by date done less than Unix time in milliseconds. |
custom_fields | string | No | — | Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\ \ For example: ?custom_fields=[{"field_id":"abcdefghi12345678","operator":"=","value":"1234"}{"field_id":"jklmnop123456","operator":"<","value":"5"}]\ \ Only set Custom Field values display in the value property of the custom_fields parameter. The = operator isn’t supported with Label Custom Fields.\ \ Learn more about filtering using Custom Fields. |
parent | string | No | — | Include the parent task ID to return subtasks. |
include_markdown_description | boolean | No | — | To return task descriptions in Markdown format, use ?include_markdown_description=true. |
custom_items[] | number[] | No | — | Filter by custom task types. For example: \ \ ?custom_items[]=0&custom_items[]=1300 \ \ Including 0 returns tasks. Including 1 returns Milestones. Including any other number returns the custom task type as defined in your Workspace. |
clickup_tasks_get_folder_available_fields
Get Folder Custom Fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
folder_id | number | Yes | — | Folder Id |
clickup_tasks_get_space_available_fields
Get Space Custom Fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
space_id | number | Yes | — | Space Id |
clickup_tasks_get_space_tags
Get Space Tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
space_id | number | Yes | — | Space Id |
clickup_tasks_get_task
Get Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
custom_task_ids | boolean | No | — | If you want to reference a task by its custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
include_subtasks | boolean | No | — | Include subtasks, default false |
include_markdown_description | boolean | No | — | To return task descriptions in Markdown format, use ?include_markdown_description=true. |
custom_fields | string | No | — | Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\ \ For example: ?custom_fields=[{"field_id":"abcdefghi12345678","operator":"=","value":"1234"},{"field_id":"jklmnop123456","operator":"<","value":"5"}]\ \ Only 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.\ \ Learn more about filtering using Custom Fields. |
clickup_tasks_get_task_s_timein_status
Get Task’s Time in Status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
clickup_tasks_get_tasks
Get Tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
list_id | number | Yes | — | 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. |
archived | boolean | No | — | The archived value |
include_markdown_description | boolean | No | — | To return task descriptions in Markdown format, use ?include_markdown_description=true. |
page | integer | No | — | Page to fetch (starts at 0). |
order_by | string | No | — | Order by a particular field. By default, tasks are ordered by created.\ \ Options include: id, created, updated, and due_date. |
reverse | boolean | No | — | Tasks are displayed in reverse order. |
subtasks | boolean | No | — | Include or exclude subtasks. By default, subtasks are excluded. |
statuses[] | string[] | No | — | Filter by statuses. To include closed tasks, use the include_closed parameter. \ \ For example: \ \ ?statuses[]=to%20do&statuses[]=in%20progress |
include_closed | boolean | No | — | Include or excluse closed tasks. By default, they are excluded.\ \ To include closed tasks, use include_closed: true. |
include_timl | boolean | No | — | Include Tasks in Multiple Lists. By default, tasks that exist in multiple lists are excluded from the response.\ \ To include tasks that exist in multiple lists, use include_timl: true. |
assignees[] | string[] | No | — | Filter by Assignees. For example: \ \ ?assignees[]=1234&assignees[]=5678 |
watchers[] | string[] | No | — | Filter by watchers. |
tags[] | string[] | No | — | Filter by tags. For example: \ \ ?tags[]=tag1&tags[]=this%20tag |
due_date_gt | integer | No | — | Filter by due date greater than Unix time in milliseconds. |
due_date_lt | integer | No | — | Filter by due date less than Unix time in milliseconds. |
date_created_gt | integer | No | — | Filter by date created greater than Unix time in milliseconds. |
date_created_lt | integer | No | — | Filter by date created less than Unix time in milliseconds. |
date_updated_gt | integer | No | — | Filter by date updated greater than Unix time in milliseconds. |
date_updated_lt | integer | No | — | Filter by date updated less than Unix time in milliseconds. |
date_done_gt | integer | No | — | Filter by date done greater than Unix time in milliseconds. |
date_done_lt | integer | No | — | Filter by date done less than Unix time in milliseconds. |
custom_fields | string | No | — | Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\ \ For example: ?custom_fields=[{"field_id":"abcdefghi12345678","operator":"=","value":"1234"},{"field_id":"jklmnop123456","operator":"<","value":"5"}]\ \ Only 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.\ \ Learn more about filtering using Custom Fields. |
custom_field | string[] | No | — | Include tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship. |
custom_items[] | number[] | No | — | Filter by custom task types. For example: \ \ ?custom_items[]=0&custom_items[]=1300 \ \ Including 0 returns tasks. Including 1 returns Milestones. Including any other number returns the custom task type as defined in your Workspace. |
clickup_tasks_get_team_available_fields
Get Workspace Custom Fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | number | Yes | — | Workspace ID |
clickup_tasks_merge_tasks
Merge Tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | ID of the target task that other tasks will be merged into. |
source_task_ids | string[] | Yes | — | Array of task IDs to merge into the target task. |
clickup_tasks_remove_custom_field_value
Remove Custom Field Value Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
field_id | string | Yes | — | b8a8-48d8-a0c6-b4200788a683 (uuid) |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
clickup_tasks_remove_tag_from_task
Remove Tag From Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
tag_name | string | Yes | — | Tag Name |
custom_task_ids | boolean | No | — | If you want to reference a task by it’s custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
clickup_tasks_set_custom_field_value
Set Custom Field Value Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Enter the task ID of the task you want to update. |
field_id | string | Yes | — | Enter the universal unique identifier (UUID) of the Custom Field you want to set. |
custom_task_ids | boolean | No | — | If you want to reference a task by its Custom Task ID, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
body | object | Yes | — | The body value |
clickup_tasks_update_task
Update Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | Task Id |
custom_task_ids | boolean | No | — | If you want to reference a task by its custom task id, this value must be true. |
team_id | number | No | — | When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter. \ For example: custom_task_ids=true&team_id=123. |
archived | boolean | No | — | The archived value |
assignees | object | No | — | The assignees value |
custom_item_id | number | No | — | The custom task type ID for this task. A value of null (default) sets the task type to type “Task”.\ \ To get a list of available custom task type IDs for your Workspace, use the Get Custom Task Types endpoint. |
description | string | No | — | To clear the task description, include Description with " ". |
due_date | integer | No | — | Due Date |
due_date_time | boolean | No | — | Due Date Time |
group_assignees | object | No | — | Group Assignees |
markdown_content | string | No | — | Markdown formatted description for the task. If both markdown_content and description are provided, markdown_content will be used instead of description. |
name | string | No | — | The name value |
parent | string | No | — | You can move a subtask to another parent task by including "parent" with a valid task id.\ \ You cannot convert a subtask to a task by setting "parent" to null. |
points | number | No | — | Update the task’s Sprint Points. |
priority | integer | No | — | The priority value |
start_date | integer | No | — | Start date for filtering |
start_date_time | boolean | No | — | Start Date Time |
status | string | No | — | The status value |
time_estimate | integer | No | — | Time Estimate |
watchers | object | No | — | The watchers value |

