Filter Syntax

To filter tasks via the api, you can use a query syntax similar to SQL.

This document is about filtering via the api. To filter in Vikunja's web ui, check out the help text below the filter query input.

Available fields #

The available fields for filtering include:

doneWhether the task is completed or not
priorityThe priority level of the task (1–5)
percentDoneThe percentage of completion for the task (0–100)
dueDateThe due date of the task
startDateThe start date of the task
endDateThe end date of the task
doneAtThe date and time when the task was completed
assigneesThe assignees of the task
labelsThe labels associated with the task
projectThe project the task belongs to. Only available for saved filters, not on a project level

You can date math to set relative dates. Click on the date value in a query to find out more.

All strings must be either single-word or enclosed in " or '. This extends to date values like 2024-03-11.

Operators #

The available operators for filtering include:

!=Not equal to
=Equal to
>Greater than
>=Greater than or equal to
<Less than
<=Less than or equal to
likeMatches a pattern (using wildcard %)
inMatches any value in a comma-separated list of values

To combine multiple conditions, you can use the following logical operators:

&&AND operatormatches if all conditions are true
||OR operatormatches if any of the conditions are true
( and )Parenthesesfor grouping conditions

Examples #

Here are some examples of filter queries:

priority = 4tasks with priority level 4
dueDate < nowtasks with a due date in the past
done = false && priority >= 3undone tasks with priority level 3 or higher
assignees in user1, user2tasks assigned to either user1 or user2
(priority = 1 || priority = 2) && <br > dueDate <= nowtasks with priority level 1 or 2 and a due date in the past