Skip to main content

Tasks

The fields you will use most. The tool reference lists them all.

when is not deadline

These are two independent fields, and confusing them is the most common mistake.
  • when is the plan: when you intend to do the task. On input it is today, anytime (shown as Later in the app), someday (Future) or a date YYYY-MM-DD, with an optional time in HH:MM that only means something next to a date. On output it is an object:
  • deadline is the commitment: when it must be done. A task planned for Monday can be due Friday; a task due Friday can be planned for no particular day.
Both feed the priority score: the earlier of the two counts.

Project or area, never both

A task belongs to a project, to an area, or to neither. Send projectId and areaId together and the project wins: areaId is ignored. A project may itself belong to an area.

Calendar blocks

A task with kind: "event" is a block of time on the calendar, not a to-do. It is left out of list_tasks, of the context counters and of the priority ranking.

Repeating tasks

A repeat rule is { "every": 2, "unit": "week", "mode": "calendar", "weekdays": [1, 4] }: Repeating works as a chain. Ticking a repeating task marks it done, so it stays in your history, and creates the next occurrence at once, with the same order and a deadline moved by the same amount as its date. The next date is computed from the caller’s day (X-Doers-Today, or UTC).

Projects

name, notes, an optional areaId, an optional deadline, and a status: active, done or archived.

Areas

name, notes, an optional icon and colour hue (0 to 360), and archived.

Headings

A heading groups the tasks of a project or an area. With a deadline it acts as a milestone, and it reports how many of its tasks are open and done. Deleting a heading keeps its tasks: they move back to the top of their project or area.

Archive, then delete

Archiving a task needs the owner role; ticking or editing one needs editor.

Workspaces and sharing

Every account has a personal workspace, and can own or join team workspaces. list_tasks reads your personal workspace unless you pass workspaceId. Tasks, projects and areas can also be shared with people one by one, each with a role: reader, commenter or editor. See Sharing and Workspaces.

Mentions

Assistants cite entities as [[task:ID|Title]], [[project:ID|Name]] or [[area:ID|Name]]: the app renders them as links.