Method: tasks.list

Returns all tasks in the specified task list.

HTTP request

GET https://tasks.googleapis.com/tasks/v1/lists/{tasklist}/tasks

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
tasklist

string

Task list identifier.

Query parameters

Parameters
completedMax

string

Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.

completedMin

string

Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.

dueMax

string

Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.

dueMin

string

Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.

maxResults

integer

Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100).

pageToken

string

Token specifying the result page to return. Optional.

showCompleted

boolean

Flag indicating whether completed tasks are returned in the result. Optional. The default is True. Note that showHidden must also be True to show tasks completed in first party clients, such as the web UI and Google's mobile apps.

showDeleted

boolean

Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.

showHidden

boolean

Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.

updatedMin

string

Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "resource": {
    object (Tasks)
  }
}
Fields
resource

object (Tasks)

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/tasks
  • https://www.googleapis.com/auth/tasks.readonly

Tasks

JSON representation
{
  "kind": string,
  "etag": string,
  "nextPageToken": string,
  "items": [
    {
      object (Task)
    }
  ]
}
Fields
kind

string

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

etag

string

ETag of the resource.

nextPageToken

string

Token used to access the next page of this result.

items[]

object (Task)

Collection of tasks.