Task Entity

All operations on Tasks API return the latest representation of Task entity.

Attribute	Description
id	The ID of the task (UUID)
area_id	The ID of the area of life the task belongs in (UUID)
goal_id	The ID of the goal the task belongs in (UUID)
status	Current status of the task (see possible values below)
previous_status	Previous status of the task (optional, see possible values below)
estimate	Current value for estimate (optional, in minutes)
priority	Current priority (see possible values below)
progress	Progress on the task (in percent or null)
motivation	Current value of the motivation (see possible values below)
eisenhower	Current value on Eisenhower matrix (see possible values below)
sources	Array of references to data records in external systems (see documentation for creating tasks for more information)
scheduled_on	ISO-8601 formatted date when the task is scheduled on (optional)
completed_at	ISO-8601 formatted time when the task was completed (optional)
created_at	ISO-8601 formatted time when the task was created
updated_at	ISO-8601 formatted time when the task was last updated

Example JSON representation might like this:

{
  "id": "066b5835-184f-4fd9-be60-7d735aa94708",
  "area_id": "11b37775-5a34-41bb-b109-f0e5a6084799",
  "goal_id": null,
  "status": "next",
  "previous_status": "later",
  "estimate": 10,
  "priority": 0,
  "progress": null,
  "motivation": "unknown",
  "eisenhower": 0,
  "sources": [
    {
      "source": "github",
      "source_id": "123"
    }
  ],
  "scheduled_on": null,
  "completed_at": null,
  "created_at": "2021-01-10T10:39:25Z",
  "updated_at": "2021-01-10T10:39:25Z",
}

Attributes

status

Allowed values for status attribute:

Value	Description
"later"	Represents later status (default)
"next"	Represents next status
"started"	Represents started status (now named In progress in the app)
"waiting"	Represents waiting status
"completed"	Represents done status

priority

Priority is represented as an integer value in range -2..2.

Value	Description
2	Highest priority
1	High priority
0	Normal priority (default)
-1	Low priority
-2	Lowest priority

Clearing the priority is done by setting the priority value to 0.

motivation

Allowed values for motivation attribute:

Value	Description
"must"	Must motivation
"should"	Should motivation
"want"	Want motivation
"unknown"	Unknown motivation (default)

Clearing the motivation is done by assigning the motivation value of "unknown".

eisenhower

Allowed values for eisenhower attribute:

Value	Description
1	Urgent and Important
2	Urgent, not important
3	Important, not urgent
4	Not urgent or important
0	Uncategorized

Clearing the value is done by assigning the value of 0.