Skip to content
calternal docs

Get a Task by identity

GET
/api/v1/notes/tasks/by-id
curl --request GET \
  --url 'https://example.com/api/v1/notes/tasks/by-id?task_id=example' \
  --header 'Authorization: Bearer <token>'

Requires a signed-in User with the data scope. It accepts a stable Task ID or a retained alias. It returns 400 for an invalid ID or 404 when the Task is missing or not available to the User. Route: /api/v1/notes/tasks/by-id. Inputs: task_id. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
task_id
required
string

Stable Task identity, legacy Task path, or Reminders UID carried by a /t/<task-id> link.

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
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
{
  "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"
}

404

Section titled “404”

No Task has this ID