ClickUp
API actions for the ClickUp integration.
ClickUp
Manage ClickUp workspaces, spaces, and tasks with a personal token.
Add comment to task
Add a comment to an existing ClickUp task.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
task_id | string | Yes | The ID of the task to add a comment to |
comment_text | string | Yes | The text content of the comment |
Response
{
"comment_text": "This is a comment",
"id": "comment123"
}Create task
Create a new task in a ClickUp list.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_id | string | Yes | The ID of the list to create the task in |
name | string | Yes | The name of the task |
description | string | No | The description of the task |
status | string | No | The status of the task |
assignee_ids | array | No | List of user IDs to assign to the task |
due_date | number | No | Due date as Unix timestamp in milliseconds |
Response
{
"id": "abc123",
"name": "New Task",
"status": {
"status": "to do"
},
"url": "https://app.clickup.com/t/abc123"
}List folders
Retrieve all folders within a ClickUp space.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
space_id | string | Yes | The ID of the space to list folders from |
Response
[
{
"id": "456789",
"name": "Sprint 1"
}
]List lists
Retrieve all lists within a ClickUp folder.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
folder_id | string | Yes | The ID of the folder to list lists from |
Response
[
{
"id": "789012",
"name": "To Do",
"status": null
}
]List spaces
Retrieve all spaces within a ClickUp workspace.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
workspace_id | string | Yes | The ID of the workspace to list spaces from |
Response
[
{
"id": "90210",
"name": "Engineering",
"private": false
}
]List workspaces
Retrieve all accessible ClickUp workspaces (teams) for the connected account.
Response
[
{
"id": "12345678",
"name": "My Workspace"
}
]Update task status
Update the status of an existing ClickUp task.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
task_id | string | Yes | The ID of the task to update |
status | string | Yes | The new status for the task |
Response
{
"id": "abc123",
"name": "My Task",
"status": {
"status": "in progress"
}
}