{ "resources": { "tasks": { "methods": { "patch": { "flatPath": "tasks/v1/lists/{tasklist}/tasks/{task}", "parameters": { "tasklist": { "type": "string", "location": "path", "required": true, "description": "Task list identifier." }, "task": { "required": true, "description": "Task identifier.", "type": "string", "location": "path" } }, "id": "tasks.tasks.patch", "request": { "$ref": "Task" }, "scopes": [ "https://www.googleapis.com/auth/tasks" ], "path": "tasks/v1/lists/{tasklist}/tasks/{task}", "description": "Updates the specified task. This method supports patch semantics.", "httpMethod": "PATCH", "response": { "$ref": "Task" }, "parameterOrder": [ "tasklist", "task" ] }, "move": { "flatPath": "tasks/v1/lists/{tasklist}/tasks/{task}/move", "id": "tasks.tasks.move", "parameters": { "parent": { "location": "query", "type": "string", "description": "New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional." }, "tasklist": { "location": "path", "type": "string", "description": "Task list identifier.", "required": true }, "task": { "type": "string", "required": true, "location": "path", "description": "Task identifier." }, "previous": { "type": "string", "location": "query", "description": "New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional." } }, "httpMethod": "POST", "response": { "$ref": "Task" }, "parameterOrder": [ "tasklist", "task" ], "scopes": [ "https://www.googleapis.com/auth/tasks" ], "description": "Moves the specified task to another position in the task 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 have up to 2,000 subtasks per task.", "path": "tasks/v1/lists/{tasklist}/tasks/{task}/move" }, "get": { "id": "tasks.tasks.get", "parameters": { "tasklist": { "description": "Task list identifier.", "required": true, "type": "string", "location": "path" }, "task": { "type": "string", "description": "Task identifier.", "required": true, "location": "path" } }, "description": "Returns the specified task.", "httpMethod": "GET", "path": "tasks/v1/lists/{tasklist}/tasks/{task}", "scopes": [ "https://www.googleapis.com/auth/tasks", "https://www.googleapis.com/auth/tasks.readonly" ], "flatPath": "tasks/v1/lists/{tasklist}/tasks/{task}", "parameterOrder": [ "tasklist", "task" ], "response": { "$ref": "Task" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/tasks", "https://www.googleapis.com/auth/tasks.readonly" ], "description": "Returns all tasks in the specified task list. A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.", "parameters": { "completedMin": { "description": "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.", "location": "query", "type": "string" }, "updatedMin": { "location": "query", "type": "string", "description": "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." }, "pageToken": { "type": "string", "location": "query", "description": "Token specifying the result page to return. Optional." }, "dueMax": { "location": "query", "description": "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.", "type": "string" }, "dueMin": { "description": "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.", "type": "string", "location": "query" }, "maxResults": { "format": "int32", "description": "Maximum number of tasks returned on one page. Optional. The default is 20 (max allowed: 100).", "type": "integer", "location": "query" }, "tasklist": { "type": "string", "required": true, "location": "path", "description": "Task list identifier." }, "completedMax": { "description": "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.", "location": "query", "type": "string" }, "showDeleted": { "location": "query", "description": "Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.", "type": "boolean" }, "showHidden": { "description": "Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.", "type": "boolean", "location": "query" }, "showCompleted": { "description": "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.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "tasklist" ], "response": { "$ref": "Tasks" }, "flatPath": "tasks/v1/lists/{tasklist}/tasks", "path": "tasks/v1/lists/{tasklist}/tasks", "httpMethod": "GET", "id": "tasks.tasks.list" }, "clear": { "id": "tasks.tasks.clear", "description": "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.", "parameterOrder": [ "tasklist" ], "flatPath": "tasks/v1/lists/{tasklist}/clear", "scopes": [ "https://www.googleapis.com/auth/tasks" ], "path": "tasks/v1/lists/{tasklist}/clear", "parameters": { "tasklist": { "required": true, "description": "Task list identifier.", "location": "path", "type": "string" } }, "httpMethod": "POST" }, "delete": { "description": "Deletes the specified task from the task list.", "path": "tasks/v1/lists/{tasklist}/tasks/{task}", "flatPath": "tasks/v1/lists/{tasklist}/tasks/{task}", "parameters": { "task": { "type": "string", "required": true, "location": "path", "description": "Task identifier." }, "tasklist": { "type": "string", "required": true, "description": "Task list identifier.", "location": "path" } }, "parameterOrder": [ "tasklist", "task" ], "scopes": [ "https://www.googleapis.com/auth/tasks" ], "httpMethod": "DELETE", "id": "tasks.tasks.delete" }, "update": { "path": "tasks/v1/lists/{tasklist}/tasks/{task}", "response": { "$ref": "Task" }, "parameterOrder": [ "tasklist", "task" ], "flatPath": "tasks/v1/lists/{tasklist}/tasks/{task}", "id": "tasks.tasks.update", "scopes": [ "https://www.googleapis.com/auth/tasks" ], "parameters": { "task": { "description": "Task identifier.", "location": "path", "required": true, "type": "string" }, "tasklist": { "location": "path", "type": "string", "description": "Task list identifier.", "required": true } }, "description": "Updates the specified task.", "httpMethod": "PUT", "request": { "$ref": "Task" } }, "insert": { "id": "tasks.tasks.insert", "flatPath": "tasks/v1/lists/{tasklist}/tasks", "scopes": [ "https://www.googleapis.com/auth/tasks" ], "parameterOrder": [ "tasklist" ], "response": { "$ref": "Task" }, "parameters": { "parent": { "description": "Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional.", "type": "string", "location": "query" }, "previous": { "description": "Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.", "location": "query", "type": "string" }, "tasklist": { "type": "string", "location": "path", "description": "Task list identifier.", "required": true } }, "path": "tasks/v1/lists/{tasklist}/tasks", "request": { "$ref": "Task" }, "httpMethod": "POST", "description": "Creates a new task on the specified task list. A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time." } } }, "tasklists": { "methods": { "delete": { "httpMethod": "DELETE", "flatPath": "tasks/v1/users/@me/lists/{tasklist}", "description": "Deletes the authenticated user's specified task list.", "parameters": { "tasklist": { "type": "string", "location": "path", "required": true, "description": "Task list identifier." } }, "id": "tasks.tasklists.delete", "parameterOrder": [ "tasklist" ], "path": "tasks/v1/users/@me/lists/{tasklist}", "scopes": [ "https://www.googleapis.com/auth/tasks" ] }, "insert": { "flatPath": "tasks/v1/users/@me/lists", "httpMethod": "POST", "description": "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.", "parameters": {}, "response": { "$ref": "TaskList" }, "id": "tasks.tasklists.insert", "request": { "$ref": "TaskList" }, "path": "tasks/v1/users/@me/lists", "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/tasks" ] }, "get": { "parameterOrder": [ "tasklist" ], "scopes": [ "https://www.googleapis.com/auth/tasks", "https://www.googleapis.com/auth/tasks.readonly" ], "httpMethod": "GET", "parameters": { "tasklist": { "type": "string", "description": "Task list identifier.", "required": true, "location": "path" } }, "path": "tasks/v1/users/@me/lists/{tasklist}", "id": "tasks.tasklists.get", "flatPath": "tasks/v1/users/@me/lists/{tasklist}", "response": { "$ref": "TaskList" }, "description": "Returns the authenticated user's specified task list." }, "patch": { "scopes": [ "https://www.googleapis.com/auth/tasks" ], "flatPath": "tasks/v1/users/@me/lists/{tasklist}", "response": { "$ref": "TaskList" }, "parameterOrder": [ "tasklist" ], "httpMethod": "PATCH", "request": { "$ref": "TaskList" }, "path": "tasks/v1/users/@me/lists/{tasklist}", "id": "tasks.tasklists.patch", "parameters": { "tasklist": { "description": "Task list identifier.", "type": "string", "required": true, "location": "path" } }, "description": "Updates the authenticated user's specified task list. This method supports patch semantics." }, "list": { "scopes": [ "https://www.googleapis.com/auth/tasks", "https://www.googleapis.com/auth/tasks.readonly" ], "id": "tasks.tasklists.list", "response": { "$ref": "TaskLists" }, "path": "tasks/v1/users/@me/lists", "parameters": { "maxResults": { "location": "query", "type": "integer", "format": "int32", "description": "Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100)." }, "pageToken": { "description": "Token specifying the result page to return. Optional.", "location": "query", "type": "string" } }, "parameterOrder": [], "description": "Returns all the authenticated user's task lists. A user can have up to 2000 lists at a time.", "flatPath": "tasks/v1/users/@me/lists", "httpMethod": "GET" }, "update": { "scopes": [ "https://www.googleapis.com/auth/tasks" ], "path": "tasks/v1/users/@me/lists/{tasklist}", "request": { "$ref": "TaskList" }, "httpMethod": "PUT", "description": "Updates the authenticated user's specified task list.", "flatPath": "tasks/v1/users/@me/lists/{tasklist}", "parameterOrder": [ "tasklist" ], "response": { "$ref": "TaskList" }, "parameters": { "tasklist": { "type": "string", "location": "path", "description": "Task list identifier.", "required": true } }, "id": "tasks.tasklists.update" } } } }, "parameters": { "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "prettyPrint": { "location": "query", "type": "boolean", "default": "true", "description": "Returns response with indentations and line breaks." }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "location": "query", "type": "string" }, "quotaUser": { "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "$.xgafv": { "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string", "location": "query" }, "callback": { "location": "query", "type": "string", "description": "JSONP" } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/tasks": { "description": "Create, edit, organize, and delete all your tasks" }, "https://www.googleapis.com/auth/tasks.readonly": { "description": "View your tasks" } } } }, "ownerDomain": "google.com", "name": "tasks", "batchPath": "batch", "mtlsRootUrl": "https://tasks.mtls.googleapis.com/", "revision": "20240526", "id": "tasks:v1", "kind": "discovery#restDescription", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "protocol": "rest", "documentationLink": "https://developers.google.com/tasks/", "basePath": "", "baseUrl": "https://tasks.googleapis.com/", "servicePath": "", "version": "v1", "canonicalName": "Tasks", "rootUrl": "https://tasks.googleapis.com/", "title": "Google Tasks API", "discoveryVersion": "v1", "schemas": { "Tasks": { "type": "object", "properties": { "items": { "description": "Collection of tasks.", "items": { "$ref": "Task" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "Token used to access the next page of this result." }, "etag": { "type": "string", "description": "ETag of the resource." }, "kind": { "description": "Type of the resource. This is always \"tasks#tasks\".", "type": "string" } }, "id": "Tasks" }, "TaskList": { "type": "object", "properties": { "title": { "description": "Title of the task list. Maximum length allowed: 1024 characters.", "type": "string" }, "id": { "type": "string", "description": "Task list identifier." }, "selfLink": { "description": "Output only. URL pointing to this task list. Used to retrieve, update, or delete this task list.", "readOnly": true, "type": "string" }, "updated": { "readOnly": true, "description": "Output only. Last modification time of the task list (as a RFC 3339 timestamp).", "type": "string" }, "kind": { "description": "Output only. Type of the resource. This is always \"tasks#taskList\".", "type": "string", "readOnly": true }, "etag": { "description": "ETag of the resource.", "type": "string" } }, "id": "TaskList" }, "TaskLists": { "id": "TaskLists", "type": "object", "properties": { "items": { "description": "Collection of task lists.", "items": { "$ref": "TaskList" }, "type": "array" }, "kind": { "type": "string", "description": "Type of the resource. This is always \"tasks#taskLists\"." }, "etag": { "type": "string", "description": "ETag of the resource." }, "nextPageToken": { "description": "Token that can be used to request the next page of this result.", "type": "string" } } }, "Task": { "id": "Task", "type": "object", "properties": { "webViewLink": { "type": "string", "readOnly": true, "description": "Output only. An absolute link to the task in the Google Tasks Web UI." }, "id": { "type": "string", "description": "Task identifier." }, "hidden": { "description": "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.", "type": "boolean" }, "completed": { "type": "string", "description": "Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed." }, "selfLink": { "description": "Output only. URL pointing to this task. Used to retrieve, update, or delete this task.", "type": "string", "readOnly": true }, "due": { "type": "string", "description": "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." }, "position": { "description": "Output only. 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). Use the \"move\" method to move the task to another position.", "type": "string", "readOnly": true }, "parent": { "readOnly": true, "type": "string", "description": "Output only. 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." }, "etag": { "description": "ETag of the resource.", "type": "string" }, "title": { "type": "string", "description": "Title of the task. Maximum length allowed: 1024 characters." }, "links": { "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the link, e.g. \"email\"." }, "description": { "type": "string", "description": "The description. In HTML speak: Everything between \u003ca\u003e and \u003c/a\u003e." }, "link": { "description": "The URL.", "type": "string" } } }, "description": "Output only. Collection of links. This collection is read-only.", "readOnly": true, "type": "array" }, "updated": { "type": "string", "description": "Output only. Last modification time of the task (as a RFC 3339 timestamp).", "readOnly": true }, "notes": { "type": "string", "description": "Notes describing the task. Optional. Maximum length allowed: 8192 characters." }, "status": { "type": "string", "description": "Status of the task. This is either \"needsAction\" or \"completed\"." }, "deleted": { "description": "Flag indicating whether the task has been deleted. The default is False.", "type": "boolean" }, "kind": { "type": "string", "description": "Output only. Type of the resource. This is always \"tasks#task\".", "readOnly": true } } } }, "fullyEncodeReservedExpansion": true, "description": "The Google Tasks API lets you manage your tasks and task lists.", "ownerName": "Google" }