Skip to main content
4 tools. Each one is also a REST route and a CLI command, from the same definition: the same input, the same output, the same errors.

list_headings

List the headings. Returns the headings of a project or an area, in display order, with the number of open and completed tasks under each. A heading carrying a deadline is a milestone: the same object, dated. Call this before any reorganisation, to see what already exists.

Input

Output

Example

create_heading

Create a heading (or a milestone). Creates a grouping of tasks under a project or under an area: never both. Provide deadline to make it a dated milestone; leave it out for a plain grouping. The heading is appended last. File tasks into it afterwards with update_tasks and its headingId field: one call for a whole batch.

Input

Output

Example

delete_heading

Delete a heading. Removes the grouping without touching the tasks: they move up to the top of their project or area. A heading groups, it does not contain: removing one must never make work disappear. Unlike tasks, projects and areas, this deletion is not reversible: the grouping is lost, only the tasks’ attachment is preserved.

Input

Output

Example

update_heading

Update a heading. Partial patch: name, deadline, description, position. deadline: null removes the due date and the heading becomes a plain grouping again. The parent does not change here: a heading moved to another project would leave its tasks attached to a grouping invisible from their own page. To move a batch, create the heading in the right parent then call update_tasks with projectId and headingId.

Input

Output

Example