External DocumentationTo learn more, visit the ClickUp documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Assignees | A comma separated list of the assignees IDs to add to the task. |
| Custom Fields | The custom fields values to add to the task. |
| Description | The description of the task. |
| Folder ID | The ID of the folder. |
| List ID | The ID of the list. To get the list ID: * Use the action Get Lists.* Or, get it from the ClickUp platform: 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 listId. The listId is the number that follows /li in the URL. |
| Parent Task | Add an existing task ID to create a subtask. The parent task ID you include cannot be a subtask, and must be in the same List specified in the List ID parameter. |
| Priority | The priority of the task. |
| Space ID | The ID of the space. |
| Status | The status of the task. For example Open. |
| Tags | A comma separated list of the tags names to add to the task. |
| Task Links To | Include a task ID to create a linked dependency with your new task. |
| Task Name | The name of the task. |
| Team ID | The ID of the team (Workspace team type). |
Advanced Parameters
| Parameter | Description |
|---|---|
| Check Required Custom Fields | When creating a task via API any required Custom Fields are ignored by default (false). You can enforce required Custom Fields by setting this parameter to true. |
| Custom Task IDs | If you want to reference a task by its custom task id, this value must be true. |
Example Output
{
"id": "<string>",
"custom_id": null,
"custom_item_id": 2,
"name": "<string>",
"text_content": "<string>",
"description": "<string>",
"status": {
"id": "<string>",
"status": "<string>",
"color": "<string>",
"orderindex": 18,
"type": "<string>"
},
"orderindex": "<string>",
"date_created": "<string>",
"date_updated": "<string>",
"date_closed": "<string>",
"date_done": "<string>",
"archived": false,
"creator": {
"id": 64998479,
"username": "<string>",
"color": "<string>",
"email": "<string>",
"profilePicture": null
},
"assignees": [],
"group_assignees": [],
"watchers": [
{
"id": 112918707,
"username": "<string>",
"color": "<string>",
"initials": "<string>",
"email": "<string>",
"profilePicture": null
}
],
"checklists": [],
"tags": [],
"parent": null,
"top_level_parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"points": null,
"time_estimate": null,
"time_spent": 0,
"custom_fields": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"type_config": {
"options": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"orderindex": 2
},
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"orderindex": 2
}
]
},
"date_created": "<string>",
"hide_from_guests": false,
"required": false
},
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"type_config": {},
"date_created": "<string>",
"hide_from_guests": false,
"required": false
}
],
"dependencies": [],
"linked_tasks": [
{
"task_id": "<string>",
"link_id": "<string>",
"date_created": "<string>",
"userid": "<string>",
"workspace_id": "<string>"
}
],
"locations": [],
"team_id": "<string>",
"url": "<string>",
"sharing": {
"public": false,
"public_share_expires_on": null,
"public_fields": [
"<string>",
"<string>"
],
"token": null,
"seo_optimized": false
},
"permission_level": "<string>",
"list": {
"id": "<string>",
"name": "<string>",
"access": true
},
"project": {
"id": "<string>",
"name": "<string>",
"hidden": false,
"access": true
},
"folder": {
"id": "<string>",
"name": "<string>",
"hidden": false,
"access": true
},
"space": {
"id": "<string>"
}
}