Get 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.

SecurityAuthorization Token
Request
path Parameters
list_id
required
number <double>

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
archived
boolean
include_markdown_description
boolean

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

page
integer <int32>

Page to fetch (starts at 0).

order_by
string

Order by a particular field. By default, tasks are ordered by created.

Options include: id, created, updated, and due_date.

reverse
boolean

Tasks are displayed in reverse order.

subtasks
boolean

Include or exclude subtasks. By default, subtasks are excluded.

statuses
Array of strings

Filter by statuses. To include closed tasks, use the include_closed parameter.

For example:

?statuses[]=to%20do&statuses[]=in%20progress

include_closed
boolean

Include or excluse closed tasks. By default, they are excluded.

To include closed tasks, use include_closed: true.

assignees
Array of strings

Filter by Assignees. For example:

?assignees[]=1234&assignees[]=5678

watchers
Array of strings

Filter by watchers.

tags
Array of strings

Filter by tags. For example:

?tags[]=tag1&tags[]=this%20tag

due_date_gt
integer <int32>

Filter by due date greater than Unix time in milliseconds.

due_date_lt
integer <int32>

Filter by due date less than Unix time in milliseconds.

date_created_gt
integer <int32>

Filter by date created greater than Unix time in milliseconds.

date_created_lt
integer <int32>

Filter by date created less than Unix time in milliseconds.

date_updated_gt
integer <int32>

Filter by date updated greater than Unix time in milliseconds.

date_updated_lt
integer <int32>

Filter by date updated less than Unix time in milliseconds.

date_done_gt
integer <int32>

Filter by date done greater than Unix time in milliseconds.

date_done_lt
integer <int32>

Filter by date done less than Unix time in milliseconds.

custom_fields
Array of strings

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"}]

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.

custom_field
Array of strings

Include tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship.

custom_items
Array of numbers

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.

Responses
200
get/list/{list_id}/task
Request samples
Response samples
application/json
{
  • "tasks": [
    ]
}