grr
api reference · v1

Every Tasks method, from the index.

All 14 methods of the Tasks API, rendered at build time from the committed Discovery index the grr binary embeds — the same data grr api describe reads at runtime. Flags are kebab-cased parameter names: userId is --user-id.

14 methods · v1 · revision 20260922

tasks.tasklists

6 methods

tasks.tasklists.delete

DELETE

grr tasks tasklists delete tasks/v1/users/@me/lists/{tasklist}

Deletes the authenticated user's specified task list. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted.

Parameter Type Required Repeated Location Description Enum values
tasklist string yes — path Task list identifier. —

https://www.googleapis.com/auth/tasks least privilege

1 scope
  • https://www.googleapis.com/auth/tasks

grr tasks tasklists delete 
grr tasks tasklists delete --tasklist @default

tasks.tasklists.get

GET

grr tasks tasklists get tasks/v1/users/@me/lists/{tasklist}

Returns the authenticated user's specified task list.

Parameter Type Required Repeated Location Description Enum values
tasklist string yes — path Task list identifier. —

https://www.googleapis.com/auth/tasks.readonly least privilege

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

grr tasks tasklists get 
grr tasks tasklists get --tasklist @default

tasks.tasklists.insert

POST

grr tasks tasklists insert tasks/v1/users/@me/lists

Creates a new task list and adds it to the authenticated user's task lists. A user can have up to 2000 lists at a time.

No parameters.

https://www.googleapis.com/auth/tasks least privilege

1 scope
  • https://www.googleapis.com/auth/tasks

grr tasks tasklists insert 
grr tasks tasklists insert --body-file ./body.json

tasks.tasklists.list

GET

grr tasks tasklists list tasks/v1/users/@me/lists

Returns all the authenticated user's task lists. A user can have up to 2000 lists at a time.

Parameter Type Required Repeated Location Description Enum values
maxResults integer — — query Maximum number of task lists returned on one page. Optional. The default is 1000 (max allowed: 1000). —
pageToken string — — query Token specifying the result page to return. Optional. —

https://www.googleapis.com/auth/tasks.readonly least privilege

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

grr tasks tasklists list 
grr tasks tasklists list

tasks.tasklists.patch

PATCH

grr tasks tasklists patch tasks/v1/users/@me/lists/{tasklist}

Updates the authenticated user's specified task list. This method supports patch semantics.

Parameter Type Required Repeated Location Description Enum values
tasklist string yes — path Task list identifier. —

https://www.googleapis.com/auth/tasks least privilege

1 scope
  • https://www.googleapis.com/auth/tasks

grr tasks tasklists patch 
grr tasks tasklists patch --tasklist @default --body-file ./body.json

tasks.tasklists.update

PUT

grr tasks tasklists update tasks/v1/users/@me/lists/{tasklist}

Updates the authenticated user's specified task list.

Parameter Type Required Repeated Location Description Enum values
tasklist string yes — path Task list identifier. —

https://www.googleapis.com/auth/tasks least privilege

1 scope
  • https://www.googleapis.com/auth/tasks

grr tasks tasklists update 
grr tasks tasklists update --tasklist @default --body-file ./body.json

tasks.tasks

8 methods

tasks.tasks.clear

POST

grr tasks tasks clear tasks/v1/lists/{tasklist}/clear

Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.

Parameter Type Required Repeated Location Description Enum values
tasklist string yes — path Task list identifier. —

https://www.googleapis.com/auth/tasks least privilege

1 scope
  • https://www.googleapis.com/auth/tasks

grr tasks tasks clear 
grr tasks tasks clear --tasklist @default --body-file ./body.json

tasks.tasks.delete

DELETE

grr tasks tasks delete tasks/v1/lists/{tasklist}/tasks/{task}

Deletes the specified task from the task list. If the task is assigned, both the assigned task and the original task (in Docs, Chat Spaces) are deleted. To delete the assigned task only, navigate to the assignment surface and unassign the task from there.

Parameter Type Required Repeated Location Description Enum values
task string yes — path Task identifier. —
tasklist string yes — path Task list identifier. —

https://www.googleapis.com/auth/tasks least privilege

1 scope
  • https://www.googleapis.com/auth/tasks

grr tasks tasks delete 
grr tasks tasks delete --task <task> --tasklist @default

tasks.tasks.get

GET

grr tasks tasks get tasks/v1/lists/{tasklist}/tasks/{task}

Returns the specified task.

Parameter Type Required Repeated Location Description Enum values
task string yes — path Task identifier. —
tasklist string yes — path Task list identifier. —

https://www.googleapis.com/auth/tasks.readonly least privilege

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

grr tasks tasks get 
grr tasks tasks get --task <task> --tasklist @default

tasks.tasks.insert

POST

grr tasks tasks insert tasks/v1/lists/{tasklist}/tasks

Creates a new task on the specified task list. Tasks assigned from Docs or Chat Spaces cannot be inserted from Tasks Public API; they can only be created by assigning them from Docs or Chat Spaces. A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.

Parameter Type Required Repeated Location Description Enum values
parent string — — query Parent task identifier. If the task is created at the top level, this parameter is omitted. An assigned task cannot be a parent task, nor can it have a parent. —
previous string — — query Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional. —
tasklist string yes — path Task list identifier. —

https://www.googleapis.com/auth/tasks least privilege

1 scope
  • https://www.googleapis.com/auth/tasks

grr tasks tasks insert 
grr tasks tasks insert --tasklist @default --body-file ./body.json

tasks.tasks.list

GET

grr tasks tasks list tasks/v1/lists/{tasklist}/tasks

Returns all tasks in the specified task list. Doesn't return assigned tasks by default (from Docs, Chat Spaces). A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.

Parameter Type Required Repeated Location Description Enum values
completedMax string — — query 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 — — query 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 — — query 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 — — query 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 — — query Maximum number of tasks returned on one page. Optional. The default is 20 (max allowed: 100). —
pageToken string — — query Token specifying the result page to return. Optional. —
showAssigned boolean — — query Optional. Flag indicating whether tasks assigned to the current user are returned in the result. Optional. The default is False. —
showCompleted boolean — — query Flag indicating whether completed tasks are returned in the result. Note that showHidden must also be True to show tasks completed in first party clients, such —
showDeleted boolean — — query Flag indicating whether deleted tasks are returned in the result. Optional. The default is False. —
showHidden boolean — — query Flag indicating whether hidden tasks are returned in the result. Optional. The default is False. —
tasklist string yes — path Task list identifier. —
updatedMin string — — query 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. —

https://www.googleapis.com/auth/tasks.readonly least privilege

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

grr tasks tasks list 
grr tasks tasks list --tasklist @default

tasks.tasks.move

POST

grr tasks tasks move tasks/v1/lists/{tasklist}/tasks/{task}/move

Moves the specified task to another position in the destination task list. If the destination list is not specified, the task is moved within its current list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks. A user can ha

Parameter Type Required Repeated Location Description Enum values
destinationTasklist string — — query Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its curr —
parent string — — query Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and c —
previous string — — query Optional. New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. The task set as previo —
task string yes — path Task identifier. —
tasklist string yes — path Task list identifier. —

https://www.googleapis.com/auth/tasks least privilege

1 scope
  • https://www.googleapis.com/auth/tasks

grr tasks tasks move 
grr tasks tasks move --task <task> --tasklist @default --body-file ./body.json

tasks.tasks.patch

PATCH

grr tasks tasks patch tasks/v1/lists/{tasklist}/tasks/{task}

Updates the specified task. This method supports patch semantics.

Parameter Type Required Repeated Location Description Enum values
task string yes — path Task identifier. —
tasklist string yes — path Task list identifier. —

https://www.googleapis.com/auth/tasks least privilege

1 scope
  • https://www.googleapis.com/auth/tasks

grr tasks tasks patch 
grr tasks tasks patch --task <task> --tasklist @default --body-file ./body.json

tasks.tasks.update

PUT

grr tasks tasks update tasks/v1/lists/{tasklist}/tasks/{task}

Updates the specified task.

Parameter Type Required Repeated Location Description Enum values
task string yes — path Task identifier. —
tasklist string yes — path Task list identifier. —

https://www.googleapis.com/auth/tasks least privilege

1 scope
  • https://www.googleapis.com/auth/tasks

grr tasks tasks update 
grr tasks tasks update --task <task> --tasklist @default --body-file ./body.json