Skip to main content
Server path: /clickup-tasks | Type: Application | PCID required: Yes

Tools

ToolDescription
clickup_tasks_add_dependencyAdd Dependency
clickup_tasks_add_tag_to_taskAdd Tag To Task
clickup_tasks_add_task_linkAdd Task Link
clickup_tasks_create_checklistCreate Checklist
clickup_tasks_create_checklist_itemCreate Checklist Item
clickup_tasks_create_space_tagCreate Space Tag
clickup_tasks_create_taskCreate Task
clickup_tasks_create_task_attachmentCreate Task Attachment
clickup_tasks_create_task_from_templateCreate Task From Template
clickup_tasks_delete_checklistDelete Checklist
clickup_tasks_delete_checklist_itemDelete Checklist Item
clickup_tasks_delete_dependencyDelete Dependency
clickup_tasks_delete_space_tagDelete Space Tag
clickup_tasks_delete_taskDelete Task
clickup_tasks_delete_task_linkDelete Task Link
clickup_tasks_edit_checklistEdit Checklist
clickup_tasks_edit_checklist_itemEdit Checklist Item
clickup_tasks_edit_space_tagEdit Space Tag
clickup_tasks_get_accessible_custom_fieldsGet List Custom Fields
clickup_tasks_get_bulk_tasks_timein_statusGet Bulk Tasks’ Time in Status
clickup_tasks_get_custom_itemsGet Custom Task Types
clickup_tasks_get_filtered_team_tasksGet Filtered Team Tasks
clickup_tasks_get_folder_available_fieldsGet Folder Custom Fields
clickup_tasks_get_space_available_fieldsGet Space Custom Fields
clickup_tasks_get_space_tagsGet Space Tags
clickup_tasks_get_taskGet Task
clickup_tasks_get_task_s_timein_statusGet Task’s Time in Status
clickup_tasks_get_tasksGet Tasks
clickup_tasks_get_team_available_fieldsGet Workspace Custom Fields
clickup_tasks_merge_tasksMerge Tasks
clickup_tasks_remove_custom_field_valueRemove Custom Field Value
clickup_tasks_remove_tag_from_taskRemove Tag From Task
clickup_tasks_set_custom_field_valueSet Custom Field Value
clickup_tasks_update_taskUpdate Task

clickup_tasks_add_dependency

Add Dependency Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesThis is the task which is waiting on or blocking another task.
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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_ofstringNoDependency Of
depends_onstringNoDepends On

clickup_tasks_add_tag_to_task

Add Tag To Task Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
tag_namestringYesTag Name
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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.

Add Task Link Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesThe task to initiate the link from.
links_tostringYesThe task to link to.
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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.
namestringYesThe name value

clickup_tasks_create_checklist_item

Create Checklist Item Parameters:
ParameterTypeRequiredDefaultDescription
checklist_idstringYesb8a8-48d8-a0c6-b4200788a683 (uuid)
assigneeintegerNoThe assignee value
namestringNoThe name value

clickup_tasks_create_space_tag

Create Space Tag Parameters:
ParameterTypeRequiredDefaultDescription
space_idnumberYesSpace Id
tagobjectYesThe tag value

clickup_tasks_create_task

Create Task Parameters:
ParameterTypeRequiredDefaultDescription
list_idnumberYesList Id
archivedbooleanNoThe archived value
assigneesinteger[]NoThe assignees value
check_required_custom_fieldsbooleanNoWhen 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_fieldsany[]NoYou 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_idnumberNoThe 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.
descriptionstringNoThe description value
due_dateintegerNoDue Date
due_date_timebooleanNoDue Date Time
group_assigneesstring[]NoAssign multiple user groups to the task.
links_tostringNoInclude a task ID to create a linked dependency with your new task.
markdown_contentstringNoMarkdown formatted description for the task. If both markdown_content and description are provided, markdown_content will be used instead of description.
namestringYesThe name value
notify_allbooleanNoIf notify_all is true, the creator of the task will also be notified. Other assignees and watchers are always notified regardless of this setting.
parentstringNoYou 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.
pointsnumberNoAdd Sprint Points to the task.
priorityintegerNoThe priority value
start_dateintegerNoStart date for filtering
start_date_timebooleanNoStart Date Time
statusstringNoThe status value
tagsstring[]NoThe tags value
time_estimateintegerNoTime Estimate

clickup_tasks_create_task_attachment

Create Task Attachment Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
custom_task_idsbooleanNoIf you want to reference a task by its custom task id, this value must be true.
team_idnumberNoWhen 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.
bodyobjectYesThe body value

clickup_tasks_create_task_from_template

Create Task From Template Parameters:
ParameterTypeRequiredDefaultDescription
list_idnumberYesList Id
template_idstringYesTemplate Id
namestringYesThe name value

clickup_tasks_delete_checklist

Delete Checklist Parameters:
ParameterTypeRequiredDefaultDescription
checklist_idstringYesb8a8-48d8-a0c6-b4200788a683 (uuid)

clickup_tasks_delete_checklist_item

Delete Checklist Item Parameters:
ParameterTypeRequiredDefaultDescription
checklist_idstringYesb8a8-48d8-a0c6-b4200788a683 (uuid)
checklist_item_idstringYese491-47f5-9fd8-d1dc4cedcc6f (uuid)

clickup_tasks_delete_dependency

Delete Dependency Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
depends_onstringNoDepends On
dependency_ofstringNoDependency Of
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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:
ParameterTypeRequiredDefaultDescription
space_idnumberYesSpace Id
tag_namestringYesTag Name

clickup_tasks_delete_task

Delete Task Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
custom_task_idsbooleanNoIf you want to reference a task by its custom task id, this value must be true.
team_idnumberNoWhen 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.

Delete Task Link Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
links_tostringYesLinks To
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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:
ParameterTypeRequiredDefaultDescription
checklist_idstringYesb8a8-48d8-a0c6-b4200788a683 (uuid)
namestringNoThe name value
positionintegerNoPosition 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:
ParameterTypeRequiredDefaultDescription
checklist_idstringYesb8a8-48d8-a0c6-b4200788a683 (uuid)
checklist_item_idstringYese491-47f5-9fd8-d1dc4cedcc6f (uuid)
assigneestringNoThe assignee value
namestringNoThe name value
parentstringNoTo nest a checklist item under another checklist item, include the other item’s checklist_item_id.
resolvedbooleanNoThe resolved value

clickup_tasks_edit_space_tag

Edit Space Tag Parameters:
ParameterTypeRequiredDefaultDescription
space_idnumberYesSpace Id
tag_namestringYesTag Name
tagobjectYesThe tag value

clickup_tasks_get_accessible_custom_fields

Get List Custom Fields Parameters:
ParameterTypeRequiredDefaultDescription
list_idnumberYesList Id

clickup_tasks_get_bulk_tasks_timein_status

Get Bulk Tasks’ Time in Status Parameters:
ParameterTypeRequiredDefaultDescription
task_idsstring[]YesInclude 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_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID

clickup_tasks_get_filtered_team_tasks

Get Filtered Team Tasks Parameters:
ParameterTypeRequiredDefaultDescription
team_IdnumberYesWorkspace ID
pageintegerNoPage to fetch (starts at 0).
order_bystringNoOrder by a particular field. By default, tasks are ordered by created.\ \ Options include: id, created, updated, and due_date.
reversebooleanNoTasks are displayed in reverse order.
subtasksbooleanNoInclude or exclude subtasks. By default, subtasks are excluded.
space_ids[]string[]NoFilter by Spaces. For example: \ \ ?space_ids[]=1234&space_ids[]=6789
project_ids[]string[]NoFilter by Folders. For example: \ \ ?project_ids[]=1234&project_ids[]=6789
list_ids[]string[]NoFilter by Lists. For example: \ \ ?list_ids[]=1234&list_ids[]=6789
statuses[]string[]NoFilter 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_closedbooleanNoInclude or excluse closed tasks. By default, they are excluded.\ \ To include closed tasks, use include_closed: true.
assignees[]string[]NoFilter by Assignees using people’s ClickUp user id. For example: \ \ ?assignees[]=1234&assignees[]=5678
tags[]string[]NoFilter by tags. User %20 to represent a space character. For example: \ \ ?tags[]=tag1&tags[]=this%20tag
due_date_gtintegerNoFilter by due date greater than Unix time in milliseconds.
due_date_ltintegerNoFilter by due date less than Unix time in milliseconds.
date_created_gtintegerNoFilter by date created greater than Unix time in milliseconds.
date_created_ltintegerNoFilter by date created less than Unix time in milliseconds.
date_updated_gtintegerNoFilter by date updated greater than Unix time in milliseconds.
date_updated_ltintegerNoFilter by date updated less than Unix time in milliseconds.
date_done_gtintegerNoFilter by date done greater than Unix time in milliseconds.
date_done_ltintegerNoFilter by date done less than Unix time in milliseconds.
custom_fieldsstringNoInclude 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.
parentstringNoInclude the parent task ID to return subtasks.
include_markdown_descriptionbooleanNoTo return task descriptions in Markdown format, use ?include_markdown_description=true.
custom_items[]number[]NoFilter 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:
ParameterTypeRequiredDefaultDescription
folder_idnumberYesFolder Id

clickup_tasks_get_space_available_fields

Get Space Custom Fields Parameters:
ParameterTypeRequiredDefaultDescription
space_idnumberYesSpace Id

clickup_tasks_get_space_tags

Get Space Tags Parameters:
ParameterTypeRequiredDefaultDescription
space_idnumberYesSpace Id

clickup_tasks_get_task

Get Task Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
custom_task_idsbooleanNoIf you want to reference a task by its custom task id, this value must be true.
team_idnumberNoWhen 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_subtasksbooleanNoInclude subtasks, default false
include_markdown_descriptionbooleanNoTo return task descriptions in Markdown format, use ?include_markdown_description=true.
custom_fieldsstringNoInclude 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:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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:
ParameterTypeRequiredDefaultDescription
list_idnumberYesTo 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.
archivedbooleanNoThe archived value
include_markdown_descriptionbooleanNoTo return task descriptions in Markdown format, use ?include_markdown_description=true.
pageintegerNoPage to fetch (starts at 0).
order_bystringNoOrder by a particular field. By default, tasks are ordered by created.\ \ Options include: id, created, updated, and due_date.
reversebooleanNoTasks are displayed in reverse order.
subtasksbooleanNoInclude or exclude subtasks. By default, subtasks are excluded.
statuses[]string[]NoFilter by statuses. To include closed tasks, use the include_closed parameter. \ \ For example: \ \ ?statuses[]=to%20do&statuses[]=in%20progress
include_closedbooleanNoInclude or excluse closed tasks. By default, they are excluded.\ \ To include closed tasks, use include_closed: true.
include_timlbooleanNoInclude 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[]NoFilter by Assignees. For example: \ \ ?assignees[]=1234&assignees[]=5678
watchers[]string[]NoFilter by watchers.
tags[]string[]NoFilter by tags. For example: \ \ ?tags[]=tag1&tags[]=this%20tag
due_date_gtintegerNoFilter by due date greater than Unix time in milliseconds.
due_date_ltintegerNoFilter by due date less than Unix time in milliseconds.
date_created_gtintegerNoFilter by date created greater than Unix time in milliseconds.
date_created_ltintegerNoFilter by date created less than Unix time in milliseconds.
date_updated_gtintegerNoFilter by date updated greater than Unix time in milliseconds.
date_updated_ltintegerNoFilter by date updated less than Unix time in milliseconds.
date_done_gtintegerNoFilter by date done greater than Unix time in milliseconds.
date_done_ltintegerNoFilter by date done less than Unix time in milliseconds.
custom_fieldsstringNoInclude 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_fieldstring[]NoInclude tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship.
custom_items[]number[]NoFilter 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:
ParameterTypeRequiredDefaultDescription
team_idnumberYesWorkspace ID

clickup_tasks_merge_tasks

Merge Tasks Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesID of the target task that other tasks will be merged into.
source_task_idsstring[]YesArray of task IDs to merge into the target task.

clickup_tasks_remove_custom_field_value

Remove Custom Field Value Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
field_idstringYesb8a8-48d8-a0c6-b4200788a683 (uuid)
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
tag_namestringYesTag Name
custom_task_idsbooleanNoIf you want to reference a task by it’s custom task id, this value must be true.
team_idnumberNoWhen 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:
ParameterTypeRequiredDefaultDescription
task_idstringYesEnter the task ID of the task you want to update.
field_idstringYesEnter the universal unique identifier (UUID) of the Custom Field you want to set.
custom_task_idsbooleanNoIf you want to reference a task by its Custom Task ID, this value must be true.
team_idnumberNoWhen 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.
bodyobjectYesThe body value

clickup_tasks_update_task

Update Task Parameters:
ParameterTypeRequiredDefaultDescription
task_idstringYesTask Id
custom_task_idsbooleanNoIf you want to reference a task by its custom task id, this value must be true.
team_idnumberNoWhen 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.
archivedbooleanNoThe archived value
assigneesobjectNoThe assignees value
custom_item_idnumberNoThe 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.
descriptionstringNoTo clear the task description, include Description with " ".
due_dateintegerNoDue Date
due_date_timebooleanNoDue Date Time
group_assigneesobjectNoGroup Assignees
markdown_contentstringNoMarkdown formatted description for the task. If both markdown_content and description are provided, markdown_content will be used instead of description.
namestringNoThe name value
parentstringNoYou 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.
pointsnumberNoUpdate the task’s Sprint Points.
priorityintegerNoThe priority value
start_dateintegerNoStart date for filtering
start_date_timebooleanNoStart Date Time
statusstringNoThe status value
time_estimateintegerNoTime Estimate
watchersobjectNoThe watchers value