Skip to content
calternal docs

List Tasks by day

GET
/api/v1/notes/tasks/day
curl --request GET \
  --url 'https://example.com/api/v1/notes/tasks/day?from=example&to=example' \
  --header 'Authorization: Bearer <token>'

Requires a signed-in User with the data scope. It returns each Task on the days covered by the requested date range. It returns 400 when the range is invalid or longer than 366 days. Route: /api/v1/notes/tasks/day. Inputs: from, to, tz. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
from
required
string
to
required
string
tz
string

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
Array<object>
object
day
required
string
role
required
string
task
required
object
attached_day
string | null
created
string | null
created_at

RFC 3339 creation instant, including the User’s offset (#655).

string | null
due
string | null
due_time

Local clock paired with due, when this Task has a timed due date.

string | null
kind
required
string
links
required

Outgoing links for the derived ## Links view.

Array<string>
priority
string | null
recurrence
string | null
revision

Strong revision returned by Task writes for guarded Undo.

string | null
scheduled
string | null
scheduled_time

Local clock paired with scheduled, when this Task has a timed date.

string | null
source
required
string
start
string | null
start_time

Local clock paired with start, when this Task has a timed date.

string | null
status
required
string
tags
required
Array<string>
task_id
required

File Tasks use calternal-id; inline tasks keep their block identity.

string
title
required
string
Examplegenerated
[
  {
    "day": "example",
    "role": "example",
    "task": {
      "attached_day": "example",
      "created": "example",
      "created_at": "example",
      "due": "example",
      "due_time": "example",
      "kind": "example",
      "links": [
        "example"
      ],
      "priority": "example",
      "recurrence": "example",
      "revision": "example",
      "scheduled": "example",
      "scheduled_time": "example",
      "source": "example",
      "start": "example",
      "start_time": "example",
      "status": "example",
      "tags": [
        "example"
      ],
      "task_id": "example",
      "title": "example"
    }
  }
]