API Reference

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.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
number
required

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 Params
boolean
boolean

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

integer

Page to fetch (starts at 0).

string

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

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

boolean

Tasks are displayed in reverse order.

boolean

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

array of strings

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

For example:

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

statuses
boolean

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

To include closed tasks, use include_closed: true.

array of strings

Filter by Assignees. For example:

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

assignees
array of strings

Filter by watchers.

watchers
array of strings

Filter by tags. For example:

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

tags
integer

Filter by due date greater than Unix time in milliseconds.

integer

Filter by due date less than Unix time in milliseconds.

integer

Filter by date created greater than Unix time in milliseconds.

integer

Filter by date created less than Unix time in milliseconds.

integer

Filter by date updated greater than Unix time in milliseconds.

integer

Filter by date updated less than Unix time in milliseconds.

integer

Filter by date done greater than Unix time in milliseconds.

integer

Filter by date done less than Unix time in milliseconds.

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

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.

custom_fields
array of strings

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

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

custom_items
Response

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json