Skip to content

Start a review session​

GET
/api/review

Numbers the user's overdue tasks and tasks due within the next 24
hours (overdue first, then by due date) so a client can act on them by
number with POST /api/review/execute. Sessions are held in server
memory: one is discarded once executed, sessions older than an hour
are purged when a new one starts, and all are lost on a server restart.

Authorizations​

bearerAuth

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

Type
HTTP (bearer)

Responses​

The review session

application/json
JSON
{
"data": {
"session_id": "string",
"groups": [
{
"label": "string",
"tasks": [
{
"seq": 0,
"id": 0,
"title": "string",
"due_at": "string",
"priority": 0,
"rrule": "string",
"labels": [
"string"
]
}
]
}
],
"total_tasks": 0
}
}

Samples​

Powered by VitePress OpenAPI