tasks

Fetch a Task by id.

A task the caller can see (RLS) — a teammate's task in a project they belong to included. 404 when they cannot see it. On the master of a materialized series it also carries planned_occurrences: the next occurrences not created yet ({date, creates_on} — the nightly job creates each 30 days before its day), up to the end, at most 12 (AGF-381).

get/tasks/{id}

Request

  • Base URL: https://restivity.ai/api/v1
  • URL: https://restivity.ai/api/v1/tasks/{id}
  • Auth: OAuth 2 (authorization code, authorization URL https://restivity.ai/oauth/authorize, token URL https://restivity.ai/api/oauth/token, scopes: tasks:read)

Path parameters

idstring uuid required

Unique Task identifier.

Response

The Task.

idstring uuid required
user_idstring uuid required
project_idstring uuid nullable required
titlestring required
descriptionstring required

The stored HTML, as the task editor writes it (sanitized). To show it to a person read description_text.

description_textstring required

The description as plain text: every tag removed, one line per block, - / N. before list items, entities decoded — the same shape as a comment’s content_text. Show THIS to a person; description is the stored HTML. Read-only

status'todo' | 'in_progress' | 'completed' | 'archived' required

Lifecycle state of a task.

priority'low' | 'medium' | 'high' | 'urgent' required
orderinteger nullable required
due_datestring nullable required
is_for_todayboolean required
is_importantboolean required
is_urgentboolean required
estimated_pomodorosinteger required
completed_pomodorosinteger required
is_recurringboolean required
recurring_frequencystring nullable required
recurring_end_datestring nullable required
recurring_daysinteger[] nullable required
parent_recurrence_idstring uuid nullable required
recurrence_model'materialized' | 'reminder_only' nullable required
recurrence_start_datestring nullable required

RES-115 — the series anchor ("Starts on") of a recurring master, a civil date at UTC midnight. The deadline is only a deadline: a reminder_only master's due_date is the occurrence it is currently on (it rolls forward when the occurrence is completed or skipped), a materialized master has none (each child occurrence carries its own). NULL on non-recurring rows and on child occurrences.

completed_atstring nullable required
assigned_tostring uuid nullable required
codestring nullable required
created_atstring required
updated_atstring required
deleted_atstring nullable required
urlstring

Changes

No recorded changes to this operation across all 1 revision of this API.