Search tasks by criteria

GET/api/search/task

Returns matching tasks within joined projects. result=ids returns all matching task ids; result=items returns paged display summaries. Multiple values in one field are OR-ed. Each field mode assigns the condition to a group: and (must match), or (cross-field any-match group), exclude (must not match; tasks with the field unset are kept unless "none" is listed). The literal value "none" means the field is unset.

Parameters

projectId"@all" | integerqueryRequired: A project ID, or @all for every open project you belong to.
qstringquery: Keywords to search for in the task name and description (up to 200 characters). Separate keywords with spaces (up to 5); a task must match all of them.
statusIdsstringquery: Comma-separated status IDs (up to 100). none matches tasks with no value.
statusModeand | or | excludequery: How to combine statusIds. and: tasks matching any listed value, required together with the other conditions; or: tasks matching any listed value, where a match on any or condition is enough; exclude: tasks matching none of the values. Defaults to and.
milestoneIdsstringquery: Comma-separated milestone IDs (up to 100). none matches tasks with no value.
milestoneModeand | or | excludequery: How to combine milestoneIds. and: tasks matching any listed value, required together with the other conditions; or: tasks matching any listed value, where a match on any or condition is enough; exclude: tasks matching none of the values. Defaults to and.
prioritiesstringquery: Comma-separated priorities (up to 100): 1 high, 2 medium, 3 low. none matches tasks with no priority.
priorityModeand | or | excludequery: How to combine priorities. and: tasks matching any listed value, required together with the other conditions; or: tasks matching any listed value, where a match on any or condition is enough; exclude: tasks matching none of the values. Defaults to and.
responsibleUserIdsstringquery: Comma-separated user IDs of the assignee (up to 100). none matches tasks with no value.
responsibleUserModeand | or | excludequery: How to combine responsibleUserIds. and: tasks matching any listed value, required together with the other conditions; or: tasks matching any listed value, where a match on any or condition is enough; exclude: tasks matching none of the values. Defaults to and.
ballHoldingUserIdsstringquery: Comma-separated user IDs of the ball holder (the person who has to act next) (up to 100). none matches tasks with no value.
ballHoldingUserModeand | or | excludequery: How to combine ballHoldingUserIds. and: tasks matching any listed value, required together with the other conditions; or: tasks matching any listed value, where a match on any or condition is enough; exclude: tasks matching none of the values. Defaults to and.
tagIdsstringquery: Comma-separated tag IDs (up to 100). none matches tasks with no value.
tagModeand | or | excludequery: How to combine tagIds. and: tasks matching any listed value, required together with the other conditions; or: tasks matching any listed value, where a match on any or condition is enough; exclude: tasks matching none of the values. Defaults to and.
dueDateFromintegerquery: Return only tasks due at or after this time, in Unix epoch milliseconds.
dueDateTointegerquery: Return only tasks due at or before this time, in Unix epoch milliseconds.
hasDueDate0 | 1 | true | falsequery: true returns only tasks with a due date, false only tasks without one (true, false, 1 or 0). Omit for both.
includeClosed0 | 1 | true | falsequery: Whether to include tasks in a closed status: true, false, 1 or 0. Defaults to false.
overdueOnly0 | 1 | true | falsequery: true returns only unfinished tasks whose due date has passed (closed tasks are always excluded). Defaults to false.
resultids | itemsquery: Shape of the response. ids returns matching task IDs; items returns task summaries, 30 per page. Defaults to ids.
pageintegerquery: Page number, starting at 1. Used only when result is items.

Responses

200Matching tasks ({ taskIds, truncated } or { items, hasMore })
400Invalid query
401Authentication is required