API Reference

Get Filtered Team Tasks

View the tasks that meet specific criteria from a Workspace. Responses are limited to 100 tasks per page.

You can only view task information of tasks you can access.

Our Try It modal currently supports filtering by two or more Lists, Folders, or Spaces. To filter by a single List, Folder, or Space, we recommend using a free app like Postman to test our public API.

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

Workspace ID

Query Params
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 Spaces. For example:

?space_ids[]=1234&space_ids[]=6789

space_ids
array of strings

Filter by Folders. For example:

?project_ids[]=1234&project_ids[]=6789

project_ids
array of strings

Filter by Lists. For example:

?list_ids[]=1234&list_ids[]=6789

list_ids[]
array of strings

Filter by statuses. Use %20 to represent a space character. 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 using people's ClickUp user id. For example:

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

assignees
array of strings

Filter by tags. User %20 to represent a space character. 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. The = operator isn't supported with Label Custom Fields.

Learn more about filtering using Custom Fields.

custom_fields
boolean

If you want to reference a task by its custom task id, this value must be true.

number

When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter.

For example: custom_task_ids=true&team_id=123.

string

Include the parent task ID to return subtasks.

boolean

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

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