Appearance

List tasks​

GET
/api/tasks

Authorizations​

bearerAuth

API token created via POST /api/tokens or the db:create-token CLI command

Type
HTTP (bearer)

Parameters​

Query Parameters

done

Filter by completion status (default false)

Type
boolean
project_id
Type
integer
label

Filter by label name

Type
string
search

Search in title and notes

Type
string
trashed
Type
boolean
archived
Type
boolean
overdue

true = only what is due right now, by the same definition as the
app badge, notifications and the snooze-overdue sweep: reminders
and quotas are never overdue, and a recurring task's due-ness comes
from its schedule. Only the user's own tasks (the badge's
population). Applied before pagination.

Type
boolean
kind

Narrow to one population: ordinary tasks, reminders
(is_reminder), or quotas (is_tracked or progress_target > 1).
Omitted = all three. Applied before pagination; any other value is
a 400.

Type
string
Valid values
"task""reminder""quota"
recurring
Type
boolean
one_off
Type
boolean
limit
Type
integer
Default
200
offset
Type
integer
Default
0

Responses​

List of tasks

application/json
JSON
{
"data": {
"tasks": [
{
"id": 0,
"user_id": 0,
"project_id": 0,
"title": "string",
"original_title": "string",
"short_title": "string",
"done": true,
"done_at": "string",
"priority": 0,
"due_at": "string",
"rrule": "string",
"recurrence_mode": "string",
"anchor_time": "string",
"anchor_dow": 0,
"anchor_dom": 0,
"original_due_at": "string",
"target_at": "string",
"deadline_at": "string",
"horizon": "string",
"horizon_set_at": "string",
"last_considered_at": "string",
"segment_deferred_at": "string",
"segment_targeted_at": "string",
"target_set_at": "string",
"target_auto": true,
"occurrence_at": "string",
"deadline_nag_off": true,
"auto_snooze_minutes": 0,
"deleted_at": "string",
"archived_at": "string",
"labels": [
"string"
],
"notes": "string",
"progress_target": 0,
"progress_current": 0,
"progress_period_start": "string",
"quota_prompt_config": {
"enabled": true,
"slot_id": 0,
"numbers": {
"additionalProperties": 0
}
},
"quota_day_state": {
"date": "2026-09-24",
"logged": 0,
"did": [
"string"
],
"considered": [
"string"
],
"did_applied": {
"additionalProperties": 0
}
},
"completion_count": 0,
"skip_count": 0,
"first_completed_at": "string",
"last_completed_at": "string",
"created_at": "string",
"updated_at": "string",
"is_recurring": true
}
],
"count": 0
}
}

Samples​

Powered by VitePress OpenAPI