Lists

Create Folderless List

Add a new List in a Space.

post/v2/space/{space_id}/list

Path parameters

space_idnumber required
Example:789

Request body

namestring required
contentstring
markdown_contentstring

Use markdown_content instead of content to format your List description.

due_dateinteger
due_date_timeboolean
priorityinteger
assigneeinteger

Include a user_id to add a List owner.

statusstring

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

Example request

{
  "name": "New List Name",
  "content": "New List Content",
  "due_date": 1567780450202,
  "due_date_time": false,
  "priority": 1,
  "assignee": 183,
  "status": "red"
}

Response

idstring
namestring
orderindexinteger
contentstring
statusStatus — unresolved $ref
priorityPriority — unresolved $ref
task_countstring nullable
due_datestring
due_date_timeboolean
start_datestring nullable
start_date_timestring nullable
folderFolder — unresolved $ref
spaceSpace — unresolved $ref
statusesStatus[] — unresolved $ref
inbound_addressstring

Example response

{
  "id": "124",
  "name": "New List Name",
  "orderindex": 1,
  "content": "New List Content",
  "status": {
    "status": "red",
    "color": "#e50000",
    "hide_label": true
  },
  "priority": {
    "priority": "urgent",
    "color": "#f50000"
  },
  "assignee": {
    "id": 183,
    "color": "#827718",
    "username": "Jerry",
    "initials": "J",
    "profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
  },
  "task_count": null,
  "due_date": "1567780450202",
  "due_date_time": false,
  "start_date": null,
  "start_date_time": null,
  "folder": {
    "id": "457",
    "name": "hidden",
    "hidden": true,
    "access": true
  },
  "space": {
    "id": "789",
    "name": "Space Name",
    "access": true
  },
  "statuses": [
    {
      "status": "to do",
      "orderindex": 0,
      "color": "#d3d3d3",
      "type": "open"
    },
    {
      "status": "complete",
      "orderindex": 1,
      "color": "#6bc950",
      "type": "closed"
    }
  ],
  "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com"
}

Changes