v1
latestOpenAPI 3.1.02026-07-24172151607.6 KBGet Tasks
View the tasks in a List. Responses are limited to 100 tasks per page. You can only view task information of tasks you can access.
This endpoint only includes tasks where the specified list_id is their home List. Tasks added to the list_id with a different home List are not included in the response by default. To include tasks that exist in multiple lists, use the include_timl parameter.
The time_spent field displays time tracked in milliseconds, and is only included in the response for tasks with time entries.
Each task's custom_fields array only includes Custom Fields applicable to that task's custom_item_id.
Path parameters
To find the list_id: \ 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 list_id. The list_id is the number that follows /li in the URL.
Query parameters
To return task descriptions in Markdown format, use ?include_markdown_description=true.
Page to fetch (starts at 0).
Order by a particular field. By default, tasks are ordered by created.
Options include: id, created, updated, and due_date.
Tasks are displayed in reverse order.
Include or exclude subtasks. By default, subtasks are excluded.
Filter by statuses. To include closed tasks, use the include_closed parameter.
For example:
?statuses[]=to%20do&statuses[]=in%20progress
Include or excluse closed tasks. By default, they are excluded.
To include closed tasks, use include_closed: true.
Include Tasks in Multiple Lists. By default, tasks that exist in multiple lists are excluded from the response.
To include tasks that exist in multiple lists, use include_timl: true.
Filter by Assignees. For example:
?assignees[]=1234&assignees[]=5678
Filter by watchers.
Filter by tags. For example:
?tags[]=tag1&tags[]=this%20tag
Filter by due date greater than Unix time in milliseconds.
Filter by due date less than Unix time in milliseconds.
Filter by date created greater than Unix time in milliseconds.
Filter by date created less than Unix time in milliseconds.
Filter by date updated greater than Unix time in milliseconds.
Filter by date updated less than Unix time in milliseconds.
Filter by date done greater than Unix time in milliseconds.
Filter by date done less than Unix time in milliseconds.
Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.
For example: ?custom_fields=[{"field_id":"abcdefghi12345678","operator":"=","value":"1234"},{"field_id":"jklmnop123456","operator":"<","value":"5"}]
Only set Custom Field values display in the value property of the custom_fields parameter. If you want to include tasks with specific values in only one Custom Field, use custom_field instead.
Learn more about filtering using Custom Fields.
Include tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship.
Filter by custom task types. For example:
?custom_items[]=0&custom_items[]=1300
Including 0 returns tasks. Including 1 returns Milestones. Including any other number returns the custom task type as defined in your Workspace.
Response
Example response
{
"tasks": [
{
"id": "9hx",
"custom_id": null,
"custom_item_id": 0,
"name": "Fix login bug",
"text_content": "Users are unable to log in when SSO is enabled.",
"description": "Users are unable to log in when SSO is enabled.",
"status": {
"id": "p7001234_FxGmgrnk",
"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"archived": false,
"creator": {
"id": 183,
"username": "Alex Johnson",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"group_assignees": [],
"watchers": [],
"checklists": [
{
"id": "595495f8-4557-41b7-a527-f808664816a0",
"task_id": "9hx",
"name": "Checklist on a task",
"date_created": "1714661812846",
"orderindex": "1",
"creator": 183,
"resolved": 0,
"unresolved": 2,
"items": []
}
],
"tags": [],
"parent": null,
"top_level_parent": null,
"priority": {
"color": "#f8ae00",
"id": "3",
"orderindex": "3",
"priority": "normal"
},
"due_date": "1508369194377",
"start_date": null,
"points": 3,
"time_estimate": "8640000",
"time_spent": 7200000,
"custom_fields": [
{
"id": "d2ab17e0-41d3-4d28-bdbb-f3f0f2c62f8b",
"name": "Sprint Goal",
"type": "short_text",
"type_config": {},
"date_created": "1621915186877",
"hide_from_guests": false,
"value": "Fix critical auth issues",
"value_richtext": "",
"required": false
},
{
"id": "1f3cc395-3448-4264-bedd-590a3b3fa178",
"name": "Story Points",
"type": "number",
"type_config": {},
"date_created": "1627004071219",
"hide_from_guests": false,
"value": "8",
"value_richtext": "",
"required": false
},
{
"id": "f4d2a20d-6759-4420-b897-222dbe2587d4",
"name": "Assigned Reviewer",
"type": "users",
"type_config": {
"include_guests": false,
"include_team_members": true,
"single_user": false
},
"date_created": "1618440378816",
"hide_from_guests": false,
"value": [
{
"id": 2772463,
"username": "Alex Johnson",
"email": "user@company.com",
"color": "#FC575E",
"initials": "AJ",
"profilePicture": null
}
],
"value_richtext": "",
"required": false
},
{
"id": "b2e4be70-c4d3-4726-985b-46ac25375b28",
"name": "Marketing Requirements",
"type": "drop_down",
"type_config": {
"sorting": "manual",
"new_drop_down": true,
"options": [
{
"id": "f8249998-9c0a-4b1d-a8b7-67a072aca05a",
"name": "No Marketing Needed",
"color": "#b5bcc2",
"orderindex": 0
},
{
"id": "97704092-e5aa-4005-a87f-677b764d2e4c",
"name": "Internal Announcement",
"color": "#02BCD4",
"orderindex": 1
},
{
"id": "c3d4e5f6-a7b8-4c9d-0e1f-a2b3c4d5e6f7",
"name": "Release Notes Only",
"color": "#7b68ee",
"orderindex": 2
},
{
"id": "b32b5b93-1839-431e-b9b0-8c4f9de9a84d",
"name": "Social Media Post",
"color": "#2ecd6f",
"orderindex": 3
},
{
"id": "87b3c808-a335-4284-a671-e2f9bce66713",
"name": "Blog Post",
"color": "#f9ae27",
"orderindex": 4
},
{
"id": "a1c2d3e4-f5a6-7b8c-9d0e-f1a2b3c4d5e6",
"name": "Dedicated Campaign with Press",
"color": "#e50000",
"orderindex": 5
}
]
},
"date_created": "1762838079415",
"hide_from_guests": false,
"value": 2,
"value_richtext": "",
"required": false
}
],
"dependencies": [],
"linked_tasks": [],
"locations": [
{
"id": "123456789",
"name": "Bug Triage"
}
],
"team_id": "7002367",
"url": "https://app.clickup.com/t/9hx",
"sharing": {
"public": false,
"public_share_expires_on": null,
"public_fields": [
"assignees",
"priority",
"due_date",
"content",
"comments",
"attachments",
"customFields",
"subtasks",
"tags",
"checklists",
"coverimage"
],
"token": null,
"seo_optimized": false
},
"permission_level": "create",
"list": {
"id": "15505202",
"name": "Sprint Backlog",
"access": true
},
"project": {
"id": "6992470",
"name": "Mobile Squad",
"hidden": false,
"access": true
},
"folder": {
"id": "6992470",
"name": "Mobile Squad",
"hidden": false,
"access": true
},
"space": {
"id": "7002367"
}
},
{
"id": "9hz",
"custom_id": null,
"custom_item_id": 0,
"name": "Update onboarding docs",
"text_content": "",
"description": "",
"status": {
"id": "p7002367_HxJmgqni",
"status": "to do",
"color": "#f8ae00",
"orderindex": 0,
"type": "open"
},
"orderindex": "2.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"archived": false,
"creator": {
"id": 183,
"username": "Alex Johnson",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"group_assignees": [],
"watchers": [],
"checklists": [],
"tags": [],
"parent": null,
"top_level_parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"points": null,
"time_estimate": null,
"custom_fields": [
{
"id": "d2ab17e0-41d3-4d28-bdbb-f3f0f2c62f8b",
"name": "Sprint Goal",
"type": "short_text",
"type_config": {},
"date_created": "1621915186877",
"hide_from_guests": false,
"required": false
},
{
"id": "1f3cc395-3448-4264-bedd-590a3b3fa178",
"name": "Story Points",
"type": "number",
"type_config": {},
"date_created": "1627004071219",
"hide_from_guests": false,
"required": false
},
{
"id": "f4d2a20d-6759-4420-b897-222dbe2587d4",
"name": "Assigned Reviewer",
"type": "users",
"type_config": {
"include_guests": false,
"include_team_members": true,
"single_user": false
},
"date_created": "1618440378816",
"hide_from_guests": false,
"required": false
},
{
"id": "b2e4be70-c4d3-4726-985b-46ac25375b28",
"name": "Marketing Requirements",
"type": "drop_down",
"type_config": {
"sorting": "manual",
"new_drop_down": true,
"options": [
{
"id": "f8249998-9c0a-4b1d-a8b7-67a072aca05a",
"name": "No Marketing Needed",
"color": "#b5bcc2",
"orderindex": 0
},
{
"id": "97704092-e5aa-4005-a87f-677b764d2e4c",
"name": "Internal Announcement",
"color": "#02BCD4",
"orderindex": 1
},
{
"id": "c3d4e5f6-a7b8-4c9d-0e1f-a2b3c4d5e6f7",
"name": "Release Notes Only",
"color": "#7b68ee",
"orderindex": 2
},
{
"id": "b32b5b93-1839-431e-b9b0-8c4f9de9a84d",
"name": "Social Media Post",
"color": "#2ecd6f",
"orderindex": 3
},
{
"id": "87b3c808-a335-4284-a671-e2f9bce66713",
"name": "Blog Post",
"color": "#f9ae27",
"orderindex": 4
},
{
"id": "a1c2d3e4-f5a6-7b8c-9d0e-f1a2b3c4d5e6",
"name": "Dedicated Campaign with Press",
"color": "#e50000",
"orderindex": 5
}
]
},
"date_created": "1762838079415",
"hide_from_guests": false,
"required": false
}
],
"dependencies": [],
"linked_tasks": [],
"locations": [],
"team_id": "7002367",
"url": "https://app.clickup.com/t/9hz",
"sharing": {
"public": false,
"public_share_expires_on": null,
"public_fields": [
"assignees",
"priority",
"due_date",
"content",
"comments",
"attachments",
"customFields",
"subtasks",
"tags",
"checklists",
"coverimage"
],
"token": null,
"seo_optimized": false
},
"permission_level": "create",
"list": {
"id": "15505202",
"name": "Sprint Backlog",
"access": true
},
"project": {
"id": "6992470",
"name": "Mobile Squad",
"hidden": false,
"access": true
},
"folder": {
"id": "6992470",
"name": "Mobile Squad",
"hidden": false,
"access": true
},
"space": {
"id": "7002367"
}
}
],
"last_page": false
}