Nothing Found

Create List

Add a new List to a Folder.

SecurityAuthorization Token
Request
path Parameters
folder_id
required
number <double>
Request Body schema: application/json
required
name
required
string
content
string
due_date
integer <int64>
due_date_time
boolean
priority
integer <int32>
assignee
integer <int32>

Include a user_id to assign this List.

status
string

Status refers to the List color rather than the task Statuses available in the List.

include_markdown_description
boolean

To return List descriptions in Markdown format, use ?include_markdown_description=true.

Responses
200
post/v2/folder/{folder_id}/list
Request samples
application/json
{
  • "name": "New List Name",
  • "content": "New List Content",
  • "due_date": 1567780450202,
  • "due_date_time": false,
  • "priority": 1,
  • "assignee": 183,
  • "status": "red"
}
Response samples
application/json
{
  • "id": "124",
  • "name": "New List Name",
  • "orderindex": 1,
  • "content": "New List Content",
  • "status": {
    },
  • "priority": {
    },
  • "assignee": {},
  • "task_count": null,
  • "due_date": "1567780450202",
  • "due_date_time": false,
  • "start_date": null,
  • "start_date_time": null,
  • "folder": {
    },
  • "space": {
    },
  • "statuses": [
    ],
  • "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com"
}
ClickUp Logo
Login