Use Tasks Parameters
In addition to the standard query parameters that can be used with most Google APIs, there is a set of Tasks parameters.
Request parameters that apply only to specific operations in the Google Tasks API are summarized in the following table. All parameter values need to be URL encoded.
Parameter |
Meaning |
Notes |
Applicability |
completedMax |
Upper bound for a task's completion date (as an RFC 3339 timestamp) to filter by. |
- Default:
completedMax=2031-01-01
- Use the RFC 3339 timestamp format. For example:
2010-08-09T10:57:00.000-08:00
|
|
completedMin |
Lower bound for a task's completion date (as an RFC 3339 timestamp) to filter by. |
- Default:
completedMin=1970-01-01
- Use the RFC 3339 timestamp format. For example:
2010-08-09T10:57:00.000-08:00
|
|
dueMax |
Upper bound for a task's due date (as an RFC 3339 timestamp) to filter by. |
- Default:
dueMax=2031-01-01
- Use the RFC 3339 timestamp format. For example:
2010-08-09T10:57:00.000-08:00
|
|
dueMin |
Lower bound for a task's due date (as an RFC 3339 timestamp) to filter by. |
- Default:
dueMin=1970-01-01
- Use the RFC 3339 timestamp format. For example:
2010-08-09T10:57:00.000-08:00
|
|
maxResults |
The maximum number of elements to return with this request. |
- Default:
maxResults=20
- Maximum allowable value:
maxResults=100.
|
- Retrieving a user's task lists
- Retrieving tasks
|
pageToken |
Token specifying the result page to return. |
- The default is to return the first page.
|
- Retrieving a user's task lists
- Retrieving tasks
|
parent |
Specify the task's parent task ID. |
- No parameter indicates an insertion or a move to the top level of the task list.
|
- Creating a task
- Ordering a task
|
previous |
Specify the task's previous task ID. |
- No parameter indicates an insertion or a move to the first position in the sublist.
|
- Creating a task
- Ordering a task
|
showCompleted |
Specify whether or not to show completed tasks. |
- Default:
showCompleted=true
|
|
showDeleted |
Specify whether or not to show deleted tasks. |
- Default:
showDeleted=false
|
|
showHidden |
Specify whether or not to show hidden tasks. |
|
|
updatedMin |
Lower bound for a task's last modification time (as an RFC 3339 timestamp) to filter by. |
- Use the RFC 3339 timestamp format. For example:
2010-08-09T10:57:00.000-08:00Z .
- The default is not to filter by last modification time.
|
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-19 UTC.
[null,null,["Last updated 2024-12-19 UTC."],[[["In addition to standard query parameters, the Google Tasks API utilizes specific parameters for refined task management."],["These parameters control filtering by due dates, completion dates, modification times, and the visibility of completed, deleted, or hidden tasks."],["Developers can use these parameters to retrieve specific sets of tasks based on various criteria, such as completion status and due dates, using RFC 3339 timestamps for filtering."],["Parameters like `maxResults` and `pageToken` allow for pagination and control over the number of tasks returned in a response."],["The `parent` and `previous` parameters enable developers to manage task hierarchy and ordering within task lists."]]],["The Google Tasks API uses specific parameters for operations, all of which require URL encoding. These parameters filter tasks by `completedMin/Max`, `dueMin/Max`, and `updatedMin` date ranges using RFC 3339 timestamps. `maxResults` limits the number of returned items, and `pageToken` specifies the result page. `parent` and `previous` parameters determine task order, while `showCompleted`, `showDeleted`, and `showHidden` control the visibility of tasks. These parameters apply to retrieving tasks and task lists, creating, and ordering tasks.\n"]]