REST Resource: tasks

Resource: Task

JSON representation
{
  "kind": string,
  "id": string,
  "etag": string,
  "title": string,
  "updated": string,
  "selfLink": string,
  "parent": string,
  "position": string,
  "notes": string,
  "status": string,
  "due": string,
  "completed": string,
  "deleted": boolean,
  "hidden": boolean,
  "links": [
    {
      "type": string,
      "description": string,
      "link": string
    }
  ],
  "webViewLink": string
}
Fields
kind

string

Type of the resource. This is always "tasks#task".

id

string

Task identifier.

etag

string

ETag of the resource.

title

string

Title of the task. Maximum length allowed: 1024 characters.

updated

string

Last modification time of the task (as a RFC 3339 timestamp).

parent

string

Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.

position

string

String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.

notes

string

Notes describing the task. Optional. Maximum length allowed: 8192 characters.

status

string

Status of the task. This is either "needsAction" or "completed".

due

string

Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API.

completed

string

Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

deleted

boolean

Flag indicating whether the task has been deleted. The default is False.

hidden

boolean

Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

links[].type

string

Type of the link, e.g. "email".

links[].description

string

The description. In HTML speak: Everything between <a> and </a>.

links[].link

string

The URL.

Methods

clear

Clears all completed tasks from the specified task list.

delete

Deletes the specified task from the task list.

get

Returns the specified task.

insert

Creates a new task on the specified task list.

list

Returns all tasks in the specified task list.

move

Moves the specified task to another position in the task list.

patch

Updates the specified task.

update

Updates the specified task.