CLclickup
Lists

Get List

Changed on

View information about a List.

get/v2/list/{list_id}

Request

  • Base URL
    https://api.clickup.com/api
  • URL
    https://api.clickup.com/api/v2/list/{list_id}
  • Auth
    API key in header Authorization

Path parameters

list_idnumber required
Example:124

The List ID. To find the List ID, right-click the List in your Sidebar, select Copy link, and paste the link in your URL. The last string in the URL is your List ID.

Response

idstring
namestring
orderindexinteger
contentstring
assigneestring nullable
task_countstring nullable
due_datestring
due_date_timeboolean
start_datestring nullable
start_date_timestring nullable
inbound_addressstring
archivedboolean
override_statusesboolean
statusesStatus[] (unresolved $ref)
permission_levelstring

Example response

{
  "id": "124",
  "name": "Updated List Name",
  "orderindex": 1,
  "content": "Updated List Content",
  "status": {
    "status": "red",
    "color": "#e50000",
    "hide_label": true
  },
  "priority": {
    "priority": "high",
    "color": "#f50000"
  },
  "assignee": null,
  "due_date": "1567780450202",
  "due_date_time": true,
  "start_date": null,
  "start_date_time": null,
  "folder": {
    "id": "456",
    "name": "Folder Name",
    "hidden": false,
    "access": true
  },
  "space": {
    "id": "789",
    "name": "Space Name",
    "access": true
  },
  "inbound_address": "add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
  "archived": false,
  "override_statuses": false,
  "statuses": [
    {
      "status": "to do",
      "orderindex": 0,
      "color": "#d3d3d3",
      "type": "open"
    },
    {
      "status": "complete",
      "orderindex": 1,
      "color": "#6bc950",
      "type": "closed"
    }
  ],
  "permission_level": "create"
}

Changes

  • a0a72ec97ddbRevision changes
    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status